Sponsor
ntab.devntab.dev —提升效率的新标签页组件
点击查看
Menu

重定向

在 Next.js 中有几种处理重定向的方式。本页将介绍每种可用选项、使用场景以及如何管理大量重定向。

API用途使用位置状态码
useRouter执行客户端导航Components不适用
redirects in next.config.js基于路径重定向传入请求next.config.js 文件307（临时）或 308（永久）
NextResponse.redirect基于条件重定向传入请求Middleware任意

useRouter() 钩子

如果你需要在组件中重定向，可以使用 useRouter 钩子的 push 方法。例如：

app/page.tsx
TypeScript
import { useRouter } from 'next/router'
 
export default function Page() {
  const router = useRouter()
 
  return (
    <button type="button" onClick={() => router.push('/dashboard')}>
      Dashboard
    </button>
  )
}

值得注意的是：

  • 如果你不需要以编程方式导航用户，应该使用 <Link> 组件。

有关更多信息，请参阅 useRouter API 参考。

redirects 在 next.config.js 中

next.config.js 文件中的 redirects 选项允许你将传入的请求路径重定向到不同的目标路径。当你更改页面的 URL 结构或有一系列预先已知的重定向时，这很有用。

redirects 支持 路径匹配 和 标头、Cookie 和查询匹配，使你能够根据传入请求灵活地重定向用户。

要使用 redirects，将该选项添加到你的 next.config.js 文件中：

next.config.ts
TypeScript
import type { NextConfig } from 'next'
 
const nextConfig: NextConfig = {
  async redirects() {
    return [
      // 基本重定向
      {
        source: '/about',
        destination: '/',
        permanent: true,
      },
      // 通配符路径匹配
      {
        source: '/blog/:slug',
        destination: '/news/:slug',
        permanent: true,
      },
    ]
  },
}
 
export default nextConfig

有关更多信息，请参阅 redirects API 参考。

值得注意的是：

  • redirects 可以通过 permanent 选项返回 307（临时重定向）或 308（永久重定向）状态码。
  • redirects 在某些平台上可能有限制。例如，在 Vercel 上，限制为 1,024 个重定向。要管理大量重定向（1000+），可以考虑使用 Middleware 创建自定义解决方案。详见大规模管理重定向。
  • redirects 在 Middleware 之前运行。

Middleware 中的 NextResponse.redirect

Middleware 允许你在请求完成之前运行代码。然后，根据传入的请求，使用 NextResponse.redirect 重定向到不同的 URL。当你想根据条件（如身份验证、会话管理等）重定向用户或有大量重定向时，这很有用。

例如，如果用户未通过身份验证，将其重定向到 /login 页面：

middleware.ts
TypeScript
import { NextResponse, NextRequest } from 'next/server'
import { authenticate } from 'auth-provider'
 
export function middleware(request: NextRequest) {
  const isAuthenticated = authenticate(request)
 
  // 如果用户已通过身份验证，正常继续
  if (isAuthenticated) {
    return NextResponse.next()
  }
 
  // 如果未通过身份验证，重定向到登录页面
  return NextResponse.redirect(new URL('/login', request.url))
}
 
export const config = {
  matcher: '/dashboard/:path*',
}

值得注意的是：

  • Middleware 在 next.config.js 中的 redirects 之后运行，在渲染之前运行。

有关更多信息，请参阅 Middleware 文档。

大规模管理重定向（高级）

要管理大量重定向（1000+），你可以考虑使用 Middleware 创建自定义解决方案。这允许你以编程方式处理重定向，而无需重新部署应用程序。

要做到这一点，你需要考虑：

  1. 创建和存储重定向映射。
  2. 优化数据查找性能。

Next.js 示例：请参阅我们的 带有布隆过滤器的 Middleware 示例，了解下面建议的实现。

1. 创建和存储重定向映射

重定向映射是一个重定向列表，你可以将其存储在数据库（通常是键值存储）或 JSON 文件中。

考虑以下数据结构：

{
  "/old": {
    "destination": "/new",
    "permanent": true
  },
  "/blog/post-old": {
    "destination": "/blog/post-new",
    "permanent": true
  }
}

在 Middleware 中，你可以从数据库（如 Vercel 的 Edge Config 或 Redis）读取，并根据传入请求重定向用户：

middleware.ts
TypeScript
import { NextResponse, NextRequest } from 'next/server'
import { get } from '@vercel/edge-config'
 
type RedirectEntry = {
  destination: string
  permanent: boolean
}
 
export async function middleware(request: NextRequest) {
  const pathname = request.nextUrl.pathname
  const redirectData = await get(pathname)
 
  if (redirectData && typeof redirectData === 'string') {
    const redirectEntry: RedirectEntry = JSON.parse(redirectData)
    const statusCode = redirectEntry.permanent ? 308 : 307
    return NextResponse.redirect(redirectEntry.destination, statusCode)
  }
 
  // 未找到重定向，继续而不重定向
  return NextResponse.next()
}

2. 优化数据查找性能

对每个传入请求读取大型数据集可能会很慢且成本高。你可以通过两种方式优化数据查找性能：

  • 使用针对快速读取进行优化的数据库，例如 Vercel Edge Config 或 Redis。
  • 使用数据查找策略，例如 布隆过滤器，在读取更大的重定向文件或数据库之前高效检查重定向是否存在。

考虑前面的示例，你可以将生成的布隆过滤器文件导入到 Middleware 中，然后检查传入请求的路径名是否存在于布隆过滤器中。

如果存在，将请求转发到 API Routes，它将检查实际文件并将用户重定向到适当的 URL。这避免了将大型重定向文件导入到 Middleware 中，这可能会减慢每个传入请求的速度。

middleware.ts
TypeScript
import { NextResponse, NextRequest } from 'next/server'
import { ScalableBloomFilter } from 'bloom-filters'
import GeneratedBloomFilter from './redirects/bloom-filter.json'
 
type RedirectEntry = {
  destination: string
  permanent: boolean
}
 
// 从生成的 JSON 文件初始化布隆过滤器
const bloomFilter = ScalableBloomFilter.fromJSON(GeneratedBloomFilter as any)
 
export async function middleware(request: NextRequest) {
  // 获取传入请求的路径
  const pathname = request.nextUrl.pathname
 
  // 检查路径是否在布隆过滤器中
  if (bloomFilter.has(pathname)) {
    // 将路径名转发到 Route Handler
    const api = new URL(
      `/api/redirects?pathname=${encodeURIComponent(request.nextUrl.pathname)}`,
      request.nextUrl.origin
    )
 
    try {
      // 从 Route Handler 获取重定向数据
      const redirectData = await fetch(api)
 
      if (redirectData.ok) {
        const redirectEntry: RedirectEntry | undefined =
          await redirectData.json()
 
        if (redirectEntry) {
          // 确定状态码
          const statusCode = redirectEntry.permanent ? 308 : 307
 
          // 重定向到目标
          return NextResponse.redirect(redirectEntry.destination, statusCode)
        }
      }
    } catch (error) {
      console.error(error)
    }
  }
 
  // 未找到重定向，继续请求而不重定向
  return NextResponse.next()
}

然后，在 API Route 中：

pages/api/redirects.ts
TypeScript
import type { NextApiRequest, NextApiResponse } from 'next'
import redirects from '@/app/redirects/redirects.json'
 
type RedirectEntry = {
  destination: string
  permanent: boolean
}
 
export default function handler(req: NextApiRequest, res: NextApiResponse) {
  const pathname = req.query.pathname
  if (!pathname) {
    return res.status(400).json({ message: 'Bad Request' })
  }
 
  // 从 redirects.json 文件中获取重定向条目
  const redirect = (redirects as Record<string, RedirectEntry>)[pathname]
 
  // 处理布隆过滤器误报
  if (!redirect) {
    return res.status(400).json({ message: 'No redirect' })
  }
 
  // 返回重定向条目
  return res.json(redirect)
}

值得注意的是：

  • 要生成布隆过滤器，可以使用像 bloom-filters 这样的库。
  • 你应该验证对 Route Handler 的请求，以防止恶意请求。