Chuyển đổi JSON thành Sequelize (TypeScript)!

Nhập JSON và chuyển đổi nó thành Sequelize (TypeScript)! Hỗ trợ sequelize-typescript @Table, @Column, Model, class-validator.
JSON
Kết quả
 

Chuyển đổi JSON thành Sequelize (TypeScript)!

Chuyển JSON thành model dựa trên decorator cho thư viện sequelize-typescript: một class kế thừa Model với @Table và @Column({ type: DataType.*, allowNull }), kiểu property TypeScript, và decorator của class-validator để validate.

Công cụ nhắm tới sequelize-typescript (thư viện đứng sau @nestjs/sequelize của NestJS) chứ không phải sequelize thuần, nên đường dẫn import và cách viết DataType (không có s ở cuối) khác với bản JavaScript.

Cách sử dụng

  1. Dán một object JSON ứng với một dòng của bảng, hoặc một mảng nhiều dòng.
  2. Nhập tên class vào Tên model (mặc định MyModel); nó cũng thành tableName dạng upper snake case trong @Table.
  3. Lưu kết quả thành invoice.model.ts và đăng ký bằng new Sequelize({ ..., models: [Invoice] }) hoặc SequelizeModule.forFeature([Invoice]) của NestJS.

Ví dụ

Đầu vào (JSON)
{
  "invoice_no": "INV-2024-0042",
  "amount": 1250.75,
  "currency": "EUR",
  "paid": false,
  "due_date": "2024-07-31",
  "memo": ""
}
Đầu ra (sequelize-typescript)
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 là chuỗi rỗng: nó không phải NULL nên cột giữ allowNull: false, nhưng nhận @IsOptional() thay vì @IsNotEmpty(). amount thành DataType.DOUBLE, còn due_date thành DataType.DATEONLY với kiểu string, vì Sequelize trả giá trị chỉ có ngày về dạng văn bản.

Tính năng hỗ trợ

  • Import { Table, Column, Model, DataType } từ sequelize-typescript và khai báo class là extends Model<Invoice>.
  • @Table({ tableName: 'INVOICE', timestamps: false }), giống công cụ cho JavaScript, nên không giả định có cột createdAt/updatedAt.
  • Mọi @Column đều ghi rõ type và allowNull; cột nullable có kiểu string | null và tương tự.
  • Cặp kiểu: INTEGER/BIGINT/DOUBLE → number, BOOLEAN → boolean, DATE → Date, DATEONLY → string, JSON → Record<string, unknown> hoặc mảng có kiểu như string[].
  • Property là camelCase với field: 'invoice_no' trỏ tới cột gốc; key id trong JSON được dùng làm khóa chính chứ không bị lặp lại.
  • Field có giá trị không rỗng ở mọi dòng nhận @IsNotEmpty(); các field còn lại nhận @IsOptional().

Trường hợp sử dụng

Model cho NestJS với `@nestjs/sequelize`

Khi cần lưu dữ liệu mà hệ thống hóa đơn hay quyết toán bên ngoài gửi dưới dạng JSON, hãy dựng class model từ payload đó và dùng nó qua @InjectModel(Invoice).

Đưa model Sequelize JavaScript sang code có kiểu

Export dữ liệu bảng hiện có ra JSON rồi dán vào để có bản nháp model có kiểu, thay vì tự viết lại object define() thành class.

Lưu ý và giới hạn

  • Với tiền tệ và các số thập phân cần chính xác khác, DataType.DECIMAL(12, 2) an toàn hơn DataType.DOUBLE.
  • Phải bật experimentalDecorators và emitDecoratorMetadata trong tsconfig thì decorator mới chạy.
  • Với useDefineForClassFields (mặc định khi target là ES2022 trở lên), khai báo property thông thường sẽ che getter của Sequelize. Hãy tắt option đó hoặc thêm tiền tố declare cho property.

Câu hỏi thường gặp

Lẽ ra phải là Model<InvoiceAttributes, InvoiceCreationAttributes> thay vì Model<Invoice> chứ?

sequelize-typescript v2 nhận hai generic; code được tạo chỉ đơn giản truyền chính class đó. Nếu muốn Invoice.create({...}) được kiểm tra kiểu mà không cần các field tự sinh như id, hãy khai báo interface creation-attributes và truyền làm generic thứ hai.

Vì sao là DataType mà không phải DataTypes?

DataType là tên mà sequelize-typescript export. Import DataTypes từ sequelize cũng chạy như vậy, nhưng mỗi file chỉ dùng một tên sẽ dễ đọc hơn.

Decorator class-validator có được kiểm tra tự động trên model không?

Không. Việc validate chỉ xảy ra khi bạn tự gọi validate(invoice) hoặc khi decorator nằm trên DTO được ValidationPipe của NestJS xử lý. Để validate ở cấp Sequelize, hãy dùng @Column({ validate: { notEmpty: true } }) hoặc decorator của sequelize-typescript như @NotEmpty.