【问题标题】:Hot Code Push NodeJS热代码推送 NodeJS
【发布时间】:2012-11-23 04:49:29
【问题描述】:

我一直试图弄清楚 Node.js 上的这种“热代码推送”。基本上,我的主文件(当您键入 node app.js 时运行)包含一些设置、配置和初始化。在那个文件中,我有一个文件观察器,使用 chokidar。当我的文件被添加时,我只是require 文件。如果文件已更改或更新,我将删除缓存delete require.cache[path],然后重新请求它。所有这些模块都不会导出任何东西,它只适用于单个全局 Storm 对象。

Storm.watch = function() {
    var chokidar, directories, self = this;
    chokidar = require('chokidar');
    directories = ['server/', 'app/server', 'app/server/config', 'public'];
    clientPath = new RegExp(_.regexpEscape(path.join('app', 'client')));
    watcher = chokidar.watch(directories, {
    ignored: function(_path) {
        if (_path.match(/\./)) {
            !_path.match(/\.(js|coffee|iced|styl)$/);
        } else {
            !_path.match(/(app|config|public)/);
        }
    },
    persistent: true
    });


    watcher.on('add', function(_path){
    self.fileCreated(path.resolve(Storm.root, _path));
    //Storm.logger.log(Storm.cliColor.green("File Added: ", _path));
    //_console.info("File Updated");
    console.log(Storm.css.compile('     {name}: {file}', "" +
        "name" +
        "{" +
        "color: white;" +
        "font-weight:bold;" +
        "}" +
        "hr {"  +
        "background: grey" +
        "}")({name: "File Added", file: _path.replace(Storm.root, ""), hr: "=================================================="}));
    });

    watcher.on('change', function(_path){
    _path = path.resolve(Storm.root, _path);
    if (fs.existsSync(_path)) {
        if (_path.match(/\.styl$/)) {
            self.clientFileUpdated(_path);
        } else {
            self.fileUpdated(_path);
        }
    } else {
        self.fileDeleted(_path);
    }
    //Storm.logger.log(Storm.cliColor.green("File Changed: ", _path));
    console.log(Storm.css.compile('     {name}: {file}', "" +
        "name" +
        "{" +
        "color: yellow;" +
        "font-weight:bold;" +
        "}" +
        "hr {"  +
        "background: grey" +
        "}")({name: "File Changed", file: _path.replace(Storm.root, ""), hr: "=================================================="}));
    });

    watcher.on('unlink', function(_path){
    self.fileDeleted(path.resolve(Storm.root, _path));
    //Storm.logger.log(Storm.cliColor.green("File Deleted: ", _path));
    console.log(Storm.css.compile('     {name}: {file}', "" +
        "name" +
        "{" +
        "color: red;" +
        "font-weight:bold;" +
        "}" +
        "hr {"  +
        "background: grey" +
        "}")({name: "File Deleted", file: _path.replace(Storm.root, ""), hr: "=================================================="}));
    });

    watcher.on('error', function(error){
    console.log(error);
    });


};


Storm.watch.prototype.fileCreated = function(_path) {

    if (_path.match('views')) {
    return;
    }

    try {
    require.resolve(_path);
    } catch (error) {
    require(_path);
    }

};


Storm.watch.prototype.fileDeleted = function(_path) {
    delete require.cache[require.resolve(_path)];
};

Storm.watch.prototype.fileUpdated = function(_path) {
    var self = this;
    pattern = function(string) {
    return new RegExp(_.regexpEscape(string));
    };

    if (_path.match(pattern(path.join('app', 'templates')))) {
    Storm.View.cache = {};
    } else if (_path.match(pattern(path.join('app', 'helpers')))) {
    self.reloadPath(path, function(){
        self.reloadPaths(path.join(Storm.root, 'app', 'controllers'));
    });
    } else if (_path.match(pattern(path.join('config', 'assets.coffee')))) {
    self.reloadPath(_path, function(error, config) {
        //Storm.config.assets = config || {};
    });
    } else if (_path.match(/app\/server\/(models|controllers)\/.+\.(?:coffee|js|iced)/)) {
    var isController, directory, klassName, klass;

    self.reloadPath(_path, function(error, config) {
        if (error) {
            throw new Error(error);
        }
    });

    Storm.serverRefresh();

    isController = RegExp.$1 == 'controllers';
    directory    = 'app/' + RegExp.$1;
    klassName = _path.split('/');
    klassName = klassName[klassName.length - 1];
    klassName = klassName.split('.');
    klassName.pop();
    klassName = klassName.join('.');
    klassName = _.camelize(klassName);

    if (!klass) {
        require(_path);
    } else {
        console.log(_path);
        self.reloadPath(_path)
    }

    } else if (_path.match(/config\/routes\.(?:coffee|js|iced)/)) {
    self.reloadPath(_path);
    } else {
    this.reloadPath(_path);
    }

};

Storm.watch.prototype.reloadPath = function(_path, cb) {

    _path = require.resolve(path.resolve(Storm.root, path.relative(Storm.root, _path)));
    delete require.cache[_path];
    delete require.cache[path.resolve(path.join(Storm.root, "server", "application", "server.js"))];
    //console.log(require.cache[path.resolve(path.join(Storm.root, "server", "application", "server.js"))]);
    require("./server.js");

    Storm.App.use(Storm.router);

    process.nextTick(function(){
    Storm.serverRefresh();
    var result = require(_path);
    if (cb) {
        cb(null, result);
    }
    });
};


Storm.watch.prototype.reloadPaths = function(directory, cb) {



};

有些代码不完整/没有使用,因为我正在尝试很多不同的方法。

工作原理:

如下代码:

function run() {
   console.log(123);
}

完美运行。但是任何异步代码都无法更新。

问题 = 异步代码

app.get('/', function(req, res){
   // code here..
});

如果我在 nodejs 进程运行时更新文件,则不会发生任何事情,尽管它通过文件观察程序并删除缓存,然后重新建立。另一个不起作用的例子是:

// middleware.js
function hello(req, res, next) {
  // code here...
}

// another file:
app.use(hello);

因为 app.use 仍将使用该方法的旧版本。

问题:

我该如何解决这个问题?我有什么遗漏吗?

请不要提出永远使用第 3 方模块的建议。我正在尝试将功能合并到单个实例中。

编辑:

在研究了流星代码库(node.js 或浏览器中关于“热代码推送”的资源非常少。)并修改了我自己的实现之后,我成功地制定了一个可行的解决方案。 https://github.com/TheHydroImpulse/Refresh.js 。这仍处于开发的早期阶段,但现在看起来很稳固。我也将实施一个浏览器解决方案,只是为了完成。

【问题讨论】:

    标签: javascript node.js livereload


    【解决方案1】:

    删除require 的缓存实际上并不会“卸载”您的旧代码,也不会撤消该代码所做的操作。

    以如下函数为例:

    var callbacks=[];
    registerCallback = function(cb) {
        callbacks.push(cb);
    };
    

    现在假设您有一个调用该全局函数的模块。

    registerCallback(function() { console.log('foo'); });
    

    在您的应用启动后,callbacks 将拥有一项。现在我们将修改模块。

    registerCallback(function() { console.log('bar'); });
    

    您的“热补丁”代码运行,删除 require.cached 版本并重新加载模块。

    您必须意识到现在callbacks两个 项。首先,它引用了记录 foo 的函数(在应用启动时添加)引用了记录 bar 的函数(刚刚添加)。

    即使您删除了对模块exports 的缓存引用,您实际上无法删除该模块。就 JavaScript 运行时而言,您只需删除 一个 引用出来的很多。您的应用程序的任何其他部分仍然可以挂起对旧模块中某些内容的引用。

    这正是您的 HTTP 应用程序正在发生的事情。当应用程序首次启动时,您的模块会将匿名回调附加到路由。当您修改这些模块时,它们会将新的回调附加到相同的路由;旧的回调不会被删除。我猜你正在使用 Express,它按照添加的顺序调用路由处理程序。因此,新的回调永远不会有机会运行。


    说实话,我不会使用这种方法在修改时重新加载您的应用。大多数人在假设环境干净的情况下编写应用程序初始化代码;你违反了这个假设,在肮脏的环境中运行初始化代码——也就是说,一个已经启动并运行的环境。

    尝试清理环境以使您的初始化代码运行几乎可以肯定比它的价值更麻烦。当您的基础文件发生更改时,我只需重新启动整个应用程序即可。

    【讨论】:

    • 谢谢。是的,这很有意义。如果我要使用我以前的方法,我将不得不编写很多边缘案例来删除旧的引用,但这不会大规模工作。我将简单地重新启动整个应用程序。再次感谢您的澄清。
    【解决方案2】:

    Meteor 通过允许模块“注册”自己作为热代码推送过程的一部分来解决这个问题。

    他们在reload 包中实现了这一点:

    https://github.com/meteor/meteor/blob/master/packages/reload/reload.js#L105-L109

    我在 GitHub 上的一些插件中看到了 Meteor.reload API,但他们也在 session 包中使用它:

    https://github.com/meteor/meteor/blob/master/packages/session/session.js#L103-L115

    if (Meteor._reload) {
      Meteor._reload.onMigrate('session', function () {
        return [true, {keys: Session.keys}];
      });
    
      (function () {
        var migrationData = Meteor._reload.migrationData('session');
        if (migrationData && migrationData.keys) {
          Session.keys = migrationData.keys;
        }
      })();
    }
    

    所以基本上,当页面/窗口加载时,meteor 会运行“迁移”,并且由包来定义数据/方法/等。在进行热代码推送时会重新计算。

    他们的livedata package(搜索reload)也在使用它。

    在刷新之间,他们使用window.sessionStorage 保存“状态”。

    【讨论】:

      猜你喜欢
      • 2015-05-09
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2016-03-16
      • 2018-08-28
      • 1970-01-01
      • 1970-01-01
      • 2013-02-23
      相关资源
      最近更新 更多