Menu

How to handle redirects in Next.js

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

API目的位置状态码
redirect在变更或事件后重定向用户Server Components、Server Actions、Route Handlers307(临时)或 303(Server Action)
permanentRedirect在变更或事件后重定向用户Server Components、Server Actions、Route Handlers308(永久)
useRouter执行客户端导航Client Components 中的事件处理器N/A
redirects in next.config.js基于路径重定向传入请求next.config.js 文件307(临时)或 308(永久)
NextResponse.redirect基于条件重定向传入请求Proxy任意

redirect 函数

redirect 函数允许你将用户重定向到另一个 URL。你可以在 Server ComponentsRoute HandlersServer Actions 中调用 redirect

redirect 通常在变更或事件后使用。例如,创建帖子:

app/actions.ts
TypeScript
'use server'
 
import { redirect } from 'next/navigation'
import { revalidatePath } from 'next/cache'
 
export async function createPost(id: string) {
  try {
    // 调用数据库
  } catch (error) {
    // 处理错误
  }
 
  revalidatePath('/posts') // 更新缓存的帖子
  redirect(`/post/${id}`) // 导航到新帖子页面
}

值得注意的是

  • redirect 默认返回 307(临时重定向)状态码。当在 Server Action 中使用时,它返回 303(See Other),通常用于作为 POST 请求的结果重定向到成功页面。
  • redirect 会抛出错误,因此在使用 try/catch 语句时应该在 try之外调用它。
  • redirect 可以在 Client Components 的渲染过程中调用,但不能在事件处理器中调用。你可以使用 useRouter hook 代替。
  • redirect 也接受绝对 URL,可用于重定向到外部链接。
  • 如果你想在渲染过程之前重定向,请使用 next.config.jsProxy

查看 redirect API 参考了解更多信息。

permanentRedirect 函数

permanentRedirect 函数允许你永久重定向用户到另一个 URL。你可以在 Server ComponentsRoute HandlersServer Actions 中调用 permanentRedirect

permanentRedirect 通常在改变实体规范 URL 的变更或事件后使用,例如在用户更改用户名后更新其个人资料 URL:

app/actions.ts
TypeScript
'use server'
 
import { permanentRedirect } from 'next/navigation'
import { revalidateTag } from 'next/cache'
 
export async function updateUsername(username: string, formData: FormData) {
  try {
    // 调用数据库
  } catch (error) {
    // 处理错误
  }
 
  revalidateTag('username') // 更新所有对用户名的引用
  permanentRedirect(`/profile/${username}`) // 导航到新的用户资料
}

值得注意的是

  • permanentRedirect 默认返回 308(永久重定向)状态码。
  • permanentRedirect 也接受绝对 URL,可用于重定向到外部链接。
  • 如果你想在渲染过程之前重定向,请使用 next.config.jsProxy

查看 permanentRedirect API 参考了解更多信息。

useRouter() hook

如果你需要在 Client Component 的事件处理器中重定向,可以使用 useRouter hook 的 push 方法。例如:

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

值得注意的是

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

查看 useRouter API 参考了解更多信息。

next.config.js 中的 redirects

next.config.js 文件中的 redirects 选项允许你将传入的请求路径重定向到不同的目标路径。这在你更改页面的 URL 结构或提前知道重定向列表时很有用。

redirects 支持路径header、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+),考虑使用 Proxy 创建自定义解决方案。查看大规模管理重定向了解更多。
  • redirects 在 Proxy 之前运行。

Proxy 中的 NextResponse.redirect

Proxy 允许你在请求完成之前运行代码。然后,基于传入的请求,使用 NextResponse.redirect 重定向到不同的 URL。这在你想要基于条件(例如身份验证、会话管理等)重定向用户或有大量重定向时很有用。

例如,如果用户未经身份验证,将其重定向到 /login 页面:

proxy.ts
TypeScript
import { NextResponse, NextRequest } from 'next/server'
import { authenticate } from 'auth-provider'
 
export function proxy(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*',
}

值得注意的是

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

查看 Proxy 文档了解更多信息。

大规模管理重定向(高级)

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

为此,你需要考虑:

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

Next.js 示例:查看我们的 Proxy with Bloom filter 示例,了解下面建议的实现。

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

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

考虑以下数据结构:

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

Proxy 中,你可以从数据库(如 Vercel 的 Edge ConfigRedis)读取,并基于传入请求重定向用户:

proxy.ts
TypeScript
import { NextResponse, NextRequest } from 'next/server'
import { get } from '@vercel/edge-config'
 
type RedirectEntry = {
  destination: string
  permanent: boolean
}
 
export async function proxy(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. 优化数据查找性能

为每个传入请求读取大型数据集可能会很慢且昂贵。有两种方法可以优化数据查找性能:

  • 使用针对快速读取优化的数据库
  • 使用数据查找策略(如 Bloom filter)在读取更大的重定向文件或数据库之前有效地检查重定向是否存在。

考虑前面的示例,你可以将生成的 bloom filter 文件导入 Proxy,然后检查传入请求路径名是否存在于 bloom filter 中。

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

proxy.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 文件初始化 bloom filter
const bloomFilter = ScalableBloomFilter.fromJSON(GeneratedBloomFilter as any)
 
export async function proxy(request: NextRequest) {
  // 获取传入请求的路径
  const pathname = request.nextUrl.pathname
 
  // 检查路径是否在 bloom filter 中
  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()
}

然后,在 Route Handler 中:

app/api/redirects/route.ts
TypeScript
import { NextRequest, NextResponse } from 'next/server'
import redirects from '@/app/redirects/redirects.json'
 
type RedirectEntry = {
  destination: string
  permanent: boolean
}
 
export function GET(request: NextRequest) {
  const pathname = request.nextUrl.searchParams.get('pathname')
  if (!pathname) {
    return new Response('Bad Request', { status: 400 })
  }
 
  // 从 redirects.json 文件获取重定向条目
  const redirect = (redirects as Record<string, RedirectEntry>)[pathname]
 
  // 处理 bloom filter 误报
  if (!redirect) {
    return new Response('No redirect', { status: 400 })
  }
 
  // 返回重定向条目
  return NextResponse.json(redirect)
}

值得注意的是

  • 要生成 bloom filter,你可以使用像 bloom-filters 这样的库。
  • 你应该验证对 Route Handler 的请求,以防止恶意请求。