NNext.js 中文网 GitHub

skipTrailingSlashRedirect

禁用自动的尾部斜杠重定向,以便你在 Proxy 中自行处理尾部斜杠。

启用 skipTrailingSlashRedirect 会关闭添加或移除尾部斜杠的自动重定向。你仍需在 Proxy 中处理任何想要的重定向。

大多数项目不需要此选项。 它是高级 Proxy 标志之一,适用于特定的路由场景和调试。

next.config.ts
import type { NextConfig } from 'next'

const nextConfig: NextConfig = {
  skipTrailingSlashRedirect: true,
}

export default nextConfig
next.config.js
/** @type {import('next').NextConfig} */
const nextConfig = {
  skipTrailingSlashRedirect: true,
}

module.exports = nextConfig

参考#

默认情况下,Next.js 会重定向每个请求,使尾部斜杠与你的 trailingSlash 设置保持一致。

trailingSlash请求默认响应
false/about200
false/about/308 重定向到 /about
true/about308 重定向到 /about/
true/about/200

启用 skipTrailingSlashRedirect 会影响服务端响应和客户端导航:

  • /about 和 /about/ 都返回 200。两者都不会重定向到对方。
  • Next.js 在客户端导航期间不再更改尾部斜杠。<Link> 和路由器的 URL 会保持路径原样。

你在 next.config.js 中自定义的 redirects 和 rewrites 仍然生效。

包含点的路径#

如果最后一个路径段包含点,Next.js 会将该路径视为文件并移除尾部斜杠,而不管 trailingSlash 设置如何。较早路径段中的点不起作用,但 .well-known/ 下的情况除外:当 trailingSlash 为 true 时,它不受默认重定向的影响。

请求trailingSlash: truetrailingSlash: falseskipTrailingSlashRedirect: true
/about308 重定向到 /about/200200
/about/200308 重定向到 /about200
/gcc.git/308 重定向到 /gcc.git308 重定向到 /gcc.git200
/version/1.2.3/308 重定向到 /version/1.2.3308 重定向到 /version/1.2.3200
/version/1.2.3/my-page/200308 重定向到 /version/1.2.3/my-page200
/.well-known/x/200308 重定向到 /.well-known/x200

启用 skipTrailingSlashRedirect 后,这些重定向都不会生成,每个路径都会按请求时的形式提供服务。

小知识#

  • 像以前一样继续设置 trailingSlash。它仍然控制 Next.js 生成的 URL 以及 output: 'export' 的输出文件名。
  • 使用 output: 'export' 时,这会保留 href,而不是将 /me 解析为 /me/。请参阅静态导出。
  • 同时在 /about 和 /about/ 提供同一个页面,会让搜索引擎看到该页面的两个 URL。请在你的元数据中设置规范 URL,或在 Proxy 中进行重定向。

示例#

在 Proxy 中处理尾部斜杠#

启用 skipTrailingSlashRedirect 后,Next.js 不再添加尾部斜杠,但 Proxy 仍然可以有选择地添加它们。此示例为你自己的路由添加尾部斜杠,同时保留一组旧前缀不变,从而简化增量迁移。

proxy.ts
import { NextResponse } from 'next/server'
import type { NextRequest } from 'next/server'

const legacyPrefixes = ['/docs', '/blog']

export default function proxy(request: NextRequest) {
  const { pathname } = request.nextUrl

  if (legacyPrefixes.some((prefix) => pathname.startsWith(prefix))) {
    return NextResponse.next()
  }

  // 应用尾部斜杠处理,跳过文件和 `.well-known` 路径
  if (
    !pathname.endsWith('/') &&
    !pathname.match(/((?!\.well-known(?:\/.*)?)(?:[^/]+\/)*[^/]+\.\w+)/)
  ) {
    return NextResponse.redirect(new URL(`${pathname}/`, request.nextUrl))
  }
}
proxy.js
import { NextResponse } from 'next/server'

const legacyPrefixes = ['/docs', '/blog']

export default function proxy(request) {
  const { pathname } = request.nextUrl

  if (legacyPrefixes.some((prefix) => pathname.startsWith(prefix))) {
    return NextResponse.next()
  }

  // 应用尾部斜杠处理,跳过文件和 `.well-known` 路径
  if (
    !pathname.endsWith('/') &&
    !pathname.match(/((?!\.well-known(?:\/.*)?)(?:[^/]+\/)*[^/]+\.\w+)/)
  ) {
    return NextResponse.redirect(new URL(`${pathname}/`, request.nextUrl))
  }
}

版本历史#

版本变更内容
v13.1.0新增 skipTrailingSlashRedirect。
Next.js 中文网