Wasp 认证实战:用用户名密码为 TodoApp 添加完整用户体系 Wasp 认证实战用用户名密码为 TodoApp 添加完整用户体系【免费下载链接】waspThe batteries-included full-stack framework for the AI era. Develop JS/TS web apps (React, Node.js, and Prisma) using declarative code that abstracts away complex full-stack features like auth, background jobs, RPC, email sending, end-to-end type safety, single-command deployment, and more.项目地址: https://gitcode.com/GitHub_Trending/wa/wasp本篇指南以 Wasp 官方教程web/versioned_docs/version-0.18/tutorial/07-auth.md为主线完整讲解如何为 Wasp 应用接入用户名 密码的一站式认证从数据建模、配置声明、登录注册页面到页面级访问控制、按用户隔离数据的 Queries/Actions以及登出功能。读完你将掌握 Waspauth配置块的每一个字段、authRequired与context.user的底层工作原理并能直接照搬到自己的多用户应用中。Wasp 将认证做成了框架的一等公民你不需要手写密码哈希、会话管理、JWT 中间件或表单校验只需在配置里声明“我要用哪种认证方式”Wasp 就会在代码生成阶段为你产出完整的认证后端与可用的 UI 组件。本文结合仓库中完整的 TodoApp 示例examples/tutorials/TodoApp与生成器模板源码waspc/data/Generator/templates逐层拆解认证的接入步骤与底层实现。接入认证前的任务清单要让应用拥有用户体系需要依次完成以下工作创建User实体Entity。在 Wasp 配置中启用Username and Password认证。添加登录login与注册signup页面。将主页面设为需要认证authRequired。在User与Task实体之间建立关联。修改 Queries 与 Actions让用户只能看到和修改自己的任务。添加登出logout按钮。注意一个版本差异本教程文档v0.18使用的是经典.wasp声明文件语法app TodoApp { ... }而当前仓库中的完整示例已升级为 TypeScript spec 新语法examples/tutorials/TodoApp/main.wasp.ts声明wasp: { version: 0.26.0 }。两者的声明内容是等价的下文会同时给出两种写法方便对照。第一步创建 User 实体Wasp 负责管理认证本身因此认证相关的实体如Auth、AuthIdentity、Session会由 Wasp 在后台自动创建你完全不需要手动维护。你只需要定义一个User实体用来记录“哪条任务属于哪个用户”// ... model User { id Int id default(autoincrement()) }在仓库的完整示例中这个实体定义在 examples/tutorials/TodoApp/schema.prisma数据源使用 SQLiteprovider sqliteURL 取自DATABASE_URL环境变量并保留了 Wasp 要求的prisma-client-jsgenerator。第二步在 Wasp 中启用认证接下来在 Wasp 配置中声明全栈认证。经典.wasp语法如下app TodoApp { wasp: { version: {latestWaspVersion} }, title: TodoApp, head: [ link relicon href/favicon.ico /, ], auth: { // Tells Wasp which entity to use for storing users. userEntity: User, methods: { // Enable username and password auth. usernameAndPassword: {} }, // Well see how this is used in a bit. onAuthFailedRedirectTo: /login } }等价的新版 TypeScript spec 写法见 examples/tutorials/TodoApp/main.wasp.tsimport { action, app, page, query, route } from wasp.sh/spec; export default app({ name: TodoApp, wasp: { version: 0.26.0 }, title: TodoApp, head: [link relicon href/favicon.ico /], auth: { userEntity: User, methods: { usernameAndPassword: {}, }, onAuthFailedRedirectTo: /login, }, spec: [ route(RootRoute, /, page(MainPage, { authRequired: true })), route(SignupRoute, /signup, page(SignupPage)), route(LoginRoute, /login, page(LoginPage)), query(getTasks, { entities: [Task] }), action(createTask, { entities: [Task] }), action(updateTask, { entities: [Task] }), ], });auth配置块中的三个字段含义如下字段作用本示例取值userEntity指定用于存储用户的实体Wasp 会把它与自动生成的Auth实体关联起来Usermethods启用哪些认证方式usernameAndPassword: {}表示开启用户名密码登录{ usernameAndPassword: {} }onAuthFailedRedirectTo未认证用户访问受保护页面时重定向到的路径/loginWasp 还支持 Google、GitHub、email 等更多认证方式配置方法是在methods中相应扩展。认证底层涉及的概念Auth、AuthIdentity、Session等实体可以参考认证实体文档。迁移数据库修改配置后必须更新数据库结构wasp db migrate-dev执行这一步之后Wasp 会自动为你生成以下能力这正是“声明式认证”的核心价值带登录、注册表单的 Auth UI一个logout()action一个 React 钩子useAuth()供 Queries 和 Actions 使用的context.user。底层机制Wasp 是如何“无中生有”实现认证的从生成器模板源码可以看到这些能力并非黑魔法而是由 Wasp 在构建时生成的真实代码登录处理模板 waspc/data/Generator/templates/server/src/auth/providers/username/login.ts 展示了用户名密码登录的完整流程——先用createProviderId(username, fields.username)构造提供商 ID再通过findAuthIdentity查找AuthIdentity用verifyPassword校验密码哈希失败统一抛出createInvalidCredentialsError()避免泄露“用户是否存在”这类信息校验通过后调用createSession创建会话并执行登录前后钩子。密码安全存储模板 waspc/data/Generator/templates/sdk/wasp/server/auth/utils.ts 中的sanitizeAndSerializeProviderData/ensurePasswordIsHashed负责在写入数据库前对密码做哈希处理hashPasswordproviderData以 JSON 序列化字符串保存在AuthIdentity上重复注册同一用户名时会触发 Prisma 唯一约束错误P2002被转换为 422HttpError。会话中间件模板 waspc/data/Generator/templates/sdk/wasp/server/core/auth.ts 是认证中间件——请求携带Authorization头时通过getSessionAndUserFromBearerToken解析会话并注入req.user/req.sessionId没有 token 的请求会放行由具体操作自行决定是否校验对应代码中context.user可能为null的情况。第三步添加登录与注册页面表单由 Wasp 自动生成我们只需声明承载它们的页面。在.wasp文件中定义路由与页面// ... route SignupRoute { path: /signup, to: SignupPage } page SignupPage { component: import { SignupPage } from src/SignupPage } route LoginRoute { path: /login, to: LoginPage } page LoginPage { component: import { LoginPage } from src/LoginPage }新版 spec 语法则在spec数组中追加两条路由见 examples/tutorials/TodoApp/main.wasp.tsroute(SignupRoute, /signup, page(SignupPage)), route(LoginRoute, /login, page(LoginPage)),页面的 React 实现TS 版与仓库中 examples/tutorials/TodoApp/src/LoginPage.jsx 和 examples/tutorials/TodoApp/src/SignupPage.jsx 一一对应import { Link } from react-router-dom import { LoginForm } from wasp/client/auth export const LoginPage () { return ( div style{{ maxWidth: 400px, margin: 0 auto }} LoginForm / br / span I dont have an account yet (Link to/signupgo to signup/Link). /span /div ) }注册页与之几乎相同只是换成SignupForm并链接到/loginimport { Link } from react-router-dom import { SignupForm } from wasp/client/auth export const SignupPage () { return ( div style{{ maxWidth: 400px, margin: 0 auto }} SignupForm / br / span I already have an account (Link to/logingo to login/Link). /span /div ) }LoginForm和SignupForm均从wasp/client/auth导入它们是 Wasp 生成的、与所选认证方式匹配的现成表单组件。如果你使用 TypeScript还可以用 Wasp 的类型安全Link组件与routes对象替代字符串路径详见类型安全链接文档。第四步让主页面要求认证我们不希望未登录用户访问主页面他们无法创建任务因此把主页面设为私有// ... page MainPage { authRequired: true, component: import { MainPage } from src/MainPage }新版 spec 语法中对应为route(RootRoute, /, page(MainPage, { authRequired: true })),设置authRequired: true后未认证用户会被重定向到onAuthFailedRedirectTo指定的/login同时页面的 React 组件会额外获得一个userpropimport type { AuthUser } from wasp/auth export const MainPage ({ user }: { user: AuthUser }) { // Do something with the user // ... }authRequired 的实现原理authRequired之所以生效是因为 Wasp 在生成代码时用包装组件包裹了你的页面。模板 waspc/data/Generator/templates/sdk/wasp/client/app/pages/createAuthRequiredPage.jsx 展示了它的完整逻辑通过useAuth()读取当前用户与加载状态状态为success且user存在时把user作为 prop 渲染原始页面user为空时渲染Navigate to{onAuthFailedRedirectTo} replace /实现重定向到登录页加载中显示全屏Loader出错则显示错误提示组件。也就是说“页面受保护 自动重定向 自动注入 user”三者是由这一层包装统一完成的。验证注册用户并观察数据库现在可以测试了访问应用主页面/会被重定向到/login进入注册页创建一个账号后会回到主页面并看到 Todo 列表。接着用 Prisma Studio 查看数据库wasp db studio你会看到数据库中除了Task之外多了User表同时还能看到Auth、AuthIdentity、Session这些 Wasp 自动创建的内置模型——它们正是密码哈希与登录会话的载体教程阶段你无需关心其内部结构好奇的话可以阅读认证实体文档。不过此时有个问题换不同的用户登录并创建任务所有用户看到的是同一份任务列表。这是因为我们还没有把 Queries/Actions 改成按用户隔离数据。这正是下一步要做的。第五步定义 User 与 Task 的关联先建立用户与任务的一对多关系Prisma 标准的关系声明此处不复述其通用规则直接看本项目的写法// ... model User { id Int id default(autoincrement()) tasks Task[] } model Task { id Int id default(autoincrement()) description String isDone Boolean default(false) user User? relation(fields: [userId], references: [id]) userId Int? }完整定义见 examples/tutorials/TodoApp/schema.prisma。修改实体后照例需要迁移数据库wasp db migrate-dev关于user与userId的?可选标记教程特意让这两个字段可选以便保留数据库中已有的、尚未分配用户的旧任务。但这在真实项目中并不推荐——它允许出现“不属于任何人的任务”这种异常状态。正确做法是写一次数据迁移来处理存量任务哪怕只是全部删除本教程为了简洁才选择可空字段。第六步让操作校验认证并隔离用户数据接下来改造getTasks查询与createTask/updateTask两个 action一方面拒绝未认证请求另一方面只操作当前登录用户的任务。import type { Task } from wasp/entities import { HttpError } from wasp/server import type { GetTasks } from wasp/server/operations export const getTasks: GetTasksvoid, Task[] async (args, context) { if (!context.user) { throw new HttpError(401) } return context.entities.Task.findMany({ where: { user: { id: context.user.id } }, orderBy: { id: asc }, }) }import type { Task } from wasp/entities import { HttpError } from wasp/server import type { CreateTask, UpdateTask } from wasp/server/operations type CreateTaskPayload PickTask, description export const createTask: CreateTaskCreateTaskPayload, Task async ( args, context ) { if (!context.user) { throw new HttpError(401) } return context.entities.Task.create({ data: { description: args.description, user: { connect: { id: context.user.id } }, }, }) } type UpdateTaskPayload PickTask, id | isDone export const updateTask: UpdateTask UpdateTaskPayload, { count: number } async (args, context) { if (!context.user) { throw new HttpError(401) } return context.entities.Task.updateMany({ where: { id: args.id, user: { id: context.user.id } }, data: { isDone: args.isDone }, }) }仓库中的完整 JS 版本见 examples/tutorials/TodoApp/src/queries.js 与 examples/tutorials/TodoApp/src/actions.js。要点解读context.user与 401context.user由认证中间件server/core/auth.ts注入未登录时它为null此时抛出HttpError(401)拒绝访问。HttpError从wasp/server导入。查询隔离findMany的where中加user: { id: context.user.id }确保只能查到自己的任务。创建归属createTask通过user: { connect: { id: context.user.id } }把新任务挂到当前用户名下。为什么用updateMany由于 Prisma 的限制update不允许在where中指定关联字段user.id所以updateTask改用updateMany并用id加user.id双重条件保证只能更新自己的任务。updateMany返回{ count }这也是其返回类型被声明为{ count: number }的原因。完成这些改动后每个用户都拥有彼此不可见的独立任务列表。可以用wasp db studio多建几个用户和任务验证第七步添加登出按钮最后加上登出功能让用户能退出登录// ... import { logout } from wasp/client/auth // ... const MainPage () { // ... return ( div {/* ... */} button onClick{logout}Logout/button /div ) }logout从wasp/client/auth导入是由 Wasp 生成、随认证系统一起就绪的 action。完整页面含任务列表、创建表单与登出按钮见 examples/tutorials/TodoApp/src/MainPage.jsx。至此一个可用的认证系统已完整落地TodoApp 正式成为多用户应用注册、登录、受保护页面、按用户隔离的数据、登出全部由声明式配置 少量业务代码驱动。小结与后续方向回顾整个接入过程Wasp 认证的核心心法是“声明而非实现”你只需定义User实体、声明auth配置、放置两个页面组件密码哈希、会话、中间件、表单 UI 便全部由代码生成器产出可在 waspc/data/Generator/templates 中看到这些生成产物的模板源码。在数据层面authRequired对应 createAuthRequiredPage.jsx 的包装组件context.user对应 server/core/auth.ts 的会话解析中间件密码安全与登录流程对应 server/auth/utils.ts 与 username/login.ts。下一步可以探索的方向使用 Starter Templates 快速启动新项目用 Web Sockets 把应用改造成实时应用参考认证概览了解 OAuth、邮箱等其他认证方式以及useAuth()等更多客户端 API 的细节。【免费下载链接】waspThe batteries-included full-stack framework for the AI era. Develop JS/TS web apps (React, Node.js, and Prisma) using declarative code that abstracts away complex full-stack features like auth, background jobs, RPC, email sending, end-to-end type safety, single-command deployment, and more.项目地址: https://gitcode.com/GitHub_Trending/wa/wasp创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考