How to implement authentication in Next.js

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

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

身份验证：验证用户是否是他们所声称的身份。它要求用户通过他们所拥有的东西（如用户名和密码）来证明自己的身份。
会话管理：跟踪用户在请求之间的身份验证状态。
授权：决定用户可以访问哪些路由和数据。

下图展示了使用 React 和 Next.js 功能的身份验证流程：

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

身份验证

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

用户通过表单提交他们的凭据。
表单发送由 API 路由处理的请求。
成功验证后，流程完成，表明用户认证成功。
如果验证失败，将显示错误消息。

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

pages/login.tsx

TypeScript

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

TypeScript

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

会话管理

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

有两种类型的会话：

无状态：会话数据（或令牌）存储在浏览器的 cookie 中。Cookie 随每个请求一起发送，允许在服务器上验证会话。这种方法更简单，但如果实现不正确，可能不太安全。
数据库：会话数据存储在数据库中，用户的浏览器只接收加密的会话 ID。这种方法更安全，但可能复杂并使用更多服务器资源。

值得注意的是： 虽然你可以使用任一方法，或两者兼用，但我们建议使用会话管理库，如 iron-session 或 Jose。

无状态会话

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

pages/api/login.ts

TypeScript

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, // 一周
    path: '/',
  })
  res.setHeader('Set-Cookie', cookie)
  res.status(200).json({ message: 'Successfully set cookie!' })
}

数据库会话

要创建和管理数据库会话，你需要按照以下步骤操作：

在数据库中创建一个表来存储会话和数据（或检查你的认证库是否处理这个问题）。
实现插入、更新和删除会话的功能
在存储到用户浏览器之前加密会话 ID，并确保数据库和 cookie 保持同步（这是可选的，但对于在 Middleware 中进行乐观认证检查是推荐的）。

在服务器上创建会话：

pages/api/create-session.ts

TypeScript

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

授权

一旦用户通过认证并创建了会话，你可以实现授权来控制用户在应用程序中可以访问和执行的操作。

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

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

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

创建一个数据访问层来集中你的授权逻辑
使用数据传输对象 (DTO)只返回必要的数据
可选地使用 Middleware 执行乐观检查。

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

在某些情况下，你可能想要使用 Middleware 并根据权限重定向用户：

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

然而，由于 Middleware 在每个路由上运行，包括预取的路由，重要的是只从 cookie 中读取会话（乐观检查），并避免数据库检查以防止性能问题。

例如：

middleware.ts

TypeScript

import { NextRequest, NextResponse } from 'next/server'
import { decrypt } from '@/app/lib/session'
import { cookies } from 'next/headers'
 
// 1. 指定受保护和公共路由
const protectedRoutes = ['/dashboard']
const publicRoutes = ['/login', '/signup', '/']
 
export default async function middleware(req: NextRequest) {
  // 2. 检查当前路由是受保护的还是公共的
  const path = req.nextUrl.pathname
  const isProtectedRoute = protectedRoutes.includes(path)
  const isPublicRoute = publicRoutes.includes(path)
 
  // 3. 从 cookie 中解密会话
  const cookie = (await cookies()).get('session')?.value
  const session = await decrypt(cookie)
 
  // 4. 如果用户未认证，重定向到 /login
  if (isProtectedRoute && !session?.userId) {
    return NextResponse.redirect(new URL('/login', req.nextUrl))
  }
 
  // 5. 如果用户已认证，重定向到 /dashboard
  if (
    isPublicRoute &&
    session?.userId &&
    !req.nextUrl.pathname.startsWith('/dashboard')
  ) {
    return NextResponse.redirect(new URL('/dashboard', req.nextUrl))
  }
 
  return NextResponse.next()
}
 
// Middleware 不应运行的路由
export const config = {
  matcher: ['/((?!api|_next/static|_next/image|.*\\.png$).*)'],
}

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

提示：

在 Middleware 中，你也可以使用 req.cookies.get('session').value 读取 cookie。

Middleware 使用 Edge Runtime，检查你的认证库和会话管理库是否兼容。

你可以在 Middleware 中使用 matcher 属性指定 Middleware 应该在哪些路由上运行。不过，对于认证，建议 Middleware 在所有路由上运行。

创建数据访问层 (DAL)

保护 API 路由

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

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

pages/api/route.ts

TypeScript

import { NextApiRequest, NextApiResponse } from 'next'
 
export default async function handler(
  req: NextApiRequest,
  res: NextApiResponse
) {
  const session = await getSession(req)
 
  // 检查用户是否已认证
  if (!session) {
    res.status(401).json({
      error: '用户未认证',
    })
    return
  }
 
  // 检查用户是否具有"admin"角色
  if (session.user.role !== 'admin') {
    res.status(401).json({
      error: '未授权访问：用户没有管理员权限。',
    })
    return
  }
 
  // 为授权用户继续路由
  // ... API 路由的实现
}

这个示例展示了一个具有两层安全检查的 API 路由，用于认证和授权。它首先检查活动会话，然后验证登录用户是否为"admin"。这种方法确保安全访问，仅限于已认证和已授权的用户，为请求处理维持强大的安全性。