logoNext.js 简体中文
文档博客学习
简介/指南/重定向

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

Next.js 提供了多种处理重定向的方式。本文将介绍每种可用选项、适用场景以及如何管理大量重定向规则。

API用途使用场景状态码
useRouter执行客户端导航组件不适用
redirects in next.config.js基于路径重定向传入请求next.config.js 文件307 (临时) 或 308 (永久)
NextResponse.redirect基于条件重定向传入请求中间件任意状态码

useRouter() 钩子

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

import { useRouter } from 'next/router'

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

  return (
    <button type="button" onClick={() => router.push('/dashboard')}>
      仪表盘
    </button>
  )
}
import { useRouter } from 'next/router'

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

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

须知:

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

更多信息请参阅 useRouter API 参考文档。

next.config.js 中的 redirects 配置

next.config.js 文件中的 redirects 选项允许你将传入请求路径重定向到不同目标路径。这在修改页面 URL 结构或需要预定义重定向列表时非常有用。

redirects 支持路径匹配、请求头、Cookie 和查询参数匹配，可根据传入请求灵活重定向用户。

使用示例：

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

更多信息请参阅 redirects API 参考文档。

须知:

  • 通过 permanent 选项可返回 307 (临时重定向) 或 308 (永久重定向) 状态码。
  • 某些平台可能限制重定向数量（如 Vercel 限制 1024 条）。如需管理大量重定向（1000+），建议使用中间件创建自定义方案。详见大规模重定向管理。
  • redirects 会在中间件之前执行。

中间件中的 NextResponse.redirect

中间件允许你在请求完成前运行代码，然后根据传入请求使用 NextResponse.redirect 重定向到不同 URL。这适用于基于条件（如认证、会话管理等）重定向用户或需要管理大量重定向的场景。

例如，用户未认证时跳转到登录页：

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*',
}
import { NextResponse } from 'next/server'
import { authenticate } from 'auth-provider'

export function middleware(request) {
  const isAuthenticated = authenticate(request)

  // 用户已认证则继续
  if (isAuthenticated) {
    return NextResponse.next()
  }

  // 未认证则跳转到登录页
  return NextResponse.redirect(new URL('/login', request.url))
}

export const config = {
  matcher: '/dashboard/:path*',
}

须知:

  • 中间件在 next.config.js 的 redirects 之后执行，在页面渲染之前运行。

更多信息请参阅中间件文档。

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

要管理大量重定向（1000+），可考虑使用中间件创建自定义方案，无需重新部署应用即可编程式处理重定向。

实现时需考虑：

  1. 创建并存储重定向映射表
  2. 优化数据查询性能

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)
  }

  // 未找到重定向规则，继续处理
  return NextResponse.next()
}
import { NextResponse } from 'next/server'
import { get } from '@vercel/edge-config'

export async function middleware(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. 优化数据查询性能

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

  • 使用针对快速读取优化的数据库
  • 采用 布隆过滤器 (Bloom filter) 等数据查询策略，在读取大型重定向文件或数据库之前高效检查重定向是否存在

参考前文示例，您可以将生成的布隆过滤器文件导入中间件 (Middleware)，然后检查传入请求路径是否存在于布隆过滤器中。

如果存在，则将请求转发至 API 路由 (API Routes)，该处理器将检查实际文件并将用户重定向到相应 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
}

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

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

  // 检查路径是否在布隆过滤器中
  if (bloomFilter.has(pathname)) {
    // 将路径转发给路由处理器
    const api = new URL(
      `/api/redirects?pathname=${encodeURIComponent(request.nextUrl.pathname)}`,
      request.nextUrl.origin
    )

    try {
      // 从路由处理器获取重定向数据
      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()
}
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 middleware(request) {
  // 获取传入请求的路径
  const pathname = request.nextUrl.pathname

  // 检查路径是否在布隆过滤器中
  if (bloomFilter.has(pathname)) {
    // 将路径转发给路由处理器
    const api = new URL(
      `/api/redirects?pathname=${encodeURIComponent(request.nextUrl.pathname)}`,
      request.nextUrl.origin
    )

    try {
      // 从路由处理器获取重定向数据
      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()
}

然后在 API 路由中：

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)
}
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 等库
  • 应验证对路由处理器的请求以防止恶意请求

生产环境

在将 Next.js 应用投入生产环境前，确保最佳性能和用户体验的推荐实践。

Sass

学习如何在你的 Next.js 应用中使用 Sass。