NestJS引入Prisma实践

📅 2026/7/18 22:48:58
NestJS引入Prisma实践
NestJS引入Prisma实践一、安装依赖与 MySQL 配置1.1 安装 Prisma1.2 初始化 Prisma 并配置数据源二、定义数据模型附详细字段说明字段修饰符/属性速查表三、执行迁移生成数据库表四、在 NestJS 中集成 Prisma 客户端4.1 创建 PrismaService实现生命周期管理4.2 注册为全局模块4.3 在业务 Service 中直接注入并使用五、为什么可以直接使用 this.prisma.user.findMany()六、修改数据库模型后我该怎么办6.1 开发阶段快速迭代不保留迁移历史6.2 正式环境/团队协作需要版本管理6.3 如果变更会丢失数据如删列、改类型6.4 如果直接在 MySQL 中手动改了表结构外部漂移6.5 终极重置仅限开发保命大招变更操作策略对照表七、常用 Prisma 命令速查MySQL假设你已经拥有一个现有的 NestJS 项目使用nestjs/cli创建本文直接进入 Prisma 集成、模型定义、数据库操作的全流程。一、安装依赖与 MySQL 配置1.1 安装 Prismanpminstallprisma --save-devnpminstallprisma/client--save1.2 初始化 Prisma 并配置数据源npx prisma init编辑项目根目录的.env文件填入你的 MySQL 连接字符串DATABASE_URLmysql://用户名:密码localhost:3306/数据库名?schemapublic修改prisma/schema.prisma中的数据源配置datasource db { provider mysql url env(DATABASE_URL) } generator client { provider prisma-client }二、定义数据模型附详细字段说明我们以电商场景为例定义User、Order、Product三个模型并完整展示 Prisma 的字段修饰符。model User { id Int id default(autoincrement()) // 主键自增 email String unique // 唯一约束 name String? // 可选可空 age Int default(0) // 默认值 0 isActive Boolean default(true) // 默认 true createdAt DateTime default(now()) // 创建时自动设为当前时间 updatedAt DateTime updatedAt // 更新时自动更新 orders Order[] // 一对多关系用户 → 订单 } model Order { id Int id default(autoincrement()) total Decimal db.Decimal(10, 2) // 精确十进制精度10小数位2 status String default(pending) // 默认状态 userId Int // 外键 user User relation(fields: [userId], references: [id]) // 多对一 products Product[] relation(OrderProducts) // 多对多通过中间表 createdAt DateTime default(now()) updatedAt DateTime updatedAt } model Product { id Int id default(autoincrement()) name String price Float // 浮点数注意金额建议 Decimal stock Int default(0) orders Order[] relation(OrderProducts) // 多对多反向关系 createdAt DateTime default(now()) updatedAt DateTime updatedAt }字段修饰符/属性速查表修饰符说明适用类型id标记为主键任意default(autoincrement())自增默认值Intdefault(now())当前时间戳DateTimedefault(pending)/default(0)/default(true)静态默认值String / Int / Booleanunique唯一约束任意?如String?字段可为null任意updatedAt记录更新时自动设为当前时间DateTimerelation定义外键关系fields指定外键references指定主键关系字段db.Decimal(10,2)指定 MySQL 的 Decimal 类型Decimal三、执行迁移生成数据库表npx prisma migrate dev--nameinit该命令会根据schema.prisma生成 SQL 迁移文件保存在prisma/migrations/在 MySQL 中执行建表语句自动生成 Prisma Clientprisma/client供后续代码调用四、在 NestJS 中集成 Prisma 客户端4.1 创建 PrismaService实现生命周期管理// src/prisma.service.tsimport{Injectable,OnModuleInit,OnModuleDestroy}fromnestjs/common;import{PrismaClient}fromprisma/client;Injectable()exportclassPrismaServiceextendsPrismaClientimplementsOnModuleInit,OnModuleDestroy{asynconModuleInit(){awaitthis.$connect();// 应用启动时连接数据库}asynconModuleDestroy(){awaitthis.$disconnect();// 应用关闭时断开连接}}4.2 注册为全局模块// src/prisma.module.tsimport{Global,Module}fromnestjs/common;import{PrismaService}from./prisma.service;Global()Module({providers:[PrismaService],exports:[PrismaService],})exportclassPrismaModule{}在AppModule中导入PrismaModule。4.3 在业务 Service 中直接注入并使用// src/user/user.service.tsimport{Injectable}fromnestjs/common;import{PrismaService}from../prisma.service;Injectable()exportclassUserService{constructor(privateprisma:PrismaService){}// 依赖注入asyncfindAll(){returnthis.prisma.user.findMany({include:{orders:true},});}asynccreate(data:{email:string;name?:string}){returnthis.prisma.user.create({data});}}五、为什么可以直接使用this.prisma.user.findMany()很多初学者会困惑我并没有手动创建数据库连接池也没有调用$connect()为何 Prisma 客户端就能直接工作根本原因在于 NestJS 的依赖注入IoC容器和 Prisma 的生命周期钩子实例化管理PrismaService被Injectable()装饰并注册在PrismaModule中NestJS 会创建其单例实例。当UserService的构造函数声明private prisma: PrismaService时容器自动将已实例化的PrismaService注入进来。自动连接PrismaService实现了OnModuleInit接口NestJS 在应用初始化阶段会调用所有模块的onModuleInit()方法因此$connect()会被自动执行建立数据库连接。继承自 PrismaClientPrismaService继承了PrismaClient而PrismaClient在prisma/client生成时已经根据你的schema.prisma绑定了所有模型user、order、product的查询构建方法。这些方法返回的都是类型安全的 Promise。类型安全每次执行migrate dev或prisma generatePrisma 会重新生成 TypeScript 类型定义所以你写的this.prisma.user.findMany()会有完整的智能提示和参数校验。因此你只需在业务 Service 中注入PrismaService即可直接使用其所有模型 API无需关心底层连接管理。六、修改数据库模型后我该怎么办在实际开发中Schema 变更是常态。Prisma 提供了多种策略取决于你的场景。6.1 开发阶段快速迭代不保留迁移历史适用于本地频繁修改数据不重要时npx prisma db push特点不生成迁移文件直接同步 Schema 到数据库。风险破坏性操作删除列/改类型会清空数据但会给出警告。6.2 正式环境/团队协作需要版本管理这是推荐的方式必须生成迁移文件并纳入版本控制。示例为 User 表新增phone字段可空。model User { // ... 已有字段 phone String? // 新增 }然后运行npx prisma migrate dev--nameadd_phone_to_userPrisma 会比较 Schema 差异生成 ALTER TABLE 的 SQL 文件。在 MySQL 中执行该 SQL。重新生成客户端使代码中即刻可用。6.3 如果变更会丢失数据如删列、改类型直接运行migrate dev会提示数据丢失。安全做法是分步迁移场景将name从String?可空改为String必填且不希望现有数据丢失。第一次迁移先为name设置默认值使其变为“实际必填但允许 null”。name String default(默认昵称)→ 生成迁移并部署。填充历史数据在数据库中执行UPDATE User SET name 默认昵称 WHERE name IS NULL;可通过脚本或手工 SQL。第二次迁移移除default改为真正的必填。name String→ 生成第二个迁移此时不会丢失数据。高级技巧你也可以在生成的migration.sql文件中手动编辑先ADD COLUMN再UPDATE最后MODIFY NOT NULL然后执行npx prisma migrate dev。6.4 如果直接在 MySQL 中手动改了表结构外部漂移例如你在 Navicat 中添加了字段但 Prisma Schema 未同步。# 拉取现有数据库结构覆盖 schema.prismanpx prisma db pull# 重新生成客户端npx prisma generate⚠️ 注意db pull会覆盖本地的模型定义原有的relation和default可能需要手动恢复请谨慎操作。6.5 终极重置仅限开发保命大招如果迁移历史混乱且数据库数据不重要# 删除 prisma/migrations 目录并清空数据库所有表npx prisma migrate reset这会根据当前 Schema 重新创建所有表并生成一份全新的迁移记录。变更操作策略对照表场景命令是否生成迁移文件数据风险适用环境新增可空字段/新表migrate dev --name xxx✅无所有环境修改字段类型/删除字段分两步迁移见上文✅高生产需谨慎快速原型数据不重要db push❌低本地开发手动修改过数据库db pullgenerate❌无覆盖 Schema任何重置全部迁移migrate reset❌重建全部丢失仅本地开发七、常用 Prisma 命令速查MySQL命令作用npx prisma migrate dev --name xxx生成迁移并执行开发npx prisma migrate deploy在生产环境执行未应用的迁移CI/CDnpx prisma db push直接同步 Schema不生成迁移文件npx prisma generate手动生成 Prisma Client通常在迁移后自动执行npx prisma studio打开可视化数据库管理界面npx prisma db pull从数据库拉取 Schema 到本地npx prisma migrate reset重置数据库并重新应用所有迁移