rewrites

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

重写充当 URL 代理并隐藏目标路径，使用户看起来像是没有改变他们在网站上的位置。相比之下，重定向 (redirects) 会重新路由到新页面并显示 URL 变化。

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

next.config.js

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

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

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

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

当 rewrites 函数返回一个数组时，重写会在检查文件系统（页面和 /public 文件）之后、动态路由之前应用。当 rewrites 函数返回特定结构的对象数组时（自 Next.js v10.1 起），可以更改并更精细地控制此行为：

next.config.js

module.exports = {
  async rewrites() {
    return {
      beforeFiles: [
        // 这些重写在检查 headers/redirects 之后
        // 并在所有文件（包括 _next/public 文件）之前检查
        // 允许覆盖页面文件
        {
          source: '/some-page',
          destination: '/somewhere-else',
          has: [{ type: 'query', key: 'overrideMe' }],
        },
      ],
      afterFiles: [
        // 这些重写在检查 pages/public 文件之后
        // 但在动态路由之前检查
        {
          source: '/non-existent',
          destination: '/somewhere-else',
        },
      ],
      fallback: [
        // 这些重写在检查 pages/public 文件和动态路由之后检查
        {
          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 中定义的 fallback 重写将不会运行。

重写参数

在重写中使用参数时，如果 destination 中没有使用任何参数，则参数会默认传递到查询中。

next.config.js

module.exports = {
  async rewrites() {
    return [
      {
        source: '/old-about/:path*',
        destination: '/about', // 此处未使用 :path 参数，因此会自动传递到查询中
      },
    ]
  },
}

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

next.config.js

module.exports = {
  async rewrites() {
    return [
      {
        source: '/docs/:path*',
        destination: '/:path*', // 此处使用了 :path 参数，因此不会自动传递到查询中
      },
    ]
  },
}

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

next.config.js

module.exports = {
  async rewrites() {
    return [
      {
        source: '/:first/:second',
        destination: '/:first?second=:second',
        // 由于 :first 参数已在 destination 中使用，因此 :second 参数
        // 不会自动添加到查询中，但我们可以像上面那样手动添加
      },
    ]
  },
}

须知：来自自动静态优化 (Automatic Static Optimization) 或预渲染 (prerendering) 的静态页面的重写参数将在客户端水合后解析并出现在查询中。

路径匹配

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

next.config.js

module.exports = {
  async rewrites() {
    return [
      {
        source: '/blog/:slug',
        destination: '/news/:slug', // 匹配的参数可以在 destination 中使用
      },
    ]
  },
}

通配符路径匹配

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

next.config.js

module.exports = {
  async rewrites() {
    return [
      {
        source: '/blog/:slug*',
        destination: '/news/:slug*', // 匹配的参数可以在 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', // 匹配的参数可以在 destination 中使用
      },
    ]
  },
}

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

next.config.js

module.exports = {
  async rewrites() {
    return [
      {
        // 这将匹配请求 `/english(default)/something`
        source: '/english\\(default\\)/:slug',
        destination: '/en-us/:slug',
      },
    ]
  },
}

头部、Cookie 和查询匹配

要仅在头部、cookie 或查询值也匹配 has 字段或不匹配 missing 字段时才匹配重写，可以使用 has 和 missing。source 和所有 has 项必须匹配，且所有 missing 项必须不匹配，才会应用重写。

has 和 missing 项可以包含以下字段：

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

next.config.js

module.exports = {
  async rewrites() {
    return [
      // 如果存在头部 `x-rewrite-me`，
      // 将应用此重写
      {
        source: '/:path*',
        has: [
          {
            type: 'header',
            key: 'x-rewrite-me',
          },
        ],
        destination: '/another-page',
      },
      // 如果不存在头部 `x-rewrite-me`，
      // 将应用此重写
      {
        source: '/:path*',
        missing: [
          {
            type: 'header',
            key: 'x-rewrite-me',
          },
        ],
        destination: '/another-page',
      },
      // 如果 source、查询和 cookie 都匹配，
      // 将应用此重写
      {
        source: '/specific/:path*',
        has: [
          {
            type: 'query',
            key: 'page',
            // 由于提供了 value 且未使用命名捕获组（如 `(?<page>home)`），
            // page 值将不会在 destination 中可用
            value: 'home',
          },
          {
            type: 'cookie',
            key: 'authorized',
            value: 'true',
          },
        ],
        destination: '/:path*/home',
      },
      // 如果存在头部 `x-authorized` 且
      // 包含匹配的值，将应用此重写
      {
        source: '/:path*',
        has: [
          {
            type: 'header',
            key: 'x-authorized',
            value: '(?<authorized>yes|true)',
          },
        ],
        destination: '/home?authorized=:authorized',
      },
      // 如果 host 是 `example.com`，
      // 将应用此重写
      {
        source: '/:path*',
        has: [
          {
            type: 'host',
            value: 'example.com',
          },
        ],
        destination: '/another-page',
      },
    ]
  },
}

重写到外部 URL

示例

使用多区域 (Using Multiple Zones)

重写允许您重写到外部 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', // 匹配的参数可以在 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', // 自动变为 /docs/with-basePath
        destination: '/another', // 自动变为 /docs/another
      },
      {
        // 由于设置了 basePath: false，不会将 /docs 添加到 /without-basePath
        // 注意：不能用于内部重写，例如 `destination: '/another'`
        source: '/without-basePath',
        destination: 'https://example.com',
        basePath: false,
      },
    ]
  },
}

版本历史

版本	变更
`v13.3.0`	添加 `missing`。
`v10.2.0`	添加 `has`。
`v9.5.0`	添加头部支持。

On this page