跳到内容
Pages Router指南身份验证

如何在 Next.js 中实现身份验证

了解身份验证对于保护应用程序的数据至关重要。本页面将指导您使用哪些 React 和 Next.js 功能来实现身份验证。

在开始之前，将过程分解为三个概念会很有帮助：

  1. 身份验证：验证用户是否是其自称的身份。它要求用户通过其拥有的东西（例如用户名和密码）来证明其身份。
  2. 会话管理：跨请求跟踪用户的身份验证状态。
  3. 授权：决定用户可以访问哪些路由和数据。

此图显示了使用 React 和 Next.js 功能的身份验证流程

Diagram showing the authentication flow with React and Next.js features

本页面上的示例出于教育目的，介绍了基本的用户名和密码身份验证。虽然您可以实现自定义身份验证解决方案，但为了提高安全性和简化性，我们建议使用身份验证库。这些库提供身份验证、会话管理和授权的内置解决方案，以及社交登录、多因素身份验证和基于角色的访问控制等附加功能。您可以在身份验证库部分找到列表。

身份验证

以下是实现注册和/或登录表单的步骤：

  1. 用户通过表单提交其凭据。
  2. 表单发送由 API 路由处理的请求。
  3. 验证成功后，流程完成，表示用户已成功通过身份验证。
  4. 如果验证不成功，则会显示错误消息。

考虑一个用户可以输入其凭据的登录表单

pages/login.tsx
import { FormEvent } from 'react'
import { useRouter } from 'next/router'
 
export default function LoginPage() {
  const router = useRouter()
 
  async function handleSubmit(event: FormEvent<HTMLFormElement>) {
    event.preventDefault()
 
    const formData = new FormData(event.currentTarget)
    const email = formData.get('email')
    const password = formData.get('password')
 
    const response = await fetch('/api/auth/login', {
      method: 'POST',
      headers: { 'Content-Type': 'application/json' },
      body: JSON.stringify({ email, password }),
    })
 
    if (response.ok) {
      router.push('/profile')
    } else {
      // Handle errors
    }
  }
 
  return (
    <form onSubmit={handleSubmit}>
      <input type="email" name="email" placeholder="Email" required />
      <input type="password" name="password" placeholder="Password" required />
      <button type="submit">Login</button>
    </form>
  )
}

上面的表单有两个输入字段，用于捕获用户的电子邮件和密码。提交时，它会触发一个函数，该函数向 API 路由 (/api/auth/login) 发送 POST 请求。

然后，您可以在 API 路由中调用身份验证提供商的 API 来处理身份验证

pages/api/auth/login.ts
import type { NextApiRequest, NextApiResponse } from 'next'
import { signIn } from '@/auth'
 
export default async function handler(
  req: NextApiRequest,
  res: NextApiResponse
) {
  try {
    const { email, password } = req.body
    await signIn('credentials', { email, password })
 
    res.status(200).json({ success: true })
  } catch (error) {
    if (error.type === 'CredentialsSignin') {
      res.status(401).json({ error: 'Invalid credentials.' })
    } else {
      res.status(500).json({ error: 'Something went wrong.' })
    }
  }
}

会话管理

会话管理可确保用户的身份验证状态在请求之间保持不变。它涉及创建、存储、刷新和删除会话或令牌。

有两种类型的会话：

  1. 无状态：会话数据（或令牌）存储在浏览器的 cookie 中。每次请求都会发送 cookie，从而允许在服务器上验证会话。此方法更简单，但如果实施不正确，安全性可能会降低。
  2. 数据库：会话数据存储在数据库中，用户的浏览器只接收加密的会话 ID。此方法更安全，但可能很复杂并使用更多的服务器资源。

须知：虽然您可以使用其中一种方法或两种方法，但我们建议使用会话管理库，例如 iron-session 或 Jose。

无状态会话

设置和删除 Cookie

您可以使用 API 路由 在服务器上将会话设置为 cookie

pages/api/login.ts
import { serialize } from 'cookie'
import type { NextApiRequest, NextApiResponse } from 'next'
import { encrypt } from '@/app/lib/session'
 
export default function handler(req: NextApiRequest, res: NextApiResponse) {
  const sessionData = req.body
  const encryptedSessionData = encrypt(sessionData)
 
  const cookie = serialize('session', encryptedSessionData, {
    httpOnly: true,
    secure: process.env.NODE_ENV === 'production',
    maxAge: 60 * 60 * 24 * 7, // One week
    path: '/',
  })
  res.setHeader('Set-Cookie', cookie)
  res.status(200).json({ message: 'Successfully set cookie!' })
}

数据库会话

要创建和管理数据库会话，您需要遵循以下步骤：

  1. 在数据库中创建一个表来存储会话和数据（或检查您的身份验证库是否处理此问题）。
  2. 实现插入、更新和删除会话的功能。
  3. 在将会话 ID 存储到用户浏览器之前对其进行加密，并确保数据库和 cookie 保持同步（这是可选的，但建议用于 代理 中的乐观身份验证检查）。

在服务器上创建会话:

pages/api/create-session.ts
import db from '../../lib/db'
import type { NextApiRequest, NextApiResponse } from 'next'
 
export default async function handler(
  req: NextApiRequest,
  res: NextApiResponse
) {
  try {
    const user = req.body
    const sessionId = generateSessionId()
    await db.insertSession({
      sessionId,
      userId: user.id,
      createdAt: new Date(),
    })
 
    res.status(200).json({ sessionId })
  } catch (error) {
    res.status(500).json({ error: 'Internal Server Error' })
  }
}

授权

用户通过身份验证并创建会话后，您可以实施授权来控制用户在应用程序中可以访问和执行的操作。

有两种主要的授权检查类型：

  1. 乐观：使用存储在 cookie 中的会话数据检查用户是否被授权访问路由或执行操作。这些检查对于快速操作非常有用，例如显示/隐藏 UI 元素或根据权限或角色重定向用户。
  2. 安全：使用存储在数据库中的会话数据检查用户是否被授权访问路由或执行操作。这些检查更安全，用于需要访问敏感数据或操作的操作。

对于这两种情况，我们建议：

使用代理进行乐观检查（可选）

在某些情况下，您可能希望使用 代理 并根据权限重定向用户

  • 执行乐观检查。由于代理在每个路由上运行，因此它是集中重定向逻辑和预过滤未经授权用户的好方法。
  • 保护在用户之间共享数据的静态路由（例如，付费内容）。

但是，由于代理在所有路由（包括 预取 路由）上运行，因此只从 cookie 中读取会话（乐观检查）非常重要，并且避免数据库检查以防止性能问题。

例如

proxy.ts
import { NextRequest, NextResponse } from 'next/server'
import { decrypt } from '@/app/lib/session'
import { cookies } from 'next/headers'
 
// 1. Specify protected and public routes
const protectedRoutes = ['/dashboard']
const publicRoutes = ['/login', '/signup', '/']
 
export default async function proxy(req: NextRequest) {
  // 2. Check if the current route is protected or public
  const path = req.nextUrl.pathname
  const isProtectedRoute = protectedRoutes.includes(path)
  const isPublicRoute = publicRoutes.includes(path)
 
  // 3. Decrypt the session from the cookie
  const cookie = (await cookies()).get('session')?.value
  const session = await decrypt(cookie)
 
  // 4. Redirect to /login if the user is not authenticated
  if (isProtectedRoute && !session?.userId) {
    return NextResponse.redirect(new URL('/login', req.nextUrl))
  }
 
  // 5. Redirect to /dashboard if the user is authenticated
  if (
    isPublicRoute &&
    session?.userId &&
    !req.nextUrl.pathname.startsWith('/dashboard')
  ) {
    return NextResponse.redirect(new URL('/dashboard', req.nextUrl))
  }
 
  return NextResponse.next()
}
 
// Routes Proxy should not run on
export const config = {
  matcher: ['/((?!api|_next/static|_next/image|.*\\.png$).*)'],
}

虽然代理对初始检查很有用，但它不应该是保护数据的唯一防线。大多数安全检查应尽可能靠近数据源执行，有关更多信息，请参阅 数据访问层。

提示:

  • 在代理中，您还可以使用 req.cookies.get('session').value 读取 cookie。
  • 代理使用 边缘运行时，请检查您的身份验证库和会话管理库是否兼容。
  • 您可以使用代理中的 matcher 属性来指定代理应在哪些路由上运行。尽管对于身份验证，建议代理在所有路由上运行。

创建数据访问层 (DAL)

保护 API 路由

Next.js 中的 API 路由对于处理服务器端逻辑和数据管理至关重要。保护这些路由以确保只有授权用户才能访问特定功能至关重要。这通常涉及验证用户的身份验证状态及其基于角色的权限。

以下是保护 API 路由的示例：

pages/api/route.ts
import { NextApiRequest, NextApiResponse } from 'next'
 
export default async function handler(
  req: NextApiRequest,
  res: NextApiResponse
) {
  const session = await getSession(req)
 
  // Check if the user is authenticated
  if (!session) {
    res.status(401).json({
      error: 'User is not authenticated',
    })
    return
  }
 
  // Check if the user has the 'admin' role
  if (session.user.role !== 'admin') {
    res.status(401).json({
      error: 'Unauthorized access: User does not have admin privileges.',
    })
    return
  }
 
  // Proceed with the route for authorized users
  // ... implementation of the API Route
}

此示例演示了具有身份验证和授权双层安全检查的 API 路由。它首先检查活动会话，然后验证登录用户是否为“管理员”。这种方法确保了安全访问，仅限于经过身份验证和授权的用户，从而为请求处理维护了强大的安全性。

资源

现在您已经了解了 Next.js 中的身份验证，以下是 Next.js 兼容的库和资源，可帮助您实现安全的身份验证和会话管理：

身份验证库

会话管理库

延伸阅读

要继续学习身份验证和安全性，请查看以下资源：