把 JSON 转换成 sequelize-typescript 库所用的基于装饰器的模型:一个继承 Model 的类,带有 @Table 和 @Column({ type: DataType.*, allowNull })、TypeScript 属性类型,以及用于校验的 class-validator 装饰器。
它面向的是 sequelize-typescript(NestJS 的 @nestjs/sequelize 背后的库),而不是纯 sequelize,所以 import 路径和 DataType 的拼写(末尾没有 s)都与 JavaScript 版本不同。
模型名 中输入类名(默认 MyModel),它同时会成为 @Table 中大写 snake case 形式的 tableName。invoice.model.ts,然后通过 new Sequelize({ ..., models: [Invoice] }) 或 NestJS 的 SequelizeModule.forFeature([Invoice]) 注册。{
"invoice_no": "INV-2024-0042",
"amount": 1250.75,
"currency": "EUR",
"paid": false,
"due_date": "2024-07-31",
"memo": ""
}import { Table, Column, Model, DataType } from 'sequelize-typescript';
import { IsNotEmpty, IsOptional } from 'class-validator';
@Table({ tableName: 'INVOICE', timestamps: false })
export class Invoice extends Model<Invoice> {
@Column({ type: DataType.INTEGER, primaryKey: true, autoIncrement: true })
id: number;
@Column({ type: DataType.STRING, allowNull: false, field: 'invoice_no' })
@IsNotEmpty()
invoiceNo: string;
@Column({ type: DataType.DOUBLE, allowNull: false })
@IsNotEmpty()
amount: number;
@Column({ type: DataType.STRING, allowNull: false })
@IsNotEmpty()
currency: string;
@Column({ type: DataType.BOOLEAN, allowNull: false })
@IsNotEmpty()
paid: boolean;
@Column({ type: DataType.DATEONLY, allowNull: false, field: 'due_date' })
@IsNotEmpty()
dueDate: string;
@Column({ type: DataType.STRING, allowNull: false })
@IsOptional()
memo: string;
}memo 是空字符串:它不是 NULL,所以列保持 allowNull: false,但得到的是 @IsOptional() 而不是 @IsNotEmpty()。amount 变成 DataType.DOUBLE,due_date 变成类型为 string 的 DataType.DATEONLY,因为 Sequelize 以文本形式返回只有日期的值。
sequelize-typescript 导入 { Table, Column, Model, DataType },并把类声明为 extends Model<Invoice>。@Table({ tableName: 'INVOICE', timestamps: false }) 与 JavaScript 生成器保持一致,因此不会假定存在 createdAt/updatedAt 列。@Column 都写明 type 和 allowNull;可空列的类型为 string | null 等。INTEGER/BIGINT/DOUBLE → number,BOOLEAN → boolean,DATE → Date,DATEONLY → string,JSON → Record<string, unknown> 或 string[] 这样的类型化数组。field: 'invoice_no' 指向原始列;JSON 中的 id key 会用作主键,而不会重复生成。@IsNotEmpty();其余字段得到 @IsOptional()。需要持久化外部计费或结算系统以 JSON 发来的数据时,根据这个 payload 生成模型类,再通过 @InjectModel(Invoice) 使用。
不必手动把 define() 对象改写成类,只要把现有表数据导出为 JSON 并粘贴进来,就能得到带类型的模型草稿。
DataType.DECIMAL(12, 2) 比 DataType.DOUBLE 更安全。experimentalDecorators 和 emitDecoratorMetadata,装饰器才能工作。useDefineForClassFields 时(target 为 ES2022 及以上时的默认值),普通的属性声明会遮蔽 Sequelize 的 getter。请关闭该选项,或在属性前加上 declare。Model<InvoiceAttributes, InvoiceCreationAttributes> 而不是 Model<Invoice> 吗?sequelize-typescript v2 接受两个泛型参数;生成的代码只是简单地传入类本身。如果希望 Invoice.create({...}) 在不包含 id 等自动生成字段的情况下也能做类型检查,请声明一个 creation-attributes 接口并作为第二个泛型参数传入。
DataType 而不是 DataTypes?DataType 是 sequelize-typescript 导出的名称。从 sequelize 导入 DataTypes 效果相同,但一个文件里坚持用一个名称更易读。
不会。只有在你自己调用 validate(invoice),或者装饰器位于由 NestJS ValidationPipe 处理的 DTO 上时,才会进行校验。Sequelize 层面的校验请使用 @Column({ validate: { notEmpty: true } }) 或 @NotEmpty 等 sequelize-typescript 装饰器。