forbidden

forbidden 函数会抛出一个错误，渲染 Next.js 的 403 错误页面。该函数可用于处理应用程序中的授权错误。您可以通过 forbidden.js 文件自定义 UI。

要开始使用 forbidden，请在 next.config.js 文件中启用实验性的 authInterrupts 配置选项：

import type { NextConfig } from 'next'

const nextConfig: NextConfig = {
  experimental: {
    authInterrupts: true,
  },
}

export default nextConfig

forbidden 可以在以下场景中调用：服务端组件 (Server Components)、服务端操作 (Server Actions) 和路由处理器 (Route Handlers)。

import { verifySession } from '@/app/lib/dal'
import { forbidden } from 'next/navigation'

export default async function AdminPage() {
  const session = await verifySession()

  // 检查用户是否具有 'admin' 角色
  if (session.role !== 'admin') {
    forbidden()
  }

  // 为授权用户渲染管理页面
  return <></>
}

注意事项

forbidden 函数不能在根布局 (root layout) 中调用。

示例

基于角色的路由保护

您可以使用 forbidden 根据用户角色限制对某些路由的访问。这确保已认证但缺少必要权限的用户无法访问该路由。

import { verifySession } from '@/app/lib/dal'
import { forbidden } from 'next/navigation'

export default async function AdminPage() {
  const session = await verifySession()

  // 检查用户是否具有 'admin' 角色
  if (session.role !== 'admin') {
    forbidden()
  }

  // 为授权用户渲染管理页面
  return (
    <main>
      <h1>管理员仪表盘</h1>
      <p>欢迎, {session.user.name}!</p>
    </main>
  )
}

与服务端操作 (Server Actions) 结合使用

在实现服务端操作中的变更时，您可以使用 forbidden 仅允许具有特定角色的用户更新敏感数据。

'use server'

import { verifySession } from '@/app/lib/dal'
import { forbidden } from 'next/navigation'
import db from '@/app/lib/db'

export async function updateRole(formData: FormData) {
  const session = await verifySession()

  // 确保只有管理员可以更新角色
  if (session.role !== 'admin') {
    forbidden()
  }

  // 为授权用户执行角色更新
  // ...
}

版本历史

版本	变更说明
`v15.1.0`	引入 `forbidden` 函数。

forbidden.js

关于 forbidden.js 特殊文件的 API 参考文档。

注意事项

示例

基于角色的路由保护

与服务端操作 (Server Actions) 结合使用

版本历史

forbidden.js

On this page