Node热部署

开发的node应用程序要发布，需要重新启动node应用程序进程，如果刚好有用户正在访问可能会返回502错误码，体验会很差所以就需要Node热部署。

参考链接smart-node-reload

如下是Node热部署实现的方式：

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

const handlerMap = {};
const hotsPath = path.join(__dirname, 'hots');

//加载文件代码并监听指定文件夹目录文件内容变动
const loadHandlers = async () => {
    //遍历出指定文件夹下的所有文件
    const files = await new Promise((resolve, reject) => {
        fs.readdir(hotsPath, (error, files) => {
            if (error) {
                reject(error);
            } else {
                resolve(files)
            }
        })
    })

    //初始化加载所有文件 把每个文件结果缓存到handlerMap变量当中
    for (let f in files) {
        handlerMap[files[f]] = await loadHandler(path.join(hotsPath, files[f]));
    }

    //监听指定文件夹的文件内容变动
    await watchHandlers();
};

//监听指定文件夹下的文件变动
const watchHandlers = async () => {
    //这里建议用chokidar的npm包代替文件夹监听
    fs.watch(hotsPath, { recursive: true }, async (eventType, filename) => {
        //获取每个文件的绝对路径
        //包一层require.resolve的原因是 拼接好路径后 它会帮你判断这个路径下的文件是否存在
        const targetFile = require.resolve(hotsPath, filename);
        //当使用require加载一个模块后，模块的数据就会缓存到require.cache中，下次再加载相同模块，就会从缓存中获取文件
        //所以热加载部署，首先要做的就是清除require.cache中对应文件的缓存

        const cacheModule = require.cache[targetFile];
        //去除掉在require.cache缓存中parent对当前模块的引用，否则会引起内存泄露，具体查看下面的文档
        //《记录一次由一行代码引发的“血案》https://cnodejs.org/topic/5aaba2dc19b2e3db18959e63
        //《一行 delete require.cache 引发的内存泄露血案》https://zhuanlan.zhihu.com/p/34702356
        // 其他文件引用还是会有缓存 上面只是删除了当前文件的引用
        if (cacheModule.parent) {
            cacheModule.parent.children.splice(cacheModule.parent.children.indexOf(cacheModule), 1)
        }

        //清除指定路径对应模块的require.cache缓存
        require.cache[targetFile] = null;

        //重新加载发生变动后的模块文件，实现热加载部署效果，并将重新加载后的结果，更新到handlerMap变量中
        const code = await loadHandler(targetFile);
        handlerMap[filename] = code;
        console.log("热部署文件：", filename, "，执行结果：", handlerMap);
    })
}

//加载指定文件的代码
const loadHandler = filename => {
    return new Promise((resolve, reject) => {
        fs.readFile(filename, (err, data) => {
            if (err) {
                resolve(null)
            } else {
                try {
                    //使用vm模块的script方法来预编译发生变化后的文件代码，检查语法错误，提前发现是否存在的语法错误
                    new vm.Script(data);
                } catch (e) {
                    //语法错误，编译错误
                    reject(e);
                    return;
                }

                //编译通过后，重新require加载最新的代码
                resolve(require(filename));
            }
        })
    })
}

loadHandlers();