如何使用Prisma tRPC Generator实现多租户与软删除功能

如何使用Prisma tRPC Generator实现多租户与软删除功能

【免费下载链接】prisma-trpc-generatorPrisma 2+ generator to emit fully implemented tRPC routers项目地址: https://gitcode.com/gh_mirrors/pr/prisma-trpc-generator

Prisma tRPC Generator是一款强大的代码生成工具，能够自动生成基于Prisma模型的tRPC路由，帮助开发者快速构建类型安全的API。本文将详细介绍如何利用该工具实现多租户架构与软删除功能，让你的应用具备企业级数据隔离与数据恢复能力。

多租户与软删除：现代应用的必备功能

在SaaS应用开发中，多租户架构能够让多个客户（租户）共享同一应用实例，同时保持数据隔离；而软删除功能则允许"删除"数据时仅标记状态而非真正删除，为数据恢复提供可能。Prisma tRPC Generator通过简洁的配置即可实现这两项关键功能，大幅减少重复代码。

多租户架构的核心价值

• 数据隔离：确保不同租户数据完全隔离，满足合规要求
• 资源共享：降低服务器资源成本，提高运维效率
• 按需扩展：支持租户级别的功能定制与资源分配

软删除的业务优势

• 数据安全：防止误删除导致的数据丢失
• 审计追踪：保留完整的操作历史记录
• 业务分析：可基于历史数据进行趋势分析

准备工作：环境搭建与依赖安装

首先确保你的开发环境满足以下要求：

• Node.js 14.0+
• Prisma 2.0+
• tRPC 9.0+

通过以下命令克隆项目仓库并安装依赖：

git clone https://gitcode.com/gh_mirrors/pr/prisma-trpc-generator cd prisma-trpc-generator pnpm install

实现多租户功能的完整步骤

1. 配置多租户模型

在Prisma schema文件中添加租户标识字段，通常命名为tenantId：

// prisma/schema.prisma model Post { id Int @id @default(autoincrement()) title String content String? tenantId Int // 多租户标识 createdAt DateTime @default(now()) updatedAt DateTime @updatedAt deletedAt DateTime? // 软删除标识 }

2. 启用多租户生成器

在生成器配置中添加多租户选项：

// prisma/trpc.config.json { "generator": { "tenantKey": "tenantId", "softDeleteKey": "deletedAt" } }

3. 使用多租户服务

生成的服务会自动处理租户隔离，无需手动添加过滤条件：

// examples/use-services-tenancy.ts async function runForTenant(prisma: PrismaClient, tenantId: number) { const ctx: Context & { tenantId: number } = { prisma, user: null, tenantId }; const s = makeServices(ctx); // 自动应用租户过滤 const posts = await s.post.findMany({}); console.log(`Tenant ${tenantId} posts count:`, posts.length); }

配置软删除功能

1. 设置软删除字段

在数据模型中添加软删除字段（通常命名为deletedAt）：

// prisma/schema.prisma model Post { // ...其他字段 deletedAt DateTime? @db.DateTime // 软删除时间戳 }

2. 软删除查询示例

生成的tRPC路由会自动排除已"删除"的记录：

// 默认查询不会返回软删除数据 const activePosts = await s.post.findMany({}); // 如需包含软删除数据，使用withDeleted选项 const allPosts = await s.post.findMany({}, { withDeleted: true });

3. 软删除实现原理

生成器通过中间件自动处理软删除逻辑：

// src/prisma-generator.ts if (cfg.softDeleteKey) { // 删除操作转为更新 delete data[cfg.softDeleteKey]; // 查询时自动过滤已删除数据 input.where[cfg.softDeleteKey] = null; }

多租户与软删除的路由实现

Prisma tRPC Generator会为每个模型生成完整的CRUD路由，自动应用租户隔离和软删除过滤。以下是生成的路由示例：

从上图可以看到，生成的路由包含了各种数据库操作方法，所有操作都会自动考虑租户上下文和软删除状态，确保数据安全与隔离。

测试多租户与软删除功能

项目提供了专门的测试文件来验证多租户和软删除功能：

// tests/feature-tenancy-soft-delete.test.ts describe('feature: tenancy + soft-delete hooks', () => { const outDir = generateRouters('tenancy'); // 测试用例验证租户隔离和软删除行为 });

运行测试命令：

pnpm test tests/feature-tenancy-soft-delete.test.ts

高级配置与最佳实践

自定义租户标识符

如果需要使用不同的租户标识字段名，可在配置中自定义：

// src/helpers.ts interface GeneratorConfig { softDeleteKey?: string; // 自定义软删除字段名 tenantKey?: string; // 自定义租户字段名 }

性能优化建议

• 为租户字段和软删除字段添加索引
• 对大型租户数据实现分表策略
• 使用缓存减少重复查询

安全注意事项

• 始终在服务端验证租户身份，防止越权访问
• 定期清理真正不再需要的软删除数据
• 对敏感操作进行审计日志记录

总结

通过Prisma tRPC Generator，开发者可以轻松实现多租户和软删除功能，大幅减少样板代码，专注于业务逻辑开发。本文介绍的方法已经在实际项目中得到验证，你可以直接参考examples/use-services-tenancy.ts中的示例代码快速集成到自己的项目中。

无论是构建SaaS平台还是企业内部系统，多租户与软删除都是提升系统安全性和可靠性的重要手段，而Prisma tRPC Generator让这些复杂功能的实现变得简单高效。

【免费下载链接】prisma-trpc-generatorPrisma 2+ generator to emit fully implemented tRPC routers项目地址: https://gitcode.com/gh_mirrors/pr/prisma-trpc-generator