NestJS+Mongoose实现新店铺创建时自动填充商品种子数据的方法
通过Mongoose钩子实现新店自动填充测试商品的落地方案
核心思路
选择Shop模型的后置保存钩子实现逻辑,核心优势是:
- 触发时机严格在Shop记录成功落库之后,能拿到生成的真实店铺ID关联商品,不会出现脏数据
- 逻辑和数据模型绑定,不管是哪个接口、哪个模块触发的Shop新建操作,都会自动执行填充逻辑,不会漏触发
- 不需要手动执行命令,也不需要耦合Nest应用启动的生命周期逻辑,完全按照数据库写操作的节奏触发
具体实现步骤
1. 提前加载测试商品JSON数据
在模块加载阶段一次性读取测试JSON到内存缓存,不要每次触发钩子都读磁盘文件,减少IO消耗。
2. 在Shop Schema上挂载后置保存钩子
直接在生成的ShopSchema实例上绑定钩子逻辑,代码修改点如下:
// shop.schema.ts import { Schema, SchemaFactory, Prop } from '@nestjs/mongoose'; import { Document, Types } from 'mongoose'; // 模块加载时一次性读取测试商品JSON import * as mockTestProducts from '../../mock/test-products.json'; @Schema({ timestamps: true }) export class Shop extends Document { @Prop({ required: true, index: { unique: true } }) id: string; @Prop({ required: true, index: { unique: true } }) shop: string; @Prop({ required: true }) accessToken: string; @Prop({ required: true }) scope: string; @Prop({ type: Date }) expires: Date; @Prop({ type: Boolean }) isOnline: boolean; @Prop({ type: String }) state: string; } export const ShopSchema = SchemaFactory.createForClass(Shop); // 绑定单条文档保存成功后的钩子 ShopSchema.post('save', async function (createdShop: Shop) { // 加环境开关:按需控制是否触发自动填充,比如生产环境可关闭 if (process.env.ENABLE_AUTO_PRODUCT_SEED !== 'true') return; // 给测试商品绑定当前新建店铺的真实MongoDB _id const seedProducts = mockTestProducts.map(item => ({ ...item, shopId: createdShop._id as Types.ObjectId })); // 动态获取Product模型,避免和Product Schema产生循环依赖 const ProductModel = this.model.db.model('Product'); // 批量插入商品,失败单独捕获日志,不影响Shop本身的创建结果 try { await ProductModel.insertMany(seedProducts, { ordered: false }); } catch (err) { console.error(`店铺[${createdShop.shop}]自动填充测试商品失败:`, err); } });
必须注意的避坑点
- 绝对不要用
pre('save')钩子:这个钩子在Shop写入数据库之前触发,此时还拿不到MongoDB自动生成的_id,会导致商品关联的店铺ID错误 - 避免循环依赖:不要在Shop Schema文件中直接导入ProductModel,通过钩子上下文的
this.model.db.model('Product')动态拉取模型,能彻底绕开两个Schema互相引用的问题 - 做好错误隔离:自动填充测试商品是附加逻辑,不要把填充失败的异常抛出阻断主流程的Shop创建操作,单独捕获错误打日志即可
- 覆盖全量创建场景:
- 如果项目中存在通过
Model.insertMany批量创建Shop的场景,单条save钩子不会触发,需要额外给ShopSchema.post('insertMany')补对应逻辑 - 如果项目是通过
findOneAndUpdate带upsert: true参数创建新Shop的,save钩子同样不会触发,需要给findOneAndUpdate绑后置钩子,判断本次操作是否为新建文档后再触发填充逻辑
- 如果项目中存在通过
- 加配置开关:生产环境正式上线时关闭自动填充测试数据的开关,避免测试数据污染正式库
内容的提问来源于stack exchange,提问作者Niroj
相关产品推荐
相关产品推荐

