unauthorized

unauthorized 函数抛出一个错误，渲染 Next.js 401 错误页面。它对于处理应用程序中的授权错误很有用。你可以使用 unauthorized.js 文件 自定义 UI。

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

TypeScript

next.config.ts

import type { NextConfig } from 'next'

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

export default nextConfig

JavaScript

next.config.js

module.exports = {
  experimental: {
    authInterrupts: true,
  },
}

unauthorized 可以在 服务端组件、服务器操作 和 路由处理器 中调用。

TypeScript

app/dashboard/page.tsx

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

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

  if (!session) {
    unauthorized()
  }

  // 为已认证用户渲染仪表板
  return (
    <main>
      <h1>Welcome to the Dashboard</h1>
      <p>Hi, {session.user.name}.</p>
    </main>
  )
}

JavaScript

app/dashboard/page.js

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

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

  if (!session) {
    unauthorized()
  }

  // 为已认证用户渲染仪表板
  return (
    <main>
      <h1>欢迎来到仪表板</h1>
      <p>你好，{session.user.name}.</p>
    </main>
  )
}

提示

• unauthorized 函数不能在 根布局 中调用。

示例

向未认证用户显示登录 UI

你可以使用 unauthorized 函数显示带有登录 UI 的 unauthorized.js 文件。

TypeScript

app/dashboard/page.tsx

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

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

  if (!session) {
    unauthorized()
  }

  return <div>Dashboard</div>
}

JavaScript

app/dashboard/page.js

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

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

  if (!session) {
    unauthorized()
  }

  return <div>Dashboard</div>
}

TypeScript

app/unauthorized.tsx

import Login from '@/app/components/Login'

export default function UnauthorizedPage() {
  return (
    <main>
      <h1>401 - Unauthorized</h1>
      <p>请登录以访问此页面。</p>
      <Login />
    </main>
  )
}

JavaScript

app/unauthorized.js

import Login from '@/app/components/Login'

export default function UnauthorizedPage() {
  return (
    <main>
      <h1>401 - Unauthorized</h1>
      <p>请登录以访问此页面。</p>
      <Login />
    </main>
  )
}

使用服务器操作进行变更

你可以在服务器操作中调用 unauthorized 以确保只有已认证的用户才能执行特定的变更。

TypeScript

app/actions/update-profile.ts

'use server'

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

export async function updateProfile(data: FormData) {
  const session = await verifySession()

  // 如果用户未认证，返回 401
  if (!session) {
    unauthorized()
  }

  // 继续执行变更
  // ...
}

JavaScript

app/actions/update-profile.js

'use server'

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

export async function updateProfile(data) {
  const session = await verifySession()

  // 如果用户未认证，返回 401
  if (!session) {
    unauthorized()
  }

  // 继续执行变更
  // ...
}

使用路由处理器获取数据

你可以在路由处理器中使用 unauthorized 以确保只有已认证的用户才能访问端点。

TypeScript

app/api/profile/route.ts

import { NextRequest, NextResponse } from 'next/server'
import { verifySession } from '@/app/lib/dal'
import { unauthorized } from 'next/navigation'

export async function GET(req: NextRequest): Promise<NextResponse> {
  // 验证用户的会话
  const session = await verifySession()

  // 如果不存在会话，返回 401 并渲染 unauthorized.tsx
  if (!session) {
    unauthorized()
  }

  // 获取数据
  // ...
}

JavaScript

app/api/profile/route.js

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

export async function GET() {
  const session = await verifySession()

  // 如果用户未认证，返回 401 并渲染 unauthorized.tsx
  if (!session) {
    unauthorized()
  }

  // 获取数据
  // ...
}

版本历史

版本	更改
v15.1.0	引入了 unauthorized。