forbidden
forbidden 函数会抛出一个错误，渲染 Next.js 403 错误页面。它在处理应用程序的授权错误时很有用。你可以使用 forbidden.js 文件 自定义 UI。
要开始使用 forbidden，需要在 next.config.js 文件中启用实验性的 authInterrupts 配置选项：
next.config.ts
TypeScript
import type { NextConfig } from 'next'
const nextConfig: NextConfig = {
experimental: {
authInterrupts: true,
},
}
export default nextConfigforbidden 可以在 Server Components、Server Actions 和 Route Handlers 中调用。
app/auth/page.tsx
TypeScript
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函数不能在 根布局 中调用。
示例
基于角色的路由保护
你可以使用 forbidden 根据用户角色限制对特定路由的访问。这确保了已认证但缺乏所需权限的用户无法访问该路由。
app/admin/page.tsx
TypeScript
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 进行数据修改
在实现 Server Actions 的数据修改时，你可以使用 forbidden 来仅允许具有特定角色的用户更新敏感数据。
app/actions/update-role.ts
TypeScript
'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 引入。 |