重定向
在 Next.js 中,您可以通过几种方式处理重定向。此页面将介绍每个可用选项、用例以及如何管理大量重定向。
API | 用途 | 位置 | 状态码 |
---|---|---|---|
redirect | 在变异或事件后重定向用户 | 服务器组件、服务器操作、路由处理程序 | 307(临时)或 303(服务器操作) |
permanentRedirect | 在变异或事件后重定向用户 | 服务器组件、服务器操作、路由处理程序 | 308(永久) |
useRouter | 执行客户端导航 | 客户端组件中的事件处理程序 | N/A |
next.config.js 中的 redirects | 根据路径重定向传入请求 | next.config.js 文件 | 307(临时)或 308(永久) |
NextResponse.redirect | 根据条件重定向传入请求 | 中间件 | 任何 |
redirect
函数
redirect
函数允许您将用户重定向到另一个 URL。您可以在 服务器组件、路由处理程序 和 服务器操作 中调用 redirect
。
redirect
通常在变异或事件后使用。例如,创建帖子
'use server'
import { redirect } from 'next/navigation'
import { revalidatePath } from 'next/cache'
export async function createPost(id: string) {
try {
// Call database
} catch (error) {
// Handle errors
}
revalidatePath('/posts') // Update cached posts
redirect(`/post/${id}`) // Navigate to the new post page
}
需要了解:
- 默认情况下,
redirect
返回 307(临时重定向)状态码。在服务器操作中使用时,它会返回 303(参见其他),这通常用于在 POST 请求的结果中重定向到成功页面。redirect
在内部抛出错误,因此应在try/catch
块之外调用它。redirect
可以在渲染过程中在客户端组件中调用,但不能在事件处理程序中调用。您可以改用useRouter
钩子。redirect
还接受绝对 URL,可用于重定向到外部链接。- 如果希望在渲染过程之前重定向,请使用
next.config.js
或 中间件。
有关更多信息,请参阅 redirect
API 参考。
permanentRedirect
函数
permanentRedirect
函数允许您**永久**将用户重定向到另一个 URL。您可以在 服务器组件、路由处理程序 和 服务器操作 中调用 permanentRedirect
。
permanentRedirect
通常在更改实体规范 URL 的变异或事件后使用,例如在用户更改用户名后更新用户个人资料 URL
'use server'
import { permanentRedirect } from 'next/navigation'
import { revalidateTag } from 'next/cache'
export async function updateUsername(username: string, formData: FormData) {
try {
// Call database
} catch (error) {
// Handle errors
}
revalidateTag('username') // Update all references to the username
permanentRedirect(`/profile/${username}`) // Navigate to the new user profile
}
需要了解:
permanentRedirect
默认返回 308(永久重定向)状态码。permanentRedirect
还接受绝对 URL,可用于重定向到外部链接。- 如果希望在渲染过程之前重定向,请使用
next.config.js
或 中间件。
有关更多信息,请参阅 permanentRedirect
API 参考。
useRouter()
钩子
如果需要在客户端组件的事件处理程序中进行重定向,则可以使用 useRouter
钩子中的 push
方法。例如
'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
支持 路径、头部、Cookie 和查询匹配,使您能够根据传入请求灵活地重定向用户。
要使用 redirects
,请将该选项添加到您的 next.config.js
文件中。
module.exports = {
async redirects() {
return [
// Basic redirect
{
source: '/about',
destination: '/',
permanent: true,
},
// Wildcard path matching
{
source: '/blog/:slug',
destination: '/news/:slug',
permanent: true,
},
]
},
}
有关更多信息,请参阅 redirects
API 参考。
需要了解:
中间件中的 NextResponse.redirect
中间件允许您在请求完成之前运行代码。然后,根据传入请求,使用 NextResponse.redirect
重定向到不同的 URL。如果您想根据某个条件(例如身份验证、会话管理等)重定向用户或有 大量重定向,这将非常有用。
例如,如果用户未经身份验证,则将其重定向到 /login
页面。
import { NextResponse, NextRequest } from 'next/server'
import { authenticate } from 'auth-provider'
export function middleware(request: NextRequest) {
const isAuthenticated = authenticate(request)
// If the user is authenticated, continue as normal
if (isAuthenticated) {
return NextResponse.next()
}
// Redirect to login page if not authenticated
return NextResponse.redirect(new URL('/login', request.url))
}
export const config = {
matcher: '/dashboard/:path*',
}
需要了解:
- 中间件在
next.config.js
中的redirects
**之后**和渲染**之前**运行。
有关更多信息,请参阅 中间件 文档。
大规模管理重定向(高级)
若要管理大量重定向(1000+),您可以考虑使用中间件创建自定义解决方案。这使您能够以编程方式处理重定向,而无需重新部署应用程序。
为此,您需要考虑以下几点:
- 创建和存储重定向映射。
- 优化数据查找性能。
Next.js 示例:有关以下建议的实现,请参阅我们的 带布隆过滤器的中间件 示例。
1. 创建和存储重定向映射
重定向映射是您可以存储在数据库(通常是键值存储)或 JSON 文件中的重定向列表。
请考虑以下数据结构:
{
"/old": {
"destination": "/new",
"permanent": true
},
"/blog/post-old": {
"destination": "/blog/post-new",
"permanent": true
}
}
在 中间件 中,您可以从数据库(例如 Vercel 的 Edge Config 或 Redis)中读取,并根据传入请求重定向用户。
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)
}
// No redirect found, continue without redirecting
return NextResponse.next()
}
2. 优化数据查找性能
对每个传入请求读取大型数据集可能会很慢且代价高昂。您可以通过两种方式优化数据查找性能:
- 使用针对快速读取进行了优化的数据库,例如 Vercel Edge Config 或 Redis。
- 使用数据查找策略(例如 布隆过滤器)在读取更大的重定向文件或数据库**之前**有效地检查重定向是否存在。
考虑到前面的示例,您可以将生成的布隆过滤器文件导入到中间件中,然后检查传入请求路径名是否在布隆过滤器中。
如果存在,则将请求转发到 路由处理程序它将检查实际文件并将用户重定向到相应的 URL。这避免了将大型重定向文件导入到中间件中,这可能会减慢每个传入请求的速度。
import { NextResponse, NextRequest } from 'next/server'
import { ScalableBloomFilter } from 'bloom-filters'
import GeneratedBloomFilter from './redirects/bloom-filter.json'
type RedirectEntry = {
destination: string
permanent: boolean
}
// Initialize bloom filter from a generated JSON file
const bloomFilter = ScalableBloomFilter.fromJSON(GeneratedBloomFilter as any)
export async function middleware(request: NextRequest) {
// Get the path for the incoming request
const pathname = request.nextUrl.pathname
// Check if the path is in the bloom filter
if (bloomFilter.has(pathname)) {
// Forward the pathname to the Route Handler
const api = new URL(
`/api/redirects?pathname=${encodeURIComponent(request.nextUrl.pathname)}`,
request.nextUrl.origin
)
try {
// Fetch redirect data from the Route Handler
const redirectData = await fetch(api)
if (redirectData.ok) {
const redirectEntry: RedirectEntry | undefined =
await redirectData.json()
if (redirectEntry) {
// Determine the status code
const statusCode = redirectEntry.permanent ? 308 : 307
// Redirect to the destination
return NextResponse.redirect(redirectEntry.destination, statusCode)
}
}
} catch (error) {
console.error(error)
}
}
// No redirect found, continue the request without redirecting
return NextResponse.next()
}
然后,在路由处理程序中:
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 })
}
// Get the redirect entry from the redirects.json file
const redirect = (redirects as Record<string, RedirectEntry>)[pathname]
// Account for bloom filter false positives
if (!redirect) {
return new Response('No redirect', { status: 400 })
}
// Return the redirect entry
return NextResponse.json(redirect)
}
需要了解
- 要生成布隆过滤器,您可以使用像
bloom-filters
这样的库。- 您应该验证对路由处理程序发出的请求,以防止恶意请求。
后续步骤
这有帮助吗?