Tukarkan JSON kepada Mongoose (TypeScript)!

Masukkan JSON dan tukarkannya kepada Mongoose (TypeScript)! Menyokong NestJS @nestjs/mongoose @Schema, @Prop, SchemaFactory, MongoDB.
JSON
Hasil
 

Tukarkan JSON kepada Mongoose (TypeScript)!

Menukar JSON kepada kelas skema @nestjs/mongoose NestJS: kelas @Schema() dengan @Prop() pada setiap field, skema yang dibina dengan SchemaFactory.createForClass(), dan jenis ProductDocument, semuanya dalam satu fail. Setiap field juga membawa @IsNotEmpty() atau @IsOptional() daripada class-validator.

Gunakannya apabila modul NestJS memerlukan skema untuk didaftarkan dengan MongooseModule.forFeature(), anda sudah mempunyai sampel dokumen yang hendak disimpan, dan menulis setiap decorator secara manual ialah bahagian yang memakan masa.

Cara menggunakan

  1. Tampal sampel dokumen ke dalam input. Jika sesetengah field hanya kadang-kadang wujud, tampal beberapa dokumen sebagai array supaya field opsyenal dapat dikesan.
  2. Masukkan nama kelas dalam Nama model (lalai MyModel). Menaip product menghasilkan Product, ProductDocument dan ProductSchema.
  3. Simpan hasil sebagai product.schema.ts dan daftarkannya dengan MongooseModule.forFeature([{ name: Product.name, schema: ProductSchema }]).

Contoh

Input (JSON)
{
  "sku": "KB-87-RED",
  "title": "Mechanical keyboard",
  "price": 89.5,
  "stock": 42,
  "discontinued": false,
  "restocked_at": "2024-03-18"
}
Output (NestJS @nestjs/mongoose)
import { Prop, Schema, SchemaFactory } from '@nestjs/mongoose';
import { Document, Schema as MongooseSchema } from 'mongoose';
import { IsNotEmpty, IsOptional } from 'class-validator';

export type ProductDocument = Product & Document;

@Schema()
export class Product {
  _id: MongooseSchema.Types.ObjectId;

  @Prop({ type: MongooseSchema.Types.String, required: true })
  @IsNotEmpty()
  sku: string;

  @Prop({ type: MongooseSchema.Types.String, required: true })
  @IsNotEmpty()
  title: string;

  @Prop({ type: MongooseSchema.Types.Number, required: true })
  @IsNotEmpty()
  price: number;

  @Prop({ type: MongooseSchema.Types.Number, required: true })
  @IsNotEmpty()
  stock: number;

  @Prop({ type: MongooseSchema.Types.Boolean, required: true })
  @IsNotEmpty()
  discontinued: boolean;

  @Prop({ type: MongooseSchema.Types.Date, required: true })
  @IsNotEmpty()
  restocked_at: Date;
}

export const ProductSchema = SchemaFactory.createForClass(Product);

Sampel ialah satu dokumen yang diisi sepenuhnya, jadi setiap field mendapat required: true dan @IsNotEmpty(). restocked_at ialah string berformat tarikh, jadi jenisnya Date, dan property mengekalkan nama kunci tersimpan restocked_at.

Ciri yang disokong

  • Jenis Mongoose dinyatakan secara eksplisit, cth. @Prop({ type: MongooseSchema.Types.String, required: true }). Schema Mongoose diimport sebagai MongooseSchema supaya tidak bertembung dengan decorator Schema.
  • Jenis TypeScript: number, boolean, Date untuk string tarikh ISO 8601, string untuk yang lain termasuk string yang terdiri daripada digit sahaja seperti "0042".
  • Objek bersarang diisytiharkan dengan MongooseSchema.Types.Mixed dan berjenis Record<string, unknown>; array satu jenis nilai biasa menjadi, contohnya, [MongooseSchema.Types.String] dengan string[].
  • Nama property ialah kunci JSON tanpa diubah, dipetik apabila perlu ('home-url': string), jadi kelas itu sepadan dengan dokumen yang sudah ada dalam collection.
  • Field yang mempunyai nilai tidak kosong dalam setiap dokumen mendapat required: true serta @IsNotEmpty(); selebihnya hanya mendapat @IsOptional(). Kunci _id dalam input dilangkau kerana _id: MongooseSchema.Types.ObjectId sudah diisytiharkan.
  • export type ProductDocument = Product & Document dijana untuk injection seperti @InjectModel(Product.name) model: Model<ProductDocument>.

Kes penggunaan

Menambah collection pada perkhidmatan NestJS

Masukkan payload event yang dihantar oleh pasukan lain, atau JSON daripada scraper, untuk mendapatkan kelas skema, kemudian inject dengan @InjectModel dan terus panggil create atau find.

Memindahkan model Mongoose Express ke NestJS

Eksport beberapa dokumen yang disimpan oleh model lama new Schema({...}) dan tampalkannya di sini untuk menulis semula sebagai kelas berasaskan decorator tanpa field tercicir semasa menyalinnya secara manual.

Nota dan had

  • @IsNotEmpty() dan @IsOptional() terletak pada kelas skema, tetapi ValidationPipe mengesahkan DTO controller. Untuk mengesahkan request, pindahkan decorator ini ke kelas DTO atau cipta satu.
  • @Schema() tiada opsyen, jadi nama collection mengikut peraturan Mongoose yang menukar nama model kepada huruf kecil dan bentuk jamak: products. Tetapkan @Schema({ collection: 'product' }) jika anda memerlukan nama tertentu.
  • Field opsyenal tetap dikeluarkan tanpa ? (cth. memo: string). Dengan strictNullChecks, menukarnya kepada memo?: string adalah lebih selamat.
  • Sub-dokumen disimpan sebagai Mixed, bukan skema berjenis. Untuk validasi di dalamnya, takrifkan kelas @Schema() yang berasingan dan gunakan @Prop({ type: SubSchema }).

Soalan lazim

Kenapa & Document dan bukan extend Document?

Ia mengikut corak lalai dalam dokumentasi NestJS: kelas skema kekal sebagai definisi field biasa dan ProductDocument hanya digunakan di tempat yang memerlukan method dokumen Mongoose seperti save(). Pada Mongoose 7+, HydratedDocument<Product> ialah alternatif yang boleh terus digunakan.

Bagaimana jika projek saya tidak menggunakan class-validator?

Padam baris import { IsNotEmpty, IsOptional } from 'class-validator' dan dua decorator pada setiap field. Tingkah laku skema dikawal oleh required dalam @Prop() sahaja.

Adakah saya perlu menyatakan type dalam @Prop()?

Dengan emitDecoratorMetadata, jenis mudah boleh disimpulkan, tetapi inferens gagal untuk array dan union seperti Date | null. Kod yang dijana menyatakan type sejak awal supaya tingkah laku kekal sama apabila anda kemudiannya menukar jenis TypeScript sesuatu property.