NNext.js 中文网 GitHub

如何在 Next.js 中处理重定向

了解在 Next.js 中处理重定向的不同方式。

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

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

redirect 函数#

redirect 函数允许你将用户重定向到另一个 URL。你可以在 Server Components、Route Handlers 和 Server Functions 中调用 redirect。

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

app/actions.ts
'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}`) // 导航到新帖子页面
}
app/actions.js
'use server'

import { redirect } from 'next/navigation'
import { revalidatePath } from 'next/cache'

export async function createPost(id) {
  try {
    // 调用数据库
  } catch (error) {
    // 处理错误
  }

  revalidatePath('/posts') // 更新缓存的帖子
  redirect(`/post/${id}`) // 导航到新帖子页面
}

小知识:

  • 在 Server Action 中,当 JavaScript 可用时,redirect 会执行客户端导航。如果没有 JavaScript,表单提交会使用 303(See Other)。在其他上下文中,redirect 使用 307(Temporary Redirect)。
  • redirect 会抛出错误,因此在使用 try/catch 语句时,应在 try 块之外调用它。
  • redirect 可以在渲染过程中在 Client Components 中调用,但不能在事件处理器中调用。你可以改用 useRouter hook。
  • redirect 也接受绝对 URL,可用于重定向到外部链接。
  • 如果你想在渲染过程之前重定向,请使用 next.config.js 或 Proxy。

有关更多信息,请参阅 redirect API 参考。

permanentRedirect 函数#

permanentRedirect 函数允许你永久将用户重定向到另一个 URL。你可以在 Server Components、Route Handlers 和 Server Functions 中调用 permanentRedirect。

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

app/actions.ts
'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', 'max') // 更新所有对该用户名的引用
  permanentRedirect(`/profile/${username}`) // 导航到新的用户资料页
}
app/actions.js
'use server'

import { permanentRedirect } from 'next/navigation'
import { revalidateTag } from 'next/cache'

export async function updateUsername(username, formData) {
  try {
    // 调用数据库
  } catch (error) {
    // 处理错误
  }

  revalidateTag('username', 'max') // 更新所有对该用户名的引用
  permanentRedirect(`/profile/${username}`) // 导航到新的用户资料页
}

小知识:

  • 在 Server Action 中,当 JavaScript 可用时,permanentRedirect 会执行客户端导航。如果没有 JavaScript,表单提交会使用 303(See Other)。在其他上下文中,permanentRedirect 使用 308(Permanent Redirect)。
  • permanentRedirect 也接受绝对 URL,可用于重定向到外部链接。
  • 如果你想在渲染过程之前重定向,请使用 next.config.js 或 Proxy。

有关更多信息,请参阅 permanentRedirect API 参考。

useRouter() hook#

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

app/page.tsx
'use client'

import { useRouter } from 'next/navigation'

export default function Page() {
  const router = useRouter()

  return (
    <button type="button" onClick={() => router.push('/dashboard')}>
      Dashboard
    </button>
  )
}
app/page.js
'use client'

import { useRouter } from 'next/navigation'

export default function Page() {
  const router = useRouter()

  return (
    <button type="button" onClick={() => router.push('/dashboard')}>
      Dashboard
    </button>
  )
}

如果你需要在组件中进行重定向,可以使用 useRouter hook 的 push 方法。例如:

app/page.tsx
import { useRouter } from 'next/router'

export default function Page() {
  const router = useRouter()

  return (
    <button type="button" onClick={() => router.push('/dashboard')}>
      Dashboard
    </button>
  )
}
app/page.js
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 参考。

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

next.config.js 中的 redirects#

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

redirects 支持路径、header、cookie 和 query 匹配,使你可以灵活地根据传入的请求重定向用户。

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

next.config.ts
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
next.config.js
module.exports = {
  async redirects() {
    return [
      // 基本重定向
      {
        source: '/about',
        destination: '/',
        permanent: true,
      },
      // 通配符路径匹配
      {
        source: '/blog/:slug',
        destination: '/news/:slug',
        permanent: true,
      },
    ]
  },
}

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

小知识:

  • redirects 可以通过 permanent 选项返回 307(Temporary Redirect)或 308(Permanent Redirect)状态码。
  • redirects 在某些平台上可能有限制。例如,在 Vercel 上,重定向数量限制为 1,024 条。要管理大量重定向(1000 条以上),请考虑使用 Proxy 创建自定义解决方案。有关更多信息,请参阅大规模管理重定向。
  • redirects 在 Proxy 之前运行。

Proxy 中的 NextResponse.redirect#

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

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

proxy.ts
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.js
import { NextResponse } from 'next/server'
import { authenticate } from 'auth-provider'

export function proxy(request) {
  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 示例,了解以下建议的实现。

1. 创建并存储重定向映射#

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

考虑以下数据结构:

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

在 Proxy 中,你可以从 Vercel 的 Global Config 或 Redis 等数据库中读取数据,并根据传入的请求重定向用户:

proxy.ts
import { NextResponse, NextRequest } from 'next/server'
import { get } from '@vercel/global-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()
}
proxy.js
import { NextResponse } from 'next/server'
import { get } from '@vercel/global-config'

export async function proxy(request) {
  const pathname = request.nextUrl.pathname
  const redirectData = await get(pathname)

  if (redirectData) {
    const redirectEntry = JSON.parse(redirectData)
    const statusCode = redirectEntry.permanent ? 308 : 307
    return NextResponse.redirect(redirectEntry.destination, statusCode)
  }

  // 未找到重定向,继续且不进行重定向
  return NextResponse.next()
}

2. 优化数据查找性能#

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

  • 使用针对快速读取进行了优化的数据库
  • 使用诸如 布隆过滤器 之类的数据查找策略,在读取较大的重定向文件或数据库之前高效地检查是否存在重定向。

沿用前面的示例,你可以将生成的布隆过滤器文件导入 Proxy,然后检查传入请求的 pathname 是否存在于布隆过滤器中。

如果存在,则将请求转发给 Route Handler API Routes,由它检查实际文件并将用户重定向到相应的 URL。这样可以避免将大型重定向文件导入 Proxy,否则可能会拖慢每个传入的请求。

proxy.ts
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 proxy(request: NextRequest) {
  // 获取传入请求的路径
  const pathname = request.nextUrl.pathname

  // 检查路径是否在布隆过滤器中
  if (bloomFilter.has(pathname)) {
    // 将 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()
}
proxy.js
import { NextResponse } from 'next/server'
import { ScalableBloomFilter } from 'bloom-filters'
import GeneratedBloomFilter from './redirects/bloom-filter.json'

// 从生成的 JSON 文件初始化布隆过滤器
const bloomFilter = ScalableBloomFilter.fromJSON(GeneratedBloomFilter)

export async function proxy(request) {
  // 获取传入请求的路径
  const pathname = request.nextUrl.pathname

  // 检查路径是否在布隆过滤器中
  if (bloomFilter.has(pathname)) {
    // 将 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 = 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
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]

  // 考虑布隆过滤器的误报
  if (!redirect) {
    return new Response('No redirect', { status: 400 })
  }

  // 返回重定向条目
  return NextResponse.json(redirect)
}
app/api/redirects/route.js
import { NextResponse } from 'next/server'
import redirects from '@/app/redirects/redirects.json'

export function GET(request) {
  const pathname = request.nextUrl.searchParams.get('pathname')
  if (!pathname) {
    return new Response('Bad Request', { status: 400 })
  }

  // 从 redirects.json 文件中获取重定向条目
  const redirect = redirects[pathname]

  // 考虑布隆过滤器的误报
  if (!redirect) {
    return new Response('No redirect', { status: 400 })
  }

  // 返回重定向条目
  return NextResponse.json(redirect)
}

然后,在 API Route 中:

pages/api/redirects.ts
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)
}
pages/api/redirects.js
import redirects from '@/app/redirects/redirects.json'

export default function handler(req, res) {
  const pathname = req.query.pathname
  if (!pathname) {
    return res.status(400).json({ message: 'Bad Request' })
  }

  // 从 redirects.json 文件中获取重定向条目
  const redirect = redirects[pathname]

  // 考虑布隆过滤器的误报
  if (!redirect) {
    return res.status(400).json({ message: 'No redirect' })
  }

  // 返回重定向条目
  return res.json(redirect)
}

小知识:

  • 要生成布隆过滤器,你可以使用 bloom-filters 之类的库。
  • 你应该验证向 Route Handler 发出的请求,以防止恶意请求。
Next.js 中文网