แปลง JSON เป็น Mongoose (JavaScript) แผน!

ป้อน JSON และแปลงเป็น Mongoose (JavaScript) แผน! รองรับ Mongoose new Schema, mongoose.model, MongoDB, Node.js
JSON
ผลลัพธ์
 

แปลง JSON เป็น Mongoose (JavaScript) แผน!

วางเอกสารที่ตั้งใจจะเก็บใน MongoDB แล้วจะได้ไฟล์ schema ของ Mongoose แบบ CommonJS: ฟิลด์ที่นิยามด้วย new Schema({...}) โมเดลที่ลงทะเบียนด้วย mongoose.model() และ module.exports ไว้ท้ายไฟล์ บันทึกลงโฟลเดอร์ models/ ของโปรเจกต์ Express แล้ว require ใช้ได้ทันที

path ของฟิลด์ใช้คีย์ JSON ตรงตามเดิม schema จึงอ่านเอกสารที่มีอยู่แล้วในคอลเลกชันได้โดยไม่ต้องเปลี่ยนชื่ออะไร เมื่อวางอาร์เรย์ของเอกสาร คีย์จากทุกเอกสารจะถูกรวมเป็น schema เดียว

วิธีใช้

  1. วางเอกสารเดียว (ออบเจ็กต์) หรือหลายเอกสาร (อาร์เรย์) ผลลัพธ์จาก mongoexport ที่ครอบด้วยอาร์เรย์ก็ใช้ได้
  2. ใส่ ชื่อโมเดล (ค่าเริ่มต้น MyModel) มีช่องว่างได้ เช่น blog comment จะกลายเป็น BlogComment
  3. บันทึกผลลัพธ์เป็นไฟล์อย่าง models/Comment.js แล้วโหลดใน router ด้วย const Comment = require('./models/Comment')

ตัวอย่าง

อินพุต (JSON)
[
  { "author": "mina", "body": "Great post!", "likes": 3, "approved": true, "posted_at": "2024-05-01T09:30:00Z" },
  { "author": "leo", "body": "Typo in step 2", "likes": 0, "approved": false, "posted_at": "2024-05-02T11:00:00Z", "reply_to": "6634a1" }
]
เอาต์พุต (Mongoose (JavaScript))
const mongoose = require('mongoose');
const { Schema } = mongoose;

const commentSchema = new Schema({
  _id: { type: Schema.Types.ObjectId, auto: true },
  author: { type: Schema.Types.String, required: true },
  body: { type: Schema.Types.String, required: true },
  likes: { type: Schema.Types.Number, required: true },
  approved: { type: Schema.Types.Boolean, required: true },
  posted_at: { type: Schema.Types.Date, required: true },
  reply_to: { type: Schema.Types.String }
});

const Comment = mongoose.model('Comment', commentSchema);

module.exports = Comment;

reply_to มีแค่ในคอมเมนต์ที่สอง จึงถูกสร้างโดยไม่มี required และ posted_at ซึ่งเป็นสตริงวันที่แบบ ISO กลายเป็น Schema.Types.Date ทั้งสองยังคงชื่อแบบ snake_case เพราะ path ใน schema ต้องตรงกับคีย์ที่เก็บไว้

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

  • ไทป์ของฟิลด์: ตัวเลข → Schema.Types.Number, true/false → Schema.Types.Boolean, สตริง ISO 8601 อย่าง 2024-05-01 หรือ 2024-05-01T09:30:00Z → Schema.Types.Date, สตริงอื่น → Schema.Types.String
  • ตัวเลขในเครื่องหมายคำพูดอย่าง "01234" ยังเป็น String รหัสไปรษณีย์และเบอร์โทรจึงคงศูนย์นำหน้าไว้
  • ออบเจ็กต์ที่ซ้อนกันเป็น Schema.Types.Mixed อาร์เรย์ของค่าธรรมดาชนิดเดียวกันเป็นอาร์เรย์ที่มีไทป์อย่าง [Schema.Types.String] นอกนั้นเป็น [Schema.Types.Mixed]
  • required: true ถูกเพิ่มเฉพาะเมื่อทุกเอกสารมีค่าที่ไม่ว่าง อาร์เรย์ไม่เคยได้ เพราะ Mongoose เติม [] ให้อาร์เรย์ที่ไม่มีค่า
  • คีย์ _id ที่คัดลอกมาจากการ export จะถูกตัดออก และ schema ประกาศ _id: { type: Schema.Types.ObjectId, auto: true } แทน
  • คีย์ที่ไม่ใช่ identifier ที่ถูกต้องของ JavaScript อย่าง home-url จะถูกเขียนเป็นคีย์ในเครื่องหมายคำพูด

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

ไฟล์โมเดลแรกของ API แบบ Express + MongoDB

ถ้าตกลง request body กับ frontend ไว้แล้ว ให้แปลง JSON นั้นเป็นร่าง schema แล้วต่อเข้ากับ Comment.create(req.body) ใน route POST ได้เลย

จัดระเบียบคอลเลกชันที่โตมาโดยไม่มี schema

ดึงเอกสารสักสองสามตัวจากคอลเลกชันที่ถูกเติมด้วย strict: false หรือ native driver ฟิลด์ไหนมีเสมอและฟิลด์ไหนมีแค่บางครั้งจะเห็นได้ทันทีจากการมีหรือไม่มี required

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

  • โมเดลถูกลงทะเบียนเป็น mongoose.model('Comment', ...) และ Mongoose จะแปลงชื่อนั้นเป็นตัวพิมพ์เล็กและพหูพจน์เพื่อเลือกคอลเลกชัน: comments ถ้าคอลเลกชันที่มีอยู่ใช้ชื่ออื่น ให้ส่งอาร์กิวเมนต์ตัวที่สาม
  • ฟิลด์ Mixed ไม่ถูกติดตามเมื่อแก้ไขค่าข้างใน หลังแก้ค่าที่ซ้อนอยู่ให้เรียก doc.markModified('profile') ก่อน save() หรือเปลี่ยนฟิลด์นั้นเป็น sub-schema
  • ไม่สร้างค่าเริ่มต้น index หรือ constraint unique ให้เพิ่ม unique: true หรือ index: true ที่ฟิลด์ที่ใช้ค้นหา

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

ขอเป็นไวยากรณ์ ES module (import / export default) ได้ไหม?

หน้านี้สร้างเฉพาะ CommonJS ที่ใช้ require และ module.exports ในโปรเจกต์ "type": "module" ให้เปลี่ยนสองบรรทัดแรกเป็น import mongoose, { Schema } from 'mongoose' และบรรทัดสุดท้ายเป็น export default Comment สำหรับ TypeScript หรือ NestJS ให้ใช้หน้า JSON → Mongoose (TS) แทน

จะได้ createdAt และ updatedAt อัตโนมัติอย่างไร?

โค้ดที่สร้างไม่มี schema option ให้เพิ่มอาร์กิวเมนต์ตัวที่สอง new Schema({...}, { timestamps: true }) แล้ว Mongoose จะดูแลทั้งสองฟิลด์ให้ และลบฟิลด์ชื่อเดียวกันที่มาจาก JSON ออก

ถ้าบันทึกสตริงว่างลงในฟิลด์ required จะเกิดอะไรขึ้น?

validator required ของ Mongoose สำหรับสตริงถือว่า "" คือไม่มีค่า นั่นคือเหตุผลที่ฟิลด์ซึ่งเป็นสตริงว่างในตัวอย่างถูกสร้างโดยไม่มี required ตั้งแต่แรก