แปลง JSON เป็น Sequelize (TypeScript) แผน!

ป้อน JSON และแปลงเป็น Sequelize (TypeScript) แผน! รองรับ sequelize-typescript @Table, @Column, Model, class-validator
JSON
ผลลัพธ์
 

แปลง JSON เป็น Sequelize (TypeScript) แผน!

แปลง JSON เป็นโมเดลแบบ decorator สำหรับไลบรารี sequelize-typescript: คลาสที่ extend Model พร้อม @Table และ @Column({ type: DataType.*, allowNull }) ไทป์ของพร็อพเพอร์ตีใน TypeScript และ decorator ของ class-validator สำหรับ validation

เป้าหมายคือ sequelize-typescript (ไลบรารีเบื้องหลัง @nestjs/sequelize ของ NestJS) ไม่ใช่ sequelize เปล่า ๆ path ของ import และการสะกด DataType (ไม่มี s ท้าย) จึงต่างจากเวอร์ชัน JavaScript

วิธีใช้

  1. วางออบเจ็กต์ JSON ของหนึ่งแถวในตาราง หรืออาร์เรย์ของหลายแถว
  2. ใส่ชื่อคลาสใน ชื่อโมเดล (ค่าเริ่มต้น MyModel) ซึ่งจะกลายเป็น tableName แบบ upper snake case ใน @Table ด้วย
  3. บันทึกผลลัพธ์เป็น invoice.model.ts แล้วลงทะเบียนด้วย new Sequelize({ ..., models: [Invoice] }) หรือ SequelizeModule.forFeature([Invoice]) ของ NestJS

ตัวอย่าง

อินพุต (JSON)
{
  "invoice_no": "INV-2024-0042",
  "amount": 1250.75,
  "currency": "EUR",
  "paid": false,
  "due_date": "2024-07-31",
  "memo": ""
}
เอาต์พุต (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 เป็นสตริงว่าง ซึ่งไม่ใช่ NULL คอลัมน์จึงยังเป็น allowNull: false แต่ได้ @IsOptional() แทน @IsNotEmpty() amount กลายเป็น DataType.DOUBLE และ due_date กลายเป็น DataType.DATEONLY ที่มีไทป์ string เพราะ Sequelize คืนค่าวันที่ล้วนเป็นข้อความ

ฟีเจอร์ที่รองรับ

  • import { Table, Column, Model, DataType } จาก sequelize-typescript และประกาศคลาสเป็น extends Model<Invoice>
  • @Table({ tableName: 'INVOICE', timestamps: false }) เหมือนตัวสร้างของ JavaScript จึงไม่คาดหวังคอลัมน์ createdAt/updatedAt
  • ทุก @Column ระบุ type และ allowNull คอลัมน์ที่เป็น null ได้จะมีไทป์อย่าง string | null
  • คู่ไทป์: INTEGER/BIGINT/DOUBLE → number, BOOLEAN → boolean, DATE → Date, DATEONLY → string, JSON → Record<string, unknown> หรืออาร์เรย์ที่มีไทป์อย่าง string[]
  • พร็อพเพอร์ตีเป็น camelCase และมี field: 'invoice_no' ชี้ไปยังคอลัมน์เดิม คีย์ id ใน JSON ถูกใช้เป็น primary key แทนที่จะซ้ำ
  • ฟิลด์ที่มีค่าไม่ว่างในทุกแถวได้ @IsNotEmpty() ที่เหลือได้ @IsOptional()

กรณีการใช้งาน

โมเดลสำหรับ NestJS ที่ใช้ `@nestjs/sequelize`

เมื่อต้องบันทึกข้อมูลที่ระบบเรียกเก็บเงินหรือระบบชำระบัญชีภายนอกส่งมาเป็น JSON ให้สร้างคลาสโมเดลจาก payload นั้นแล้วใช้ผ่าน @InjectModel(Invoice)

เปลี่ยนโมเดล Sequelize ของ JavaScript เป็นโค้ดที่มีไทป์

export ข้อมูลตารางที่มีอยู่เป็น JSON แล้ววาง จะได้ร่างโมเดลที่มีไทป์ แทนการเขียนออบเจ็กต์ define() ใหม่เป็นคลาสด้วยมือ

ข้อควรระวังและข้อจำกัด

  • สำหรับเงินและทศนิยมที่ต้องแม่นยำ DataType.DECIMAL(12, 2) ปลอดภัยกว่า DataType.DOUBLE
  • ต้องเปิด experimentalDecorators และ emitDecoratorMetadata ใน tsconfig เพื่อให้ decorator ทำงาน
  • เมื่อเปิด useDefineForClassFields (ค่าเริ่มต้นเมื่อ target เป็น ES2022 ขึ้นไป) การประกาศพร็อพเพอร์ตีธรรมดาจะบัง getter ของ Sequelize ให้ปิดตัวเลือกนั้น หรือใส่ declare นำหน้าพร็อพเพอร์ตี

คำถามที่พบบ่อย

ควรเป็น Model<InvoiceAttributes, InvoiceCreationAttributes> แทน Model<Invoice> หรือเปล่า?

sequelize-typescript v2 รับ generic สองตัว โค้ดที่สร้างแค่ส่งคลาสตัวเองเข้าไป ถ้าต้องการให้ Invoice.create({...}) ถูกเช็กไทป์โดยไม่ต้องใส่ฟิลด์ที่สร้างอัตโนมัติอย่าง id ให้ประกาศ interface ของ creation attributes แล้วส่งเป็น generic ตัวที่สอง

ทำไมเป็น DataType ไม่ใช่ DataTypes?

DataType คือชื่อที่ sequelize-typescript export ออกมา การ import DataTypes จาก sequelize ก็ทำงานเหมือนกัน แต่ใช้ชื่อเดียวต่อหนึ่งไฟล์จะอ่านง่ายกว่า

decorator ของ class-validator ถูกตรวจบนโมเดลโดยอัตโนมัติไหม?

ไม่ validation จะเกิดเมื่อคุณเรียก validate(invoice) เอง หรือเมื่อ decorator อยู่บน DTO ที่ ValidationPipe ของ NestJS จัดการ ถ้าต้องการ validation ระดับ Sequelize ให้ใช้ @Column({ validate: { notEmpty: true } }) หรือ decorator ของ sequelize-typescript อย่าง @NotEmpty