NNext.js 中文网 GitHub

如何升级到版本 9

将你的 Next.js 应用从版本 8 升级到版本 9。

要升级到版本 9,请运行以下命令:

Terminal
npm i next@9
Terminal
yarn add next@9
Terminal
pnpm up next@9
Terminal
bun add next@9

小知识: 如果你使用 TypeScript,请确保同时将 @types/react 和 @types/react-dom 升级到相应版本。

检查你的自定义 App 文件(pages/_app.js)#

如果你之前复制了自定义 <App>示例,你或许可以移除你的 getInitialProps。

从 pages/_app.js 中移除 getInitialProps(在可能的情况下)对于利用新的 Next.js 功能非常重要!

以下 getInitialProps 没有任何作用,可以移除:

js
class MyApp extends App {
  // 移除我吧,我什么都没做!
  static async getInitialProps({ Component, ctx }) {
    let pageProps = {}

    if (Component.getInitialProps) {
      pageProps = await Component.getInitialProps(ctx)
    }

    return { pageProps }
  }

  render() {
    // ... 等等
  }
}

破坏性变更#

不再需要 @zeit/next-typescript#

Next.js 现在会忽略 @zeit/next-typescript 的使用,并警告你将其移除。请从你的 next.config.js 中移除此插件。

从你自定义的 .babelrc 中移除对 @zeit/next-typescript/babel 的引用(如果存在)。

还应从你的 next.config.js 中移除 fork-ts-checker-webpack-plugin 的使用。

TypeScript 定义随 next 包一起发布,因此你需要卸载 @types/next,否则会产生冲突。

以下类型有所不同:

此列表由社区创建以帮助升级,如果你发现其他差异,请向此列表提交 pull request 以帮助其他用户。

之前:

tsx
import { NextContext } from 'next'
import { NextAppContext, DefaultAppIProps } from 'next/app'
import { NextDocumentContext, DefaultDocumentIProps } from 'next/document'

之后:

tsx
import { NextPageContext } from 'next'
import { AppContext, AppInitialProps } from 'next/app'
import { DocumentContext, DocumentInitialProps } from 'next/document'

config 键现在是页面上的一个导出#

你不能再从页面导出名为 config 的自定义变量(即 export { config } / export const config ...)。

此导出变量现在用于指定页面级的 Next.js 配置,例如选择启用 AMP 和 API Route 功能。

你必须将非 Next.js 用途的 config 导出重命名为其他名称。

next/dynamic 在加载时不再默认渲染 "loading..."#

动态组件在加载时默认不会渲染任何内容。你仍然可以通过设置 loading 属性来自定义此行为:

jsx
import dynamic from 'next/dynamic'

const DynamicComponentWithCustomLoading = dynamic(
  () => import('../components/hello2'),
  {
    loading: () => <p>Loading</p>,
  }
)

withAmp 已被移除,改用导出的配置对象#

Next.js 现在引入了页面级配置的概念,因此为保持一致性,移除了 withAmp 高阶组件。

在你的 Next.js 项目根目录运行以下命令,即可自动迁移此变更:

Terminal
curl -L https://github.com/vercel/next-codemod/archive/master.tar.gz | tar -xz --strip=2 next-codemod-master/transforms/withamp-to-config.js npx jscodeshift -t ./withamp-to-config.js pages/**/*.js

要手动执行此迁移,或查看 codemod 将生成的内容,请参见下文:

之前

jsx
import { withAmp } from 'next/amp'

function Home() {
  return <h1>My AMP Page</h1>
}

export default withAmp(Home)
// 或
export default withAmp(Home, { hybrid: true })

之后

jsx
export default function Home() {
  return <h1>My AMP Page</h1>
}

export const config = {
  amp: true,
  // 或
  amp: 'hybrid',
}

next export 不再将页面导出为 index.html#

以前,导出 pages/about.js 会生成 out/about/index.html。此行为已更改为生成 out/about.html。

你可以通过创建包含以下内容的 next.config.js 来恢复之前的行为:

next.config.js
module.exports = {
  trailingSlash: true,
}

pages/api/ 的处理方式有所不同#

pages/api/ 中的页面现在被视为 API Routes。 此目录中的页面将不再包含客户端 bundle。

已废弃的功能#

next/dynamic 已废弃一次加载多个模块#

为了更接近 React 的实现(React.lazy 和 Suspense),next/dynamic 中一次加载多个模块的能力已被废弃。

更新依赖此行为的代码相对简单!我们提供了一个前后对比示例来帮助你迁移应用:

之前

jsx
import dynamic from 'next/dynamic'

const HelloBundle = dynamic({
  modules: () => {
    const components = {
      Hello1: () => import('../components/hello1').then((m) => m.default),
      Hello2: () => import('../components/hello2').then((m) => m.default),
    }

    return components
  },
  render: (props, { Hello1, Hello2 }) => (
    <div>
      <h1>{props.title}</h1>
      <Hello1 />
      <Hello2 />
    </div>
  ),
})

function DynamicBundle() {
  return <HelloBundle title="Dynamic Bundle" />
}

export default DynamicBundle

之后

jsx
import dynamic from 'next/dynamic'

const Hello1 = dynamic(() => import('../components/hello1'))
const Hello2 = dynamic(() => import('../components/hello2'))

function HelloBundle({ title }) {
  return (
    <div>
      <h1>{title}</h1>
      <Hello1 />
      <Hello2 />
    </div>
  )
}

function DynamicBundle() {
  return <HelloBundle title="Dynamic Bundle" />
}

export default DynamicBundle
Next.js 中文网