会话和认证
认证是 Web 应用中非常常见的需求。本教程将向您展示如何在 Nuxt 应用中实现基本的用户注册和认证。
介绍
在本教程中，我们将使用 Nuxt Auth Utils 在全栈 Nuxt 应用中设置认证，该工具提供了方便的实用程序来管理客户端和服务器端的会话数据。
该模块使用安全和加密的 cookies 来存储会话数据，因此您无需设置数据库来存储会话数据。
安装 nuxt-auth-utils
使用 nuxt CLI 安装 nuxt-auth-utils 模块。
npx nuxt module add auth-utils
此命令将 nuxt-auth-utils 作为依赖项安装，并将其添加到我们的 nuxt.config.ts 的 modules 部分。
Cookie 加密密钥
由于 nuxt-auth-utils 使用加密的 cookies 来存储会话数据，会话 cookies 使用来自 NUXT_SESSION_PASSWORD 环境变量的密钥进行加密。
如果未设置，当在开发模式下运行时，此环境变量将自动添加到您的 .env 文件中。
NUXT_SESSION_PASSWORD=a-random-password-with-at-least-32-characters
在部署之前，您需要将此环境变量添加到生产环境中。
登录 API 路由
在本教程中，我们将创建一个简单的 API 路由，以基于静态数据登录用户。
让我们创建一个 /api/login API 路由，该路由将接受包含请求正文中电子邮件和密码的 POST 请求。
import { z } from 'zod'
const bodySchema = z.object({
email: z.string().email(),
password: z.string().min(8)
})
export default defineEventHandler(async (event) => {
const { email, password } = await readValidatedBody(event, bodySchema.parse)
if (email === 'admin@admin.com' && password === 'iamtheadmin') {
// 在 cookie 中设置用户会话
// 此服务器实用程序由 auth-utils 模块自动导入
await setUserSession(event, {
user: {
name: 'John Doe'
}
})
return {}
}
throw createError({
statusCode: 401,
message: 'Bad credentials'
})
})
确保在您的项目中安装 zod 依赖项（npm i zod）。
阅读更多关于 nuxt-auth-utils 提供的 setUserSession 服务器助手的信息。
登录页面
该模块公开了一个 Vue 可组合对象，用于判断用户是否在我们的应用中认证：
const { loggedIn, session, user, clear, fetch } = useUserSession()让我们创建一个登录页面，其中包含一个表单，用于将登录数据提交到我们的 /api/login 路由。
<script setup lang="ts">
const { loggedIn, user, fetch: refreshSession } = useUserSession()
const credentials = reactive({
email: '',
password: '',
})
async function login() {
$fetch('/api/login', {
method: 'POST',
body: credentials
})
.then(async () => {
// 刷新客户端会话并重定向到主页
await refreshSession()
await navigateTo('/')
})
.catch(() => alert('Bad credentials'))
}
</script>
<template>
<form @submit.prevent="login">
<input v-model="credentials.email" type="email" placeholder="Email" />
<input v-model="credentials.password" type="password" placeholder="Password" />
<button type="submit">Login</button>
</form>
</template>
保护 API 路由
保护服务器路由是确保数据安全的关键。客户端中间件对用户有帮助，但如果没有服务器端保护，您的数据仍然可以被访问。保护任何包含敏感数据的路由是至关重要的，如果用户未登录，我们应该返回 401 错误。
auth-utils 模块提供了 requireUserSession 实用函数，以帮助确保用户已登录并拥有活动会话。
让我们创建一个 /api/user/stats 路由示例，只有经过认证的用户才能访问。
export default defineEventHandler(async (event) => {
// 确保用户已登录
// 如果请求不是来自有效的用户会话，这将抛出 401 错误
const { user } = await requireUserSession(event)
// TODO: 根据用户获取一些统计数据
return {}
});
保护应用路由
我们的数据通过服务器端路由得到了保护，但如果不采取其他措施，未认证的用户在尝试访问 /users 页面时可能会得到一些奇怪的数据。我们应该创建一个 客户端中间件 来保护客户端的路由，并将用户重定向到登录页面。
nuxt-auth-utils 提供了一个方便的 useUserSession 可组合对象，我们将使用它来检查用户是否已登录，如果没有，则重定向他们。
我们将在 /middleware 目录中创建一个中间件。与服务器不同，客户端中间件不会自动应用于所有端点，我们需要指定应用的位置。
export default defineNuxtRouteMiddleware(() => {
const { loggedIn } = useUserSession()
// 如果用户未认证，则将其重定向到登录屏幕
if (!loggedIn.value) {
return navigateTo('/login')
}
})
主页
现在我们有了保护路由的应用中间件，我们可以在显示认证用户信息的主页上使用它。如果用户未认证，他们将被重定向到登录页面。
我们将使用 definePageMeta 将中间件应用于我们想要保护的路由。
<script setup lang="ts">
definePageMeta({
middleware: ['authenticated'],
})
const { user, clear: clearSession } = useUserSession()
async function logout() {
await clearSession()
await navigateTo('/login')
}
</script>
<template>
<div>
<h1>Welcome {{ user.name }}</h1>
<button @click="logout">Logout</button>
</div>
</template>
我们还添加了一个注销按钮，以清除会话并将用户重定向到登录页面。
结论
我们已经成功地在 Nuxt 应用中设置了非常基本的用户认证和会话管理。我们还保护了服务器和客户端的敏感路由，以确保只有经过认证的用户才能访问它们。
接下来的步骤，您可以：
- 使用 20+ 支持的 OAuth 提供商 添加认证
- 添加数据库以存储用户，参见 Nitro SQL 数据库 或 NuxtHub SQL 数据库
- 使用 密码哈希 让用户通过电子邮件和密码注册
- 添加对 WebAuthn / Passkeys 的支持
查看开源的 atidone 仓库，以获取包含 OAuth 认证、数据库和 CRUD 操作的完整 Nuxt 应用示例。
※此页面是 Nuxt.js 官方文档的非官方翻译页面。