NestJS Boilerplate 中实体字段添加的正确方式

在使用 NestJS Boilerplate 进行开发时，开发者可能会遇到在已有实体中添加新字段后，TypeORM 无法检测到数据库模式变更的问题。本文将详细解释这一现象的原因及正确的解决方法。

问题现象

当开发者按照以下步骤操作时：

1. 使用命令行工具生成资源
2. 创建并运行初始迁移
3. 在实体类中添加新字段
4. 尝试生成新的迁移文件

系统会提示"数据库模式未发现变更"，无法生成新的迁移文件。

根本原因

这个问题通常是由于开发者忘记在实体类的新字段上添加@Column()装饰器导致的。TypeORM 通过扫描实体类中的装饰器来识别数据库模式变更，缺少装饰器意味着 TypeORM 无法识别该字段需要同步到数据库。

正确操作步骤

1. 生成资源：使用项目提供的命令行工具生成基础资源结构
2. 初始迁移：创建并运行初始数据库迁移
3. 添加字段：在实体类中正确添加新字段，必须包含@Column()装饰器
4. 生成迁移：再次运行迁移生成命令

最佳实践

• 始终为实体类中的每个数据库字段添加@Column()装饰器
• 考虑为字段添加类型参数，如@Column('varchar')
• 对于可选字段，可以添加nullable: true选项
• 在开发过程中，使用sync: true配置可以帮助快速验证实体定义是否正确

总结

NestJS Boilerplate 结合 TypeORM 提供了强大的数据库迁移功能，但需要开发者遵循正确的实体定义规范。记住为每个数据库字段添加@Column()装饰器是确保迁移系统正常工作的关键。这种显式声明的方式虽然需要更多代码，但提供了更好的类型安全和可维护性。