本文详细探讨了在next.js 13+ `app`目录中，如何为服务端组件（server components）进行正确的类型声明。针对`page.tsx`文件，我们应使用特定的`pageprops`接口来定义`params`和`searchparams`；对于普通的服务端组件，则主要关注其`props`的类型定义。文章强调了`nextpage`类型不适用于服务端组件，并提供了同步和异步服务端组件的类型声明示例，以帮助开发者避免常见的类型错误。
在Next.js 13及更高版本中，随着app目录的引入，组件的渲染方式和类型声明也发生了显著变化。尤其是在使用服务端组件（Server Components）时，传统的NextPage类型不再适用，这常常导致开发者遇到类型错误。本文将深入探讨在app目录结构下，如何正确地为服务端组件进行类型声明。
为什么NextPage不适用于服务端组件？
NextPage类型是Next.js pages目录时代遗留的类型定义，它主要用于声明客户端页面组件，并包含了getInitialProps等客户端特有的属性。服务端组件，尤其是Next.js 13+ app目录中的组件，其运行环境和生命周期与客户端组件截然不同，它们可以在服务器上进行数据获取，并且通常是异步的。因此，尝试将一个异步的服务端组件（例如一个返回Promise
例如，以下代码在Next.js 13+的app目录中会报错：
import { NextPage } from 'next'; // 引入NextPage类型
interface CoffeeInterface {
id: string;
name: string;
// ... 其他属性
}
// 模拟数据获取函数
async function getData(path: string): Promise<{ products: CoffeeInterface[] }> {
// 实际项目中会是API调用
return { products: [{ id: '1', name: 'Espresso' }] };
}
// 尝试使用NextPage类型声明一个异步服务端组件
const Page: NextPage = async () => {
const { products }: { products: CoffeeInterface[] } = await getData("/products");
return (
{/* ... 组件内容 */}
{products.map(coffee => (
- {coffee.name}
))}
);
};
export default Page;报错信息通常会指出Type '() => Promise
app目录中页面组件 (page.tsx) 的类型声明
在Next.js 13的app目录中，page.tsx文件默认导出的组件被视为页面组件。Next.js 会自动向这些组件注入特定的props，即params和searchParams。因此，正确的做法是为这些注入的props定义一个接口。
1. 定义页面组件的Props接口
你可以创建一个接口来明确params和searchParams的类型：
// app/page.tsx 或 app/[slug]/page.tsx
interface PageProps {
params: { [key: string]: string | string[] | undefined }; // 路由参数，如 [slug]
searchParams: { [key: string]: string | string[] | undefined }; // URL查询参数
}2. 声明同步页面组件
如果你的页面组件不需要异步获取数据，可以直接使用上述接口：
// app/page.tsx
interface PageProps {
params: { slug: string };
searchParams: { [key: string]: string | string[] | undefined };
}
export default function Page({ params, searchParams }: PageProps) {
// 示例：访问路由参数和查询参数
console.log('Params:', params.slug);
console.log('Search Params:', searchParams.query);
return (
欢迎来到我的页面
Slug: {params.slug || 'N/A'}
Query: {searchParams.query || 'N/A'}
);
}注意事项：
- 如果你的组件不需要params或searchParams，可以省略PageProps的定义，让TypeScript自动推断。
- 组件的返回值类型（通常是JSX.Element）在大多数情况下可以由TypeScript自动推断，无需显式声明。
3. 声明异步页面组件
对于需要在组件内部进行数据获取（例如使用await）的页面组件，你需要将函数声明为async。PageProps的定义方式保持不变。
// app/page.tsx
interface CoffeeInterface {
id: string;
name: string;
// ... 其他属性
}
async function getCoffeeData(): Promise<{ products: CoffeeInterface[] }> {
// 模拟异步数据获取
await new Promise(resolve => setTimeout(resolve, 1000));
return { products: [{ id: 'c1', name: 'Latte' }, { id: 'c2', name: 'Cappuccino' }] };
}
interface PageProps {
params: { slug?: string }; // 注意这里slug可能不存在
searchParams: { [key: string]: string | string[] | undefined };
}
export default async function Page({ params, searchParams }: PageProps) {
const { products } = await getCoffeeData();
return (
咖啡列表
{products.map((coffee) => (
{coffee.name}
ID: {coffee.id}
))}
{params.slug && 当前路由参数 Slug: {params.slug}
}
{searchParams.sort && 排序方式: {searchParams.sort}
}
);
}在这个例子中，Page组件被声明为async函数，它在内部等待getCoffeeData()的返回。TypeScript能够正确推断其返回类型为Promise
非页面服务端组件的类型声明
对于app目录中非page.tsx的普通服务端组件（例如，一个由page.tsx引入的子组件），它们本质上就是普通的React函数组件。你只需要关注其props的类型定义，而返回值类型通常由TypeScript自动推断。
// components/CoffeesList.tsx (这是一个服务端组件)
interface Coffee {
id: string;
name: string;
}
interface CoffeesListProps {
coffees: Coffee[];
title?: string; // 可选属性
}
export default function CoffeesList({ coffees, title = "我们的咖啡" }: CoffeesListProps) {
return (
{title}
{coffees.length === 0 ? (
暂无咖啡信息。
) : (
{coffees.map((coffee) => (
-
{coffee.name}
))}
)}
);
}在这个例子中，我们定义了CoffeesListProps接口来约束传入CoffeesList组件的props。组件本身只是一个普通的函数，无需额外的Next.js特定类型。
总结
在Next.js 13+的app目录中，为服务端组件进行类型声明的核心原则是：
- 避免使用NextPage类型：它专属于旧版pages目录的客户端页面。
-
页面组件 (page.tsx)：
- 主要关注params和searchParams这两个由Next.js注入的props。
- 通过定义一个接口（如PageProps）来明确它们的类型。
- 如果组件内部需要异步操作，将组件函数声明为async。
- 返回值类型通常由TypeScript自动推断。
-
非页面服务端组件：
- 将其视为普通的React函数组件。
- 主要关注其自身props的类型定义。
- 返回值类型同样由TypeScript自动推断。
遵循这些指导原则，你将能够更清晰、更安全地在Next.js的app目录中构建服务端组件。
