会话和认证
简介
在本教程中，我们将使用 Nuxt Auth Utils在全栈 Nuxt 应用程序中设置认证，该模块提供了管理客户端和服务器端会话数据的便捷实用程序。
该模块使用安全和密封的 cookie 来存储会话数据，因此您不需要设置数据库来存储会话数据。
安装 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 使用密封的 cookie 来存储会话数据，会话 cookie 使用来自 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.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({
status: 401,
message: 'Bad credentials',
})
})
zod 依赖项（npm i zod）。登录页面
该模块暴露了一个 Vue 组合式函数，用于了解用户在我们的应用程序中是否已通过认证：
<script setup>
const { loggedIn, session, user, clear, fetch } = useUserSession()
</script>
让我们创建一个登录页面，其中包含一个表单，用于将登录数据提交到我们的 /api/login 路由。
<script setup lang="ts">
const { loggedIn, user, fetch: refreshSession } = useUserSession()
const credentials = reactive({
email: '',
password: '',
})
async function login () {
try {
await $fetch('/api/login', {
method: 'POST',
body: credentials,
})
// 在客户端刷新会话并重定向到主页
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 应用程序的完整示例。