如何无需重启代码刷新已编辑的MongoDB Mongoose模型？

问题出在哪 #

1. Node.js的require缓存：第一次加载模型文件后，后续调用require会直接复用缓存里的旧文件内容，不会读取你修改后的新代码
2. 模型导出方式错误：当前模型文件直接导出编译好的Mongoose模型（model('Alerts', Alerts)），第一次加载就会注册到Mongoose。后续刷新时即便清空了Mongoose的模型缓存，重新require还是会拿到缓存里的旧模型，且你提取的model.schema也不是更新后的结构

修复步骤 #

1. 修改模型文件的导出逻辑 #

不要提前编译模型，只导出Schema结构：

const { Schema } = require('mongoose');

const AlertsSchema = new Schema({
    guildId: {
        type: String,
        required: true,
    },
    channelId: {
        type: String,
        required: true,
    },
    test: {
        type: String,
        required: true,
    }, 
});

module.exports = AlertsSchema;

2. 刷新时清除Node.js的require缓存 #

在原有代码基础上，新增清除Node.js层面的文件缓存逻辑：

const mongoose = require('mongoose');
const fs = require('fs');
const path = require('path');

function refreshModels() {
    try {
        // 清空Mongoose的模型和Schema缓存
        mongoose.models = {};
        mongoose.modelSchemas = {};

        const modelsPath = path.join(__dirname, '../models');
        const modelFiles = fs.readdirSync(modelsPath).filter(file => file.endsWith('.js'));

        for (const file of modelFiles) {
            const filePath = path.join(modelsPath, file);
            // 删除Node.js的require缓存，确保重新读取最新文件
            delete require.cache[require.resolve(filePath)];
            // 重新加载最新的Schema
            const schema = require(filePath);
            const modelName = path.basename(file, '.js');
            // 编译新模型并注册到Mongoose
            mongoose.model(modelName.charAt(0).toUpperCase() + modelName.slice(1), schema);
        }

        console.log('Models have been refreshed');
    } catch (error) {
        console.log('Error refreshing models:', error);
    }
}

module.exports = refreshModels;

3. 业务代码中使用最新模型 #

不要提前缓存模型实例，每次操作数据库时从mongoose.models中获取最新模型：

// 不要提前缓存模型（会拿旧实例）
// const Alerts = require('../models/alerts');

// 每次使用时获取最新模型
const getAlertsModel = () => mongoose.model('Alerts');

// 示例用法
async function createAlert(data) {
    const Alerts = getAlertsModel();
    return await Alerts.create(data);
}

注意事项 #

• 这种热刷新方式仅适合开发环境调试，生产环境建议通过进程重启保证稳定性
• 如果模型文件依赖其他模块，需按需清除对应模块的require缓存，但一般模型文件依赖较少，仅处理自身即可

内容的提问来源于stack exchange，提问作者2milliongunguy