跳到主要内容

redirects

重定向允许你将传入请求路径重定向到不同的目标路径。

要使用重定向，你可以在 next.config.js 中使用 redirects 键：

next.config.js
module.exports = {
  async redirects() {
    return [
      {
        source: '/about',
        destination: '/',
        permanent: true,
      },
    ]
  },
}

redirects 是一个异步函数，期望返回一个包含具有 source、destination 和 permanent 属性的对象的数组：

  • source 是传入请求路径模式。
  • destination 是你想要路由到的路径。
  • permanent true 或 false - 如果为 true 将使用 308 状态码，指示客户端/搜索引擎永久缓存重定向，如果为 false 将使用 307 状态码，这是临时的且不被缓存。

为什么 Next.js 使用 307 和 308？ 传统上，302 用于临时重定向，301 用于永久重定向，但许多浏览器将重定向的请求方法更改为 GET，无论原始方法如何。例如，如果浏览器向 POST /v1/users 发出请求，返回状态码 302，位置为 /v2/users，后续请求可能是 GET /v2/users 而不是预期的 POST /v2/users。Next.js 使用 307 临时重定向和 308 永久重定向状态码来明确保留使用的请求方法。

  • basePath：false 或 undefined - 如果为 false，匹配时不会包含 basePath，仅可用于外部重定向。
  • locale：false 或 undefined - 匹配时是否不应包含区域设置。
  • has 是具有 type、key 和 value 属性的 has 对象 数组。
  • missing 是具有 type、key 和 value 属性的 missing 对象 数组。

重定向在文件系统（包括页面和 /public 文件）之前进行检查。

使用 Pages 路由时，除非存在 中间件 并匹配路径，否则重定向不会应用于客户端路由（Link、router.push）。

当应用重定向时，请求中提供的任何查询值都会传递到重定向目标。例如，请参阅以下重定向配置：

{
  source: '/old-blog/:path*',
  destination: '/blog/:path*',
  permanent: false
}

提示：记住在 source 和 destination 路径的路径参数中的冒号 : 前包含正斜杠 /，否则路径将被视为字面字符串，你可能会遇到无限重定向的风险。

当请求 /old-blog/post-1?hello=world 时，客户端将被重定向到 /blog/post-1?hello=world。

路径匹配​

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

next.config.js
module.exports = {
  async redirects() {
    return [
      {
        source: '/old-blog/:slug',
        destination: '/news/:slug', // 匹配的参数可以在目标中使用
        permanent: true,
      },
    ]
  },
}

通配符路径匹配​

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

next.config.js
module.exports = {
  async redirects() {
    return [
      {
        source: '/blog/:slug*',
        destination: '/news/:slug*', // 匹配的参数可以在目标中使用
        permanent: true,
      },
    ]
  },
}

正则表达式路径匹配​

要匹配正则表达式路径，你可以在参数后的括号中包装正则表达式，例如 /post/:slug(\\d{1,}) 将匹配 /post/123 但不匹配 /post/abc：

next.config.js
module.exports = {
  async redirects() {
    return [
      {
        source: '/post/:slug(\\d{1,})',
        destination: '/news/:slug', // 匹配的参数可以在目标中使用
        permanent: false,
      },
    ]
  },
}

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

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

要仅在头部、cookie 或查询值也匹配 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 redirects() {
    return [
      // 如果头部 `x-redirect-me` 存在，
      // 将应用此重定向
      {
        source: '/:path((?!another-page$).*)',
        has: [
          {
            type: 'header',
            key: 'x-redirect-me',
          },
        ],
        permanent: false,
        destination: '/another-page',
      },
      // 如果头部 `x-dont-redirect` 存在，
      // 将不会应用此重定向
      {
        source: '/:path((?!another-page$).*)',
        missing: [
          {
            type: 'header',
            key: 'x-do-not-redirect',
          },
        ],
        permanent: false,
        destination: '/another-page',
      },
      // 如果源、查询和 cookie 都匹配，
      // 将应用此重定向
      {
        source: '/specific/:path*',
        has: [
          {
            type: 'query',
            key: 'page',
            // 页面值在目标中不可用，因为提供了值
            // 并且不使用命名捕获组，例如 (?<page>home)
            value: 'home',
          },
          {
            type: 'cookie',
            key: 'authorized',
            value: 'true',
          },
        ],
        permanent: false,
        destination: '/another/:path*',
      },
      // 如果头部 `x-authorized` 存在且
      // 包含匹配值，将应用此重定向
      {
        source: '/',
        has: [
          {
            type: 'header',
            key: 'x-authorized',
            value: '(?<authorized>yes|true)',
          },
        ],
        permanent: false,
        destination: '/home?authorized=:authorized',
      },
      // 如果主机是 `example.com`，
      // 将应用此重定向
      {
        source: '/:path((?!another-page$).*)',
        has: [
          {
            type: 'host',
            value: 'example.com',
          },
        ],
        permanent: false,
        destination: '/another-page',
      },
    ]
  },
}

支持 basePath 的重定向​

当在重定向中利用 basePath 支持 时，每个 source 和 destination 都会自动添加 basePath 前缀，除非你在重定向中添加 basePath: false：

next.config.js
module.exports = {
  basePath: '/docs',

  async redirects() {
    return [
      {
        source: '/with-basePath', // 自动变为 /docs/with-basePath
        destination: '/another', // 自动变为 /docs/another
        permanent: false,
      },
      {
        // 由于设置了 basePath: false，不会添加 /docs
        source: '/without-basePath',
        destination: 'https://example.com',
        basePath: false,
        permanent: 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 redirects() {
    return [
      {
        source: '/with-locale', // 自动处理所有区域设置
        destination: '/another', // 自动传递区域设置
        permanent: false,
      },
      {
        // 由于设置了 locale: false，不会自动处理区域设置
        source: '/nl/with-locale-manual',
        destination: '/nl/another',
        locale: false,
        permanent: false,
      },
      {
        // 这匹配 '/'，因为 `en` 是 defaultLocale
        source: '/en',
        destination: '/en/another',
        locale: false,
        permanent: false,
      },
      // 即使设置了 locale: false，也可以匹配所有区域设置
      {
        source: '/:locale/page',
        destination: '/en/newpage',
        permanent: false,
        locale: false,
      },
      {
        // 这被转换为 /(en|fr|de)/(.*)，所以不会匹配顶级
        // `/` 或 `/fr` 路由，就像 /:path* 那样
        source: '/(.*)',
        destination: '/another',
        permanent: false,
      },
    ]
  },
}

在某些罕见情况下，你可能需要为较旧的 HTTP 客户端分配自定义状态码以正确重定向。在这些情况下，你可以使用 statusCode 属性而不是 permanent 属性，但不能同时使用两者。为了确保 IE11 兼容性，308 状态码会自动添加 Refresh 头部。

其他重定向​

版本历史​

版本更改
v13.3.0添加 missing。
v10.2.0添加 has。
v9.5.0添加 redirects。
最后于 更新