小满nestjs（第二十五章 NestJS ORM实战：TypeORM连接MySQL与实体映射）

1. TypeORM连接MySQL的完整配置指南第一次在NestJS项目中使用TypeORM连接MySQL时我踩了不少坑。记得当时因为一个简单的端口配置错误折腾了大半天才成功连接。现在回想起来其实只要掌握几个关键配置项整个过程可以非常顺畅。首先确保你已经安装了必要的依赖包。打开终端在项目目录下执行npm install --save nestjs/typeorm typeorm mysql2这三个包各司其职nestjs/typeorm是NestJS的集成模块typeorm是ORM核心库mysql2则是MySQL的Node.js驱动。安装完成后我们需要在app.module.ts中进行配置。下面是一个完整的配置示例import { Module } from nestjs/common; import { TypeOrmModule } from nestjs/typeorm; Module({ imports: [ TypeOrmModule.forRoot({ type: mysql, host: localhost, port: 3306, username: root, password: yourpassword, database: test_db, entities: [__dirname /**/*.entity{.ts,.js}], synchronize: true, logging: true, retryDelay: 3000, retryAttempts: 5, autoLoadEntities: true, }), ], }) export class AppModule {}这里有几个关键参数需要特别注意synchronize开发环境可以设为true它会自动同步实体到数据库结构。但生产环境一定要设为false否则可能导致数据丢失autoLoadEntities这个配置让TypeORM能自动发现通过forFeature()注册的实体retryAttempts和retryDelay在网络不稳定的环境下这些重试配置能提高连接成功率2. 实体定义与装饰器详解实体(Entity)是TypeORM的核心概念它把数据库表映射为TypeScript类。我第一次定义实体时被各种装饰器搞得有点懵后来发现其实它们都有明确的对应关系。让我们创建一个用户实体作为示例import { Entity, PrimaryGeneratedColumn, Column, CreateDateColumn, UpdateDateColumn } from typeorm; Entity() export class User { PrimaryGeneratedColumn() id: number; Column({ length: 50, unique: true }) username: string; Column({ select: false }) password: string; Column({ default: true }) isActive: boolean; CreateDateColumn() createdAt: Date; UpdateDateColumn() updatedAt: Date; }每个装饰器都有特定的用途Entity()标记这个类是一个实体对应数据库中的一张表PrimaryGeneratedColumn()自增主键Column()普通列可以传入配置对象定义更多属性CreateDateColumn()和UpdateDateColumn()特殊列类型会自动维护创建和更新时间在实际项目中我建议为每个实体都添加createdAt和updatedAt字段这对后期排查问题非常有帮助。另外密码字段一定要设置select: false避免查询时意外泄露敏感信息。3. Repository模式的实战应用TypeORM提供了几种操作数据的方式其中Repository模式是我最常用的。它封装了大量常用方法让数据库操作变得异常简单。首先需要在模块中注册实体import { Module } from nestjs/common; import { TypeOrmModule } from nestjs/typeorm; import { User } from ./user.entity; Module({ imports: [TypeOrmModule.forFeature([User])], providers: [UserService], }) export class UserModule {}然后在服务中注入Repositoryimport { Injectable } from nestjs/common; import { InjectRepository } from nestjs/typeorm; import { Repository } from typeorm; import { User } from ./user.entity; Injectable() export class UserService { constructor( InjectRepository(User) private userRepository: RepositoryUser, ) {} async findAll(): PromiseUser[] { return this.userRepository.find(); } async findOne(id: number): PromiseUser { return this.userRepository.findOne({ where: { id } }); } async create(user: PartialUser): PromiseUser { const newUser this.userRepository.create(user); return this.userRepository.save(newUser); } async update(id: number, user: PartialUser): PromiseUser { await this.userRepository.update(id, user); return this.userRepository.findOne({ where: { id } }); } async remove(id: number): Promisevoid { await this.userRepository.delete(id); } }Repository提供了丰富的APIfind()查询所有记录findOne()查询单条记录create()和save()创建新记录update()更新记录delete()删除记录在实际开发中我经常需要添加一些自定义查询。这时可以使用queryBuilderasync findActiveUsers(): PromiseUser[] { return this.userRepository .createQueryBuilder(user) .where(user.isActive :isActive, { isActive: true }) .orderBy(user.createdAt, DESC) .getMany(); }4. 开发与生产环境的最佳实践经过多个项目的实践我总结出一些TypeORM在不同环境下的使用经验。开发环境配置建议开启synchronize自动同步实体变更到数据库开启logging查看生成的SQL语句使用内存数据库如SQLite进行单元测试TypeOrmModule.forRoot({ // 开发环境配置 synchronize: true, logging: true, // 其他配置... })生产环境注意事项必须关闭synchronize避免意外修改表结构关闭logging减少I/O开销配置连接池提高性能使用SSL连接保证数据安全TypeOrmModule.forRoot({ // 生产环境配置 synchronize: false, logging: false, extra: { connectionLimit: 10, // 连接池大小 ssl: { rejectUnauthorized: false, }, }, // 其他配置... })迁移管理 生产环境应该使用迁移来管理数据库变更。TypeORM提供了迁移工具# 生成迁移文件 npx typeorm migration:generate -n YourMigrationName # 运行迁移 npx typeorm migration:run我曾经在一个项目中因为没有使用迁移直接在生产环境开启了synchronize结果导致部分测试数据被意外删除。从那以后我始终坚持在开发环境使用synchronize在生产环境使用迁移。5. 常见问题与性能优化在使用TypeORM的过程中我遇到过不少性能问题和奇怪的行为。这里分享几个典型案例和解决方案。N1查询问题 这是ORM常见的性能陷阱。比如下面的代码const users await userRepository.find(); users.forEach(user { console.log(user.posts); // 每次访问都会触发查询 });解决方案是使用relations预加载关联数据const users await userRepository.find({ relations: [posts] });批量插入优化 直接使用save()插入大量数据会很慢// 不推荐 for (const item of largeArray) { await repository.save(item); }应该使用insert()方法// 推荐 await repository.insert(largeArray);索引与查询优化 为常用查询条件添加索引能显著提高性能Entity() export class Product { Index() Column() categoryId: number; }对于复杂查询可以使用原生SQLconst result await manager.query( SELECT p.*, c.name as categoryName FROM product p JOIN category c ON p.categoryId c.id WHERE p.price ? , [100]);缓存策略 TypeORM支持查询缓存const products await productRepository.find({ where: { categoryId: 1 }, cache: true, // 启用缓存 });在实际项目中我建议对不常变动的数据如配置项、分类信息启用缓存而对高频更新的数据如用户订单则禁用缓存。