rewrites

重写允许您将传入的请求路径映射到不同的目标路径。

重写充当 URL 代理并掩盖目标路径，使其看起来用户在网站上没有更改其位置。相比之下，重定向将重定向到新页面并显示 URL 更改。

要使用重写，您可以在 next.config.js 中使用 rewrites 键

next.config.js

module.exports = {
  async rewrites() {
    return [
      {
        source: '/about',
        destination: '/',
      },
    ]
  },
}

重写应用于客户端路由，<Link href="/about"> 将在上述示例中应用重写。

rewrites 是一个异步函数，它期望返回一个数组或一个数组对象（见下文），其中包含具有 source 和 destination 属性的对象。

source：字符串 - 是传入的请求路径模式。
destination：字符串 是您要路由到的路径。
basePath：false 或 undefined - 如果为 false，则匹配时不会包含 basePath，只能用于外部重写。
locale：false 或 undefined - 是否在匹配时不应包含区域设置。
has 是一个 has 对象数组，具有 type、key 和 value 属性。
missing 是一个 missing 对象数组，具有 type、key 和 value 属性。

当 rewrites 函数返回一个数组时，在检查文件系统（页面和 /public 文件）并在动态路由之前应用重写。当 rewrites 函数返回一个具有特定形状的数组对象时，可以更改此行为并进行更细粒度的控制，从 Next.js 的 v10.1 版本开始。

next.config.js

module.exports = {
  async rewrites() {
    return {
      beforeFiles: [
        // These rewrites are checked after headers/redirects
        // and before all files including _next/public files which
        // allows overriding page files
        {
          source: '/some-page',
          destination: '/somewhere-else',
          has: [{ type: 'query', key: 'overrideMe' }],
        },
      ],
      afterFiles: [
        // These rewrites are checked after pages/public files
        // are checked but before dynamic routes
        {
          source: '/non-existent',
          destination: '/somewhere-else',
        },
      ],
      fallback: [
        // These rewrites are checked after both pages/public files
        // and dynamic routes are checked
        {
          source: '/:path*',
          destination: `https://my-old-site.com/:path*`,
        },
      ],
    }
  },
}

**需知**：beforeFiles 中的重写不会在匹配源后立即检查文件系统/动态路由，它们会一直持续到所有 beforeFiles 都被检查。

Next.js 检查路由的顺序为

检查/应用 headers
检查/应用 redirects
检查/应用 beforeFiles 重写
检查/提供来自 public 目录的静态文件、_next/static 文件和非动态页面
检查/应用 afterFiles 重写，如果匹配了其中一个重写，我们会在每次匹配后检查动态路由/静态文件
检查/应用 fallback 重写，这些重写在渲染 404 页面之前以及检查动态路由/所有静态资产之后应用。如果您在 getStaticPaths 中使用 fallback: true/'blocking'，则 next.config.js 中定义的回退 rewrites 不会运行。

重写参数

在重写中使用参数时，默认情况下，当 destination 中未使用任何参数时，这些参数将传递到查询中。

next.config.js

module.exports = {
  async rewrites() {
    return [
      {
        source: '/old-about/:path*',
        destination: '/about', // The :path parameter isn't used here so will be automatically passed in the query
      },
    ]
  },
}

如果在目标中使用了参数，则不会自动将任何参数传递到查询中。

next.config.js

module.exports = {
  async rewrites() {
    return [
      {
        source: '/docs/:path*',
        destination: '/:path*', // The :path parameter is used here so will not be automatically passed in the query
      },
    ]
  },
}

如果已经在目标中使用了参数，您仍然可以通过在 destination 中指定查询来手动将参数传递到查询中。

next.config.js

module.exports = {
  async rewrites() {
    return [
      {
        source: '/:first/:second',
        destination: '/:first?second=:second',
        // Since the :first parameter is used in the destination the :second parameter
        // will not automatically be added in the query although we can manually add it
        // as shown above
      },
    ]
  },
}

**需知**：来自自动静态优化或预渲染的重写参数将在客户端水合后进行解析，并在查询中提供。

路径匹配

允许路径匹配，例如 /blog/:slug 将匹配 /blog/hello-world（没有嵌套路径）

next.config.js

module.exports = {
  async rewrites() {
    return [
      {
        source: '/blog/:slug',
        destination: '/news/:slug', // Matched parameters can be used in the destination
      },
    ]
  },
}

通配符路径匹配

要匹配通配符路径，您可以在参数后使用 *，例如 /blog/:slug* 将匹配 /blog/a/b/c/d/hello-world

next.config.js

module.exports = {
  async rewrites() {
    return [
      {
        source: '/blog/:slug*',
        destination: '/news/:slug*', // Matched parameters can be used in the destination
      },
    ]
  },
}

正则表达式路径匹配

要匹配正则表达式路径，您可以在参数后用括号括起来正则表达式，例如 /blog/:slug(\\d{1,}) 将匹配 /blog/123 但不匹配 /blog/abc

next.config.js

module.exports = {
  async rewrites() {
    return [
      {
        source: '/old-blog/:post(\\d{1,})',
        destination: '/blog/:post', // Matched parameters can be used in the destination
      },
    ]
  },
}

以下字符 (、)、{、}、[、]、|、\、^、.、:、*、+、-、?、$ 用于正则表达式路径匹配，因此当在 source 中用作非特殊值时，必须在它们前面添加 \\ 进行转义

next.config.js

module.exports = {
  async rewrites() {
    return [
      {
        // this will match `/english(default)/something` being requested
        source: '/english\\(default\\)/:slug',
        destination: '/en-us/:slug',
      },
    ]
  },
}

要仅在 header、cookie 或 query 值也匹配 has 字段或不匹配 missing 字段时匹配重写，可以使用 has 和 missing 字段。 source 和所有 has 项目必须匹配，并且所有 missing 项目必须不匹配，重写才能应用。

has 和 missing 项目可以具有以下字段

type：String - 必须是 header、cookie、host 或 query 之一。
key：String - 要匹配的所选类型的键。
value：String 或 undefined - 要检查的值，如果未定义，则任何值都将匹配。可以使用类似正则表达式的字符串来捕获值的特定部分，例如，如果使用 first-(?<paramName>.*) 作为 first-second 的值，则 second 将在目标中使用 :paramName 可用。

next.config.js

module.exports = {
  async rewrites() {
    return [
      // if the header `x-rewrite-me` is present,
      // this rewrite will be applied
      {
        source: '/:path*',
        has: [
          {
            type: 'header',
            key: 'x-rewrite-me',
          },
        ],
        destination: '/another-page',
      },
      // if the header `x-rewrite-me` is not present,
      // this rewrite will be applied
      {
        source: '/:path*',
        missing: [
          {
            type: 'header',
            key: 'x-rewrite-me',
          },
        ],
        destination: '/another-page',
      },
      // if the source, query, and cookie are matched,
      // this rewrite will be applied
      {
        source: '/specific/:path*',
        has: [
          {
            type: 'query',
            key: 'page',
            // the page value will not be available in the
            // destination since value is provided and doesn't
            // use a named capture group e.g. (?<page>home)
            value: 'home',
          },
          {
            type: 'cookie',
            key: 'authorized',
            value: 'true',
          },
        ],
        destination: '/:path*/home',
      },
      // if the header `x-authorized` is present and
      // contains a matching value, this rewrite will be applied
      {
        source: '/:path*',
        has: [
          {
            type: 'header',
            key: 'x-authorized',
            value: '(?<authorized>yes|true)',
          },
        ],
        destination: '/home?authorized=:authorized',
      },
      // if the host is `example.com`,
      // this rewrite will be applied
      {
        source: '/:path*',
        has: [
          {
            type: 'host',
            value: 'example.com',
          },
        ],
        destination: '/another-page',
      },
    ]
  },
}

重写到外部 URL

示例

重写允许您重写到外部 URL。这对于增量采用 Next.js 特别有用。以下是将主应用程序的 /blog 路由重定向到外部站点的重写示例。

next.config.js

module.exports = {
  async rewrites() {
    return [
      {
        source: '/blog',
        destination: 'https://example.com/blog',
      },
      {
        source: '/blog/:slug',
        destination: 'https://example.com/blog/:slug', // Matched parameters can be used in the destination
      },
    ]
  },
}

如果您使用的是 trailingSlash: true，则还需要在 source 参数中插入尾部斜杠。如果目标服务器也期望尾部斜杠，则也应将其包含在 destination 参数中。

next.config.js

module.exports = {
  trailingSlash: true,
  async rewrites() {
    return [
      {
        source: '/blog/',
        destination: 'https://example.com/blog/',
      },
      {
        source: '/blog/:path*/',
        destination: 'https://example.com/blog/:path*/',
      },
    ]
  },
}

增量采用 Next.js

您还可以让 Next.js 在检查所有 Next.js 路由后回退到代理到现有网站。

这样，在将更多页面迁移到 Next.js 时，您就不必更改重写配置。

next.config.js

module.exports = {
  async rewrites() {
    return {
      fallback: [
        {
          source: '/:path*',
          destination: `https://custom-routes-proxying-endpoint.vercel.app/:path*`,
        },
      ],
    }
  },
}

支持 basePath 的重写

当利用 basePath 支持和重写时，每个 source 和 destination 会自动以 basePath 为前缀，除非您在重写中添加 basePath: false

next.config.js

module.exports = {
  basePath: '/docs',
 
  async rewrites() {
    return [
      {
        source: '/with-basePath', // automatically becomes /docs/with-basePath
        destination: '/another', // automatically becomes /docs/another
      },
      {
        // does not add /docs to /without-basePath since basePath: false is set
        // Note: this can not be used for internal rewrites e.g. `destination: '/another'`
        source: '/without-basePath',
        destination: 'https://example.com',
        basePath: false,
      },
    ]
  },
}

支持 i18n 的重写

当利用 i18n 支持和重写时，每个 source 和 destination 会自动添加前缀以处理配置的 locales，除非您在重写中添加 locale: false。如果使用 locale: false，则必须为 source 和 destination 添加前缀才能正确匹配。

next.config.js

module.exports = {
  i18n: {
    locales: ['en', 'fr', 'de'],
    defaultLocale: 'en',
  },
 
  async rewrites() {
    return [
      {
        source: '/with-locale', // automatically handles all locales
        destination: '/another', // automatically passes the locale on
      },
      {
        // does not handle locales automatically since locale: false is set
        source: '/nl/with-locale-manual',
        destination: '/nl/another',
        locale: false,
      },
      {
        // this matches '/' since `en` is the defaultLocale
        source: '/en',
        destination: '/en/another',
        locale: false,
      },
      {
        // it's possible to match all locales even when locale: false is set
        source: '/:locale/api-alias/:path*',
        destination: '/api/:path*',
        locale: false,
      },
      {
        // this gets converted to /(en|fr|de)/(.*) so will not match the top-level
        // `/` or `/fr` routes like /:path* would
        source: '/(.*)',
        destination: '/another',
      },
    ]
  },
}

版本历史

版本	更改
`v13.3.0`	添加了 `missing`。
`v10.2.0`	添加了 `has`。
`v9.5.0`	添加了 Headers。