NNext.js 中文网 GitHub

自定义 Webpack 配置

了解如何自定义 Next.js 使用的 webpack 配置

小知识:webpack 配置的变更不在 semver 覆盖范围内,因此请自行承担风险。

在继续为你的应用添加自定义 webpack 配置之前,请确保 Next.js 尚不支持你的用例:

一些常见需求的功能以插件形式提供:

为了扩展我们对 webpack 的使用,你可以在 next.config.js 中定义一个函数来扩展其配置,如下所示:

next.config.js
module.exports = {
  webpack: (
    config,
    { buildId, dev, isServer, defaultLoaders, nextRuntime, webpack }
  ) => {
    // 重要:返回修改后的配置
    return config
  },
}

webpack 函数会被执行三次,服务端两次(nodejs / edge runtime),客户端一次。这使你可以使用 isServer 属性区分客户端和服务端配置。

webpack 函数的第二个参数是一个对象,具有以下属性:

  • buildId: String - 构建 id,用作构建之间的唯一标识符。
  • dev: Boolean - 指示编译是否将在开发环境中进行。
  • isServer: Boolean - 服务端编译时为 true,客户端编译时为 false。
  • nextRuntime: String | undefined - 服务端编译的目标运行时;为 "edge" 或 "nodejs",客户端编译时为 undefined。
  • defaultLoaders: Object - Next.js 内部使用的默认 loader:
    • babel: Object - 默认的 babel-loader 配置。

defaultLoaders.babel 的用法示例:

js
// 添加依赖 babel-loader 的 loader 的示例配置
// 此源码取自 @next/mdx 插件源码:
// https://github.com/vercel/next.js/tree/canary/packages/next-mdx
module.exports = {
  webpack: (config, options) => {
    config.module.rules.push({
      test: /\.mdx/,
      use: [
        options.defaultLoaders.babel,
        {
          loader: '@mdx-js/loader',
          options: pluginOptions.options,
        },
      ],
    })

    return config
  },
}

nextRuntime#

注意,当 nextRuntime 为 "edge" 或 "nodejs" 时 isServer 为 true;nextRuntime 为 "edge" 目前仅用于 edge runtime 中的 proxy 和 Server Components。