Prisma tRPC Generator高级用法自定义中间件与tRPC Shield集成【免费下载链接】prisma-trpc-generatorPrisma 2 generator to emit fully implemented tRPC routers项目地址: https://gitcode.com/gh_mirrors/pr/prisma-trpc-generatorPrisma tRPC Generator是一个强大的工具能够从Prisma schema自动生成完全实现的类型安全tRPC路由器。这个工具不仅提供基本的CRUD操作还支持高级功能如自定义中间件和tRPC Shield权限集成让你的API开发效率提升数倍。本文将深入探讨如何利用这些高级功能构建更安全、更灵活的tRPC API。 为什么需要高级功能在真实的应用程序中简单的CRUD操作往往无法满足需求。你通常需要身份验证确保只有授权用户能访问特定端点权限控制基于用户角色限制操作权限请求日志追踪和调试API调用数据验证确保输入数据符合业务规则性能监控测量响应时间和资源使用Prisma tRPC Generator通过灵活的配置选项让你可以轻松集成这些功能而无需手动编写大量样板代码。⚙️ 配置自定义中间件中间件是tRPC的核心功能之一允许你在请求处理前后执行自定义逻辑。Prisma tRPC Generator提供了多种方式集成中间件。启用内置中间件支持在Prisma schema中配置生成器时可以启用中间件支持generator trpc { provider prisma-trpc-generator output ./prisma/generated // 启用中间件支持 withMiddleware true // 或者指定自定义中间件文件路径 withMiddleware ./prisma/customMiddleware.ts }创建自定义中间件当设置withMiddleware为文件路径时你可以创建完全自定义的中间件逻辑。查看示例文件prisma/middleware.tsexport default async ({ ctx, next }) { // 请求开始时间 const start Date.now(); // 记录请求信息 console.log([${new Date().toISOString()}] ${ctx.req.method} ${ctx.req.url}); // 添加请求ID const requestId crypto.randomUUID(); ctx.requestId requestId; // 执行下一个中间件或实际处理程序 const result await next({ ctx }); // 记录响应时间 const duration Date.now() - start; console.log(请求完成耗时: ${duration}ms); return result; };内置中间件功能当启用中间件但未指定自定义文件时生成器会创建基础中间件支持请求ID生成为每个请求分配唯一标识符基础日志记录记录请求开始和结束时间错误处理统一错误响应格式️ tRPC Shield权限集成tRPC Shield是一个强大的权限控制库Prisma tRPC Generator可以自动集成它来保护你的API端点。启用tRPC Shield在配置中启用Shield支持generator trpc { provider prisma-trpc-generator output ./prisma/generated // 启用tRPC Shield withShield true // 或者指定自定义权限规则文件 withShield ./prisma/customShield.ts }定义权限规则查看示例文件prisma/shield.ts了解如何定义权限规则import { shield, rule } from trpc-shield; import { Context } from ./context; // 认证规则检查用户是否已登录 export const isAuthenticated ruleContext()( async (ctx) ctx.user ! null, ); // 管理员规则检查用户是否为管理员 export const isAdmin ruleContext()( async (ctx) ctx.user?.role admin, ); // 权限矩阵为每个操作定义权限 export const permissions shieldContext({ // 查询操作权限 query: { // 所有人都可以查询用户 findManyUser: true, // 只有管理员可以查询所有订单 findManyOrder: isAdmin, }, // 变更操作权限 mutation: { // 只有认证用户可以创建书籍 createOneBook: isAuthenticated, // 只有管理员可以删除用户 deleteOneUser: isAdmin, // 用户可以更新自己的资料 updateOneUser: isAuthenticated, }, });基于角色的权限控制Prisma tRPC Generator支持基于角色的权限控制你可以为不同的用户角色定义不同的访问级别// 在配置中指定角色字段 generator trpc { provider prisma-trpc-generator output ./prisma/generated // 启用认证并指定角色字段 auth { strategy session rolesField role // 用户模型中的角色字段 } } 认证策略集成认证是API安全的基础Prisma tRPC Generator支持多种认证策略。会话认证Session使用传统的会话认证generator trpc { provider prisma-trpc-generator output ./prisma/generated auth { strategy session session { getUserPath ../../src/auth/getUser // 自定义用户解析函数 } } }JWT令牌认证对于无状态API可以使用JWT认证generator trpc { provider prisma-trpc-generator output ./prisma/generated auth { strategy jwt jwt { header authorization scheme Bearer secretEnv JWT_SECRET verifyPath ../../src/auth/verifyToken getUserFromPayloadPath ../../src/auth/getUserFromPayload } } }自定义认证策略如果需要完全控制认证流程可以使用自定义策略generator trpc { provider prisma-trpc-generator output ./prisma/generated auth { strategy custom custom { resolverPath ../../src/auth/resolveUser } } } 请求ID与日志记录在生产环境中追踪请求和调试问题至关重要。Prisma tRPC Generator内置了请求ID和日志记录功能。启用请求追踪generator trpc { provider prisma-trpc-generator output ./prisma/generated // 启用请求ID生成 withRequestId true // 启用详细日志记录 withLogging true }日志记录配置生成的中间件会自动记录请求开始时间请求方法、路径和参数响应时间和状态错误信息如果发生错误你可以在自定义中间件中扩展这些日志记录功能集成到你现有的日志系统中。 服务层架构支持对于大型应用你可能希望采用领域驱动设计DDD或服务层架构。Prisma tRPC Generator支持生成服务层代码。启用服务层generator trpc { provider prisma-trpc-generator output ./prisma/generated // 启用服务层 withServices true // 服务层样式class, factory, 或 plain serviceStyle class // 服务文件输出目录 serviceDir services }服务层示例查看示例文件examples/use-services.ts了解如何使用生成的服务层import { makeServices } from ../prisma/generated/services/index; // 创建服务实例 const services makeServices(ctx); // 使用服务层进行CRUD操作 const user await services.user.create({ data: { email: aliceexample.com, name: Alice } }); const posts await services.post.findMany({ where: { authorId: user.id } }); 高级配置选项Prisma tRPC Generator提供了丰富的配置选项让你可以精确控制生成的内容。控制生成的CRUD操作你可以选择性地启用或禁用特定的CRUD操作generator trpc { provider prisma-trpc-generator output ./prisma/generated // 只生成指定的操作 generateModelActions findMany,findUnique,create,update,delete }自定义上下文路径如果你的tRPC上下文位于非标准位置可以指定自定义路径generator trpc { provider prisma-trpc-generator output ./prisma/generated // 自定义上下文路径 contextPath ../../src/server/trpc/context // 自定义tRPC选项路径 trpcOptionsPath ../../src/server/trpc/options }Zod验证配置控制Zod验证的行为generator trpc { provider prisma-trpc-generator output ./prisma/generated // 启用Zod验证 withZod true // 日期时间字段处理策略 dateTimeStrategy date // 可选: date, coerce, isoString } 实战构建安全的用户管理系统让我们通过一个实际示例展示如何结合使用这些高级功能。步骤1配置生成器generator trpc { provider prisma-trpc-generator output ./prisma/generated // 启用所有高级功能 withMiddleware true withShield true withZod true withRequestId true withLogging true // 配置认证 auth { strategy jwt rolesField role jwt { secretEnv JWT_SECRET } } // 自定义权限规则文件 withShield ./prisma/shield-rules.ts }步骤2定义权限规则创建prisma/shield-rules.tsimport { shield, rule } from trpc-shield; import { Context } from ./context; const isAuthenticated ruleContext()( async (ctx) { if (!ctx.user) { return new Error(未授权访问); } return true; } ); const isAdmin ruleContext()( async (ctx) { if (ctx.user?.role ! admin) { return new Error(需要管理员权限); } return true; } ); export const permissions shieldContext({ query: { // 公开查询 findManyPost: true, findUniquePost: true, // 需要认证的查询 findManyUser: isAuthenticated, findUniqueUser: isAuthenticated, }, mutation: { // 任何人都可以注册 createOneUser: true, // 只有认证用户可以创建帖子 createOnePost: isAuthenticated, // 只有管理员可以删除用户 deleteOneUser: isAdmin, // 用户可以更新自己的资料 updateOneUser: isAuthenticated, }, });步骤3使用生成的APIimport { createTRPCClient, httpBatchLink } from trpc/client; import type { AppRouter } from ./prisma/generated/routers; // 创建tRPC客户端 const client createTRPCClientAppRouter({ links: [ httpBatchLink({ url: http://localhost:3000/trpc, headers: { Authorization: Bearer your-jwt-token, }, }), ], }); // 使用生成的API async function main() { // 创建用户公开操作 const user await client.user.createOne.mutate({ data: { email: userexample.com, name: Test User, role: user, }, }); // 查询帖子公开操作 const posts await client.post.findMany.query({ where: { published: true }, }); // 更新用户资料需要认证 const updatedUser await client.user.updateOne.mutate({ where: { id: user.id }, data: { name: Updated Name }, }); } 性能优化建议使用Prisma tRPC Generator时考虑以下性能优化1. 选择性生成只生成你需要的CRUD操作减少不必要的代码generateModelActions findMany,findUnique,create,update2. 批量操作优化利用tRPC的批量请求功能// 批量执行多个查询 const [users, posts, stats] await Promise.all([ client.user.findMany.query({}), client.post.findMany.query({}), client.stats.aggregate.query({}), ]);3. 缓存策略在自定义中间件中添加缓存逻辑export default async ({ ctx, next, path, type }) { // 为GET请求添加缓存 if (type query) { const cacheKey trpc:${path}:${JSON.stringify(ctx.input)}; const cached await cache.get(cacheKey); if (cached) { return cached; } const result await next({ ctx }); await cache.set(cacheKey, result, 60); // 缓存60秒 return result; } return next({ ctx }); }; 调试与故障排除常见问题解决中间件不生效检查withMiddleware配置是否正确确保中间件文件路径正确验证中间件函数导出格式权限规则不工作确认withShield已启用检查权限规则文件路径验证规则函数签名是否正确认证失败检查认证策略配置确认上下文包含必要的请求信息验证JWT密钥或会话存储调试工具使用tRPC开发工具进行调试import { createTRPCProxyClient, httpBatchLink } from trpc/client; import { createTRPCHandler } from trpc/server; import { fetchRequestHandler } from trpc/server/adapters/fetch; // 启用开发工具 const handler createTRPCHandler({ router: appRouter, createContext, onError: ({ error, path }) { console.error(tRPC错误: ${path}, error); }, }); 总结Prisma tRPC Generator的高级功能让你能够快速构建安全、可扩展的API。通过自定义中间件、tRPC Shield权限控制、多种认证策略和服务层架构你可以快速实现认证授权无需手动编写大量安全代码精细权限控制基于角色和操作的权限管理统一日志追踪内置请求ID和日志记录灵活架构设计支持服务层和领域驱动设计类型安全保证完全类型安全的API端点这些高级功能的组合使用可以显著提升开发效率同时确保代码质量和应用安全。无论是小型项目还是大型企业应用Prisma tRPC Generator都能提供适合的解决方案。开始使用这些高级功能让你的tRPC API开发体验达到新的高度【免费下载链接】prisma-trpc-generatorPrisma 2 generator to emit fully implemented tRPC routers项目地址: https://gitcode.com/gh_mirrors/pr/prisma-trpc-generator创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考