getInitialProps
使用 getInitialProps 在服务器上为你的 React 组件获取动态数据。
小知识:
getInitialProps是一个旧版 API。我们建议改用getStaticProps或getServerSideProps。
getInitialProps 是一个 async 函数,可以添加到页面默认导出的 React 组件上。它会在服务端运行,并在页面切换期间再次在客户端运行。该函数的返回值将作为 props 传给 React 组件。
pages/index.tsx
import { NextPageContext } from 'next'
Page.getInitialProps = async (ctx: NextPageContext) => {
const res = await fetch('https://api.github.com/repos/vercel/next.js')
const json = await res.json()
return { stars: json.stargazers_count }
}
export default function Page({ stars }: { stars: number }) {
return stars
}pages/index.js
Page.getInitialProps = async (ctx) => {
const res = await fetch('https://api.github.com/repos/vercel/next.js')
const json = await res.json()
return { stars: json.stargazers_count }
}
export default function Page({ stars }) {
return stars
}小知识:
getInitialProps返回的数据在服务端渲染时会被序列化。请确保getInitialProps返回的对象是普通的Object,而不是Date、Map或Set。- 对于页面的初次加载,
getInitialProps只会在服务端运行。随后,当使用next/link组件或next/router导航到其他路由时,getInitialProps也会在客户端运行。- 如果在自定义
_app.js中使用了getInitialProps,并且要导航到的页面使用了getServerSideProps,那么getInitialProps将只在服务端运行。
context 对象#
getInitialProps 接收一个名为 context 的参数,它是一个具有以下属性的对象:
| 名称 | 描述 |
|---|---|
pathname | 当前路由,页面在 /pages 中的路径 |
query | URL 的查询字符串,解析为一个对象 |
asPath | 浏览器中显示的实际路径(包括查询字符串)的 String |
req | HTTP 请求对象(仅服务端) |
res | HTTP 响应对象(仅服务端) |
err | 渲染期间遇到任何错误时的错误对象 |
注意事项#
getInitialProps只能用于pages/下的顶层文件,不能用于嵌套组件。要在组件级别实现嵌套数据获取,可以考虑使用 App Router。- 无论你的路由是静态还是动态,
getInitialProps作为props返回的任何数据都可以在初始 HTML 的客户端侧被查看。这是为了让页面能够正确地进行水合(hydrate)。请确保不要在props中传递任何不应在客户端可见的敏感信息。