入口程序app.js解读

前言

在入门文章部分，我们已经知道，Node.js的应用最终都可以合并成一个文件，为了开发方便，才将其拆分成多个文件。

被拆分的那个文件，自然是我们重点研究的对象，通常这个文件就是App.js或server.js，大家称之为入口程序。

显然Ebookcoin用的就是app.js。这一篇，我们就来阅读一下该文件，学习研究它的整体架构流程。

源码

地址： https://github.com/Ebookcoin/ebookcoin/blob/v0.1.3/app.js

类图

js原本无类，因此它的类图并不好处理，仅能大致给出它与其他模块的关联关系。

appjs-uml

解读

直接读代码看看。

1.配置处理

任何一个应用，都会提供一些参数。对这些参数的处理，有很多种方案。但总的来说，通常需要提供一种理想环境，即默认配置，同时给你一种方法自行修改。

（1）全局默认配置

通常默认参数较少时，可以硬编码到代码里。但更灵活的方式，就是使用单独文件。这里就使用了文件 ./config.json 来保存全局配置，如：

  1. {
  2.     "port": 7000,
  3.     "address": "0.0.0.0",
  4.     "serveHttpAPI": true,
  5.     "serveHttpWallet": true,
  6.     "version": "0.1.1",
  7.     "fileLogLevel": "info",
  8.     "consoleLogLevel": "log",
  9.     "sharePort": true,
  10.     ...

使用时，只需要require就可以了。源码：

  1. var appConfig = require("./config.json"); // app.js 4行

不过，为了灵活性，默认值通常允许用户修改。

（2）使用commander组件，引入命令行选项

commander是Node.js第三方组件（使用npm安装），常被用来开发命令行工具，用法极为简单，详细内容请看开发实践部分的分享。源码：

  1. // 1行
  2. var program = require('commander');
  4. // 19行
  5. program
  6.     .version(packageJson.version)
  7.     .option('-c, --config <path>', 'Config file path')
  8.     .option('-p, --port <port>', 'Listening port number')
  9.     .option('-a, --address <ip>', 'Listening host name or ip')
  10.     .option('-b, --blockchain <path>', 'Blockchain db path')
  11.     .option('-x, --peers [peers...]', 'Peers list')
  12.     .option('-l, --log <level>', 'Log level')
  13.     .parse(process.argv);

这样，就可以在命令行执行命令时，加带-c,-p等选项，例如：

  1. node app.js -p 8888

这时，该选项就以program.port的形式被保存，于是手动修改一下：

  1. // 39行
  2. if (program.port) {
  3.     appConfig.port = program.port;
  4. }

这是处理Node.js应用全局配置的一种常用且简单的方式，值得学习。

更多内容，我们在下一篇对commander组件进行详细介绍。

2.异常捕捉

我们在第一部分总结时，特意提到异常要捕捉，这里我们很轻松就可以看出来，代码对全局异常处理的方式。

注意：对于domain模块，已经不提倡使用，这部分代码将再后续的更新中去除，这里仅做了解就是了。

（1）使用uncaughtException捕捉进程异常

  1. // 65行
  2. process.on('uncaughtException', function (err) {
  3.     // handle the error safely
  4.     logger.fatal('System error', { message: err.message, stack: err.stack });
  5.     process.emit('cleanup');
  6. });

（2）使用domain模块捕获全局异常

  1. // 96行
  2. var d = require('domain').create();
  3. d.on('error', function (err) {
  4.     logger.fatal('Domain master', { message: err.message, stack: err.stack });
  5.     process.exit(0);
  6. });
  7. d.run(function () {
  8. ...

另外，对各个模块，也使用了domain

  1. // 415行
  2. var d = require('domain').create();
  4. d.on('error', function (err) {
  5. scope.logger.fatal('domain ' + name, {message: err.message, stack: err.stack});
  6. });
  7. ...

3.模块加载

这才是真正的重点，不过看过代码，发现一切都那么干净利略，也没有多层回调那些大坑，原来是用了async流程管理组件。

整体使用async.auto进行顺序调用；在加载modules时，又使用async.parallel，使其并行运作;当发生错误时，清理工作用到了async.eachSeries。

下图是手工简单画的，说明了从代码103-438行之间，各模块的加载运行顺序。

async-for-modules

下篇，我们也有必要对async组件进行详解梳理。这里，您只要能猜出代码意图，就不用太操心async的用法。下面，读读有关源码：

（1）初始网络

我们从packages.json里看到使用了Express框架。通过前面部分的介绍，知道必须在入口程序里，初始化才对。具体如何调用的？下面的代码，显然十分熟悉。

我们知道，Express是Node.js重要的web开发框架，这里的网络network本质上就是以Express为基础的web应用，自然白皮书才会宣扬基于Http协议。

  1. // 215行
  2. network: ['config', function (cb, scope) {
  3.     var express = require('express');
  4.     var app = express();
  5.     var server = require('http').createServer(app);
  6.     var io = require('socket.io')(server);
  8.     if (scope.config.ssl.enabled) {
  9.         var privateKey = fs.readFileSync(scope.config.ssl.options.key);
  10.         var certificate = fs.readFileSync(scope.config.ssl.options.cert);
  12.         var https = require('https').createServer({
  13.     ...

说明：这是async.auto常用的方法，network用到的任何需要回调的方法（这里是config），都放在这个数组里，最后的回调函数(function (cb, scope) {//code})，可以巧妙的调用，如： scope.config。

这里的代码，仅仅初始化服务，没有做太多实质的事情，真正的动作在下面。

（2）构建链接

从下面的代码开始，我们才能看到这个应用的本质。270行代码用到了network等，如下：

  1. // 270行
  2. connect: ['config', 'public', 'genesisblock', 'logger', 'build', 'network', function (cb, scope) {

接着，下面的代码，加载了几个中间件，告诉我们，该应用接受ejs模板驱动的html文件，视图文件和图片、样式等静态文件都在public文件夹等，这些信息绝对比官方文档还有用。

  1. // 277行
  2. scope.network.app.engine('html', require('ejs').renderFile);
  3. scope.network.app.use(require('express-domain-middleware'));
  4. scope.network.app.set('view engine', 'ejs');
  5. scope.network.app.set('views', path.join(__dirname, 'public'));
  6. scope.network.app.use(scope.network.express.static(path.join(__dirname, 'public')));
  7. ...

再下来，就是对请求参数和响应数据的处理，包括对节点peers中黑名单、白名单的过滤等，最后启动服务操作：

  1. // 336行
  2. scope.network.server.listen(scope.config.port, scope.config.address, function (err) {

（3）加载逻辑

看代码知道，其核心逻辑功能是：账户管理、交易和区块链。这些模块，本质上是对数据库操作的封装，account与modules/accounts模块对应，transaction与modules/transactions模块对应，block与modules/blocks模块对应，我们会在介绍相关模块时，一起分析。

  1. // 379行
  2. logic: ['dbLite', 'bus', 'scheme', 'genesisblock', function (cb, scope) {
  4.     // 嵌套了async.auto
  5.     async.auto({
  6.         ...
  7.         account: ["dbLite", "bus", "scheme", 'genesisblock', function (cb, scope) {
  8.             new Account(scope, cb);
  9.         }],
  10.         transaction: ["dbLite", "bus", "scheme", 'genesisblock', "account", function (cb, scope) {
  11.             new Transaction(scope, cb);
  12.         }],
  13.         block: ["dbLite", "bus", "scheme", 'genesisblock', "account", "transaction", function (cb, scope) {
  14.             new Block(scope, cb);
  15.         }]
  16.     }, cb);
  17.     ...

（4）加载模块

上面所有代码的执行结果，都要被这里的各模块共享。下面的代码说明，各个模块都采用一致（不一定一样）的参数和处理方法，这样处理起来简单方便：

  1. // 411行
  2. modules: ['network', 'connect', 'config', 'logger', 'bus', 'sequence', 'dbSequence', 'balancesSequence', 'dbLite', 'logic', function (cb, scope) {
  4.     // 对每个模块都使用`domain`监控其错误
  5.     Object.keys(config.modules).forEach(function (name) {
  6.         tasks[name] = function (cb) {
  7.             var d = require('domain').create();
  9.             d.on('error', function (err) {
  10.                 ...
  11.             });
  13.             d.run(function () {
  14.                 ...
  15.             });
  16.         }
  17.     });
  19.     // 让各个模块并行运行
  20.     async.parallel(tasks, function (err, results) {
  21.         cb(err, results);
  22.     });

这里的模块既然都是并行处理，研究它们就不需要分先后了。

总结

这篇文章总算深入代码了，但是仍然较为粗略。不过，对整个应用的基本架构已经了然。继续深入研究，方向路线也已然清晰。

代码中还有很多细节，我们并没有逐行介绍。个人认为，读代码就像看文章，先要概览，逐步深入，不一定一开始就逐字逐句去读，那样效率低、效果差。

对于这个app.js文件，成手读它可能就是分分钟的事情，而写出来却要罗嗦这么多。如果，你并没有觉得很轻松，甚至理解很困难，那么可能缺少对commander、domain和async等组件或模块的了解，请看下一篇：《Node.js开发加密货币》之七： 技术研究——commander、domain和async介绍