Node.js - 阿里Egg的多程式模型和程式間通訊

前言

最近用Egg作為底層框架開發專案，好奇其多程式模型的管理實現，於是學習瞭解了一些東西，順便記錄下來。文章如有錯誤， 請輕噴

為什麼需要多程式

伴隨科技的發展， 現在的伺服器基本上都是多核cpu的了。然而，Node是一個單程式單執行緒語言（對於開發者來說是單執行緒，實際上不是）。我們都知道，cpu的排程單位是執行緒，而基於Node的特性，那麼我們每次只能利用一個cpu。這樣不僅僅利用率極低，而且容錯更是不能接受（出錯時會崩潰整個程式）。所以，Node有了cluster來協助我們充分利用伺服器的資源。

cluster工作原理
關於cluster的工作原理推薦大家看這篇文章,這裡簡單總結一下：

1. 子程式的埠監聽會被hack掉，而是統一由master的內部TCP監聽，所以不會出現多個子程式監聽同一埠而報錯的現象。
2. 請求統一經過master的內部TCP，TCP的請求處理邏輯中，會挑選一個worker程式向其傳送一個newconn內部訊息，隨訊息傳送客戶端控制程式碼。（這裡的挑選有兩種方式，第一種是除Windows外所有平臺的預設方法迴圈法，即由主程式負責監聽埠，接收新連線後再將連線迴圈分發給工作程式。在分發中使用了一些內建技巧防止工作程式任務過載。第二種是主程式建立監聽socket後傳送給感興趣的工作程式，由工作程式負責直接接收連線。）
3. worker程式收到控制程式碼後，建立客戶端例項(net.socket)執行具體的業務邏輯，然後返回。

如圖：

圖引用出處

多程式模型

先看一下Egg官方文件的程式模型

                +--------+          +-------+
                | Master |<-------->| Agent |
                +--------+          +-------+
                ^   ^    ^
               /    |     \
             /      |       \
           /        |         \
         v          v          v
+----------+   +----------+   +----------+
| Worker 1 |   | Worker 2 |   | Worker 3 |
+----------+   +----------+   +----------+
複製程式碼

型別	程式數量	作用	穩定性	是否執行業務程式碼
Master	1	程式管理，程式間訊息轉發	非常高	否
Agent	1	後臺執行工作（長連線客戶端）	高	少量
Worker	一般為cpu核數	執行業務程式碼	一般	是

大致上就是利用Master作為主執行緒，啟動Agent作為祕書程式協助Worker處理一些公共事務（日誌之類），啟動Worker程式執行真正的業務程式碼。

多程式的實現

流程相關程式碼

首先從Master入手，這裡暫時認為Master是最頂級的程式（事實上還有一個parent程式，待會再說）。

/**
 * start egg app
 * @method Egg#startCluster
 * @param {Object} options {@link Master}
 * @param {Function} callback start success callback
 */
exports.startCluster = function(options, callback) {
  new Master(options).ready(callback);
};
複製程式碼

先從Master的建構函式看起

constructor(options) {
  super();
  // 初始化引數
  this.options = parseOptions(options);
  // worker程式的管理類 詳情見 Manager及Messenger篇
  this.workerManager = new Manager();
  // messenger類， 詳情見 Manager及Messenger篇
  this.messenger = new Messenger(this);
  // 設定一個ready事件 詳情見get-ready npm包
  ready.mixin(this);
  // 是否為生產環境
  this.isProduction = isProduction();
  this.agentWorkerIndex = 0;
  // 是否關閉
  this.closed = false;
  ...

  接下來看的是ready的回撥函式及註冊的各類事件：
  this.ready(() => {
    // 將開始狀態設定為true
    this.isStarted = true;
    const stickyMsg = this.options.sticky ? ' with STICKY MODE!' : '';
    this.logger.info('[master] %s started on %s (%sms)%s',
    frameworkPkg.name, this[APP_ADDRESS], Date.now() - startTime, stickyMsg);

    // 傳送egg-ready至各個程式並觸發相關事件
    const action = 'egg-ready';
    this.messenger.send({ action, to: 'parent', data: { port: this[REALPORT], address: this[APP_ADDRESS] } });
    this.messenger.send({ action, to: 'app', data: this.options });
    this.messenger.send({ action, to: 'agent', data: this.options });
    // start check agent and worker status
    this.workerManager.startCheck();
    });
    // 註冊各類事件
    this.on('agent-exit', this.onAgentExit.bind(this));
    this.on('agent-start', this.onAgentStart.bind(this));
    ...
    // 檢查埠並 Fork一個Agent
    detectPort((err, port) => {
      ... 
      this.forkAgentWorker();
    }
  });
}
複製程式碼

綜上， 可以看到Master的建構函式主要是初始化和註冊各類相應的事件， 最後執行的是forkAgentWorker函式， 該函式的關鍵程式碼可以看到：

const agentWorkerFile = path.join(__dirname, 'agent_worker.js');
// 通過child_process執行一個Agent
const agentWorker = childprocess.fork(agentWorkerFile, args, opt);
複製程式碼

繼續到agent_worker.js上面看，agent_worker例項化一個agent物件，agent_worker.js有一句關鍵程式碼：

agent.ready(() => {
  agent.removeListener('error', startErrorHandler); // 清除錯誤監聽的事件
  process.send({ action: 'agent-start', to: 'master' }); // 向master傳送一個agent-start的動作
});
複製程式碼

可以看到， agent_worker.js中的程式碼向master發出了一個資訊， 動作為agent-start， 再回到Master中， 可以看到其註冊了兩個事件， 分別為once的forkAppWorkers和 on的onAgentStart

this.on('agent-start', this.onAgentStart.bind(this));
this.once('agent-start', this.forkAppWorkers.bind(this));
複製程式碼

先看onAgentStart函式， 這個函式相對簡單， 就是一些資訊的傳遞：

onAgentStart() {
    this.agentWorker.status = 'started';

    // Send egg-ready when agent is started after launched
    if (this.isAllAppWorkerStarted) {
      this.messenger.send({ action: 'egg-ready', to: 'agent', data: this.options });
    }

    this.messenger.send({ action: 'egg-pids', to: 'app', data: [ this.agentWorker.pid ] });
    // should send current worker pids when agent restart
    if (this.isStarted) {
      this.messenger.send({ action: 'egg-pids', to: 'agent', data: this.workerManager.getListeningWorkerIds() });
    }

    this.messenger.send({ action: 'agent-start', to: 'app' });
    this.logger.info('[master] agent_worker#%s:%s started (%sms)',
      this.agentWorker.id, this.agentWorker.pid, Date.now() - this.agentStartTime);
  }
複製程式碼

然後會執行forkAppWorkers函式，該函式主要是藉助cfork包fork對應的工作程式， 並註冊一系列相關的監聽事件,

...
cfork({
  exec: this.getAppWorkerFile(),
  args,
  silent: false,
  count: this.options.workers,
  // don't refork in local env
  refork: this.isProduction,
});
...
// 觸發app-start事件
cluster.on('listening', (worker, address) => {
  this.messenger.send({
    action: 'app-start',
    data: { workerPid: worker.process.pid, address },
    to: 'master',
    from: 'app',
  });
});
複製程式碼

可以看到forkAppWorkers函式在監聽Listening事件時，會觸發master上的app-start事件。

this.on('app-start', this.onAppStart.bind(this));

...
// master ready回撥觸發
if (this.options.sticky) {
  this.startMasterSocketServer(err => {
    if (err) return this.ready(err);
      this.ready(true);
  });
} else {
  this.ready(true);
}

// ready回撥 傳送egg-ready狀態到各個程式
const action = 'egg-ready';
this.messenger.send({ action, to: 'parent', data: { port: this[REALPORT], address: this[APP_ADDRESS] } });
this.messenger.send({ action, to: 'app', data: this.options });
this.messenger.send({ action, to: 'agent', data: this.options });

// start check agent and worker status
if (this.isProduction) {
  this.workerManager.startCheck();
}
複製程式碼

總結下：

1. Master.constructor: 先執行Master的建構函式， 裡面有個detect函式被執行
2. Detect: Detect => forkAgentWorker()
3. forkAgentWorker: 獲取Agent程式， 向master觸發agent-start事件
4. 執行onAgentStart函式， 執行forkAppWorker函式（once）
5. onAgentStart => 傳送各類資訊, forkAppWorker => 向master觸發 app-start事件
6. App-start事件 觸發 onAppStart()方法
7. onAppStart => 設定ready(true) => 執行ready的回撥函式
8. Ready() = > 傳送egg-ready到各個程式並觸發相關事件, 執行startCheck()函式

+---------+           +---------+          +---------+
|  Master |           |  Agent  |          |  Worker |
+---------+           +----+----+          +----+----+
     |      fork agent     |                    |
     +-------------------->|                    |
     |      agent ready    |                    |
     |<--------------------+                    |
     |                     |     fork worker    |
     +----------------------------------------->|
     |     worker ready    |                    |
     |<-----------------------------------------+
     |      Egg ready      |                    |
     +-------------------->|                    |
     |      Egg ready      |                    |
     +----------------------------------------->|
複製程式碼

程式守護

根據官方文件，程式守護主要是依賴於graceful和egg-cluster這兩個庫。

未捕獲異常

1. 關閉異常 Worker 程式所有的 TCP Server（將已有的連線快速斷開，且不再接收新的連線），斷開和 Master 的 IPC 通道，不再接受新的使用者請求。
2. Master 立刻 fork 一個新的 Worker 程式，保證線上的『工人』總數不變。
3. 異常 Worker 等待一段時間，處理完已經接受的請求後退出。

+---------+                 +---------+
|  Worker |                 |  Master |
+---------+                 +----+----+
     | uncaughtException         |
     +------------+              |
     |            |              |                   +---------+
     | <----------+              |                   |  Worker |
     |                           |                   +----+----+
     |        disconnect         |   fork a new worker    |
     +-------------------------> + ---------------------> |
     |         wait...           |                        |
     |          exit             |                        |
     +-------------------------> |                        |
     |                           |                        |
    die                          |                        |
                                 |                        |
                                 |                        |
複製程式碼

由執行的app檔案可知， app實際上是繼承於Application類, 該類下面呼叫了graceful()。

onServer(server) {
    ......
    graceful({
      server: [ server ],
      error: (err, throwErrorCount) => {
        ......
      },
    });
    ......
  }
複製程式碼

繼續看graceful， 可以看到它捕獲了process.on('uncaughtException')事件， 並在回撥函式裡面關閉TCP連線， 關閉本身程式， 斷開與master的IPC通道。

process.on('uncaughtException', function (err) {
    ......
    // 對http連線設定 Connection: close響應頭
    servers.forEach(function (server) {
      if (server instanceof http.Server) {
        server.on('request', function (req, res) {
          // Let http server set `Connection: close` header, and close the current request socket.
          req.shouldKeepAlive = false;
          res.shouldKeepAlive = false;
          if (!res._header) {
            res.setHeader('Connection', 'close');
          }
        });
      }
    });

    // 設定一個定時函式關閉子程式， 並退出本身程式
    // make sure we close down within `killTimeout` seconds
    var killtimer = setTimeout(function () {
      console.error('[%s] [graceful:worker:%s] kill timeout, exit now.', Date(), process.pid);
      if (process.env.NODE_ENV !== 'test') {
        // kill children by SIGKILL before exit
        killChildren(function() {
          // 退出本身程式
          process.exit(1);
        });
      }
    }, killTimeout);

    // But don't keep the process open just for that!
    // If there is no more io waitting, just let process exit normally.
    if (typeof killtimer.unref === 'function') {
      // only worked on node 0.10+
      killtimer.unref();
    }

    var worker = options.worker || cluster.worker;

    // cluster mode
    if (worker) {
      try {
        // 關閉TCP連線
        for (var i = 0; i < servers.length; i++) {
          var server = servers[i];
          server.close();
        }
      } catch (er1) {
        ......
      }

      try {
        // 關閉ICP通道
        worker.disconnect();
      } catch (er2) {
        ......
      }
    }
  });
複製程式碼

ok, 關閉了IPC通道後， 我們繼續看cfork檔案， 即上面提到的fork worker的包， 裡面監聽了子程式的disconnect事件， 他會根據條件判斷是否重新fork一個新的子程式

cluster.on('disconnect', function (worker) {
    ......
    // 存起該pid
    disconnects[worker.process.pid] = utility.logDate();
    if (allow()) {
      // fork一個新的子程式
      newWorker = forkWorker(worker._clusterSettings);
      newWorker._clusterSettings = worker._clusterSettings;
    } else {
      ......
    }
  });
複製程式碼

一般來說， 這個時候會繼續等待一會然後就執行了上面說到的定時函式了， 即退出程式。

OOM、系統異常 關於這種系統異常， 有時候在子程式中是不能捕獲到的， 我們只能在master中進行處理， 也就是cfork包。

cluster.on('exit', function (worker, code, signal) {
    // 是程式異常的話， 會通過上面提到的uncatughException重新fork一個子程式， 所以這裡就不需要了
    var isExpected = !!disconnects[worker.process.pid];
    if (isExpected) {
      delete disconnects[worker.process.pid];
      // worker disconnect first, exit expected
      return;
    }
    // 是master殺死的子程式， 無需fork
    if (worker.disableRefork) {
      // worker is killed by master
      return;
    }

    if (allow()) {
      newWorker = forkWorker(worker._clusterSettings);
      newWorker._clusterSettings = worker._clusterSettings;
    } else {
      ......
    }
    cluster.emit('unexpectedExit', worker, code, signal);
  });
複製程式碼

程式間通訊（IPC）

上面一直提到各種程式間通訊，細心的你可能已經發現 cluster 的 IPC 通道只存在於 Master 和 Worker/Agent 之間，Worker 與 Agent 程式互相間是沒有的。那麼 Worker 之間想通訊該怎麼辦呢？是的，通過 Master 來轉發。

廣播訊息： agent => all workers
                  +--------+          +-------+
                  | Master |<---------| Agent |
                  +--------+          +-------+
                 /    |     \
                /     |      \
               /      |       \
              /       |        \
             v        v         v
  +----------+   +----------+   +----------+
  | Worker 1 |   | Worker 2 |   | Worker 3 |
  +----------+   +----------+   +----------+

指定接收方： one worker => another worker
                  +--------+          +-------+
                  | Master |----------| Agent |
                  +--------+          +-------+
                 ^    |
     send to    /     |
    worker 2   /      |
              /       |
             /        v
  +----------+   +----------+   +----------+
  | Worker 1 |   | Worker 2 |   | Worker 3 |
  +----------+   +----------+   +----------+
複製程式碼

在master中， 可以看到當agent和app被fork時， 會監聽他們的資訊， 同時將資訊轉化成一個物件:

agentWorker.on('message', msg => {
  if (typeof msg === 'string') msg = { action: msg, data: msg };
  msg.from = 'agent';
  this.messenger.send(msg);
});

worker.on('message', msg => {
  if (typeof msg === 'string') msg = { action: msg, data: msg };
  msg.from = 'app';
  this.messenger.send(msg);
});
複製程式碼

可以看到最後呼叫的是messenger.send, 而messengeer.send就是根據from和to來決定將資訊傳送到哪裡

send(data) {
    if (!data.from) {
      data.from = 'master';
    }
    ......

    // app -> master
    // agent -> master
    if (data.to === 'master') {
      debug('%s -> master, data: %j', data.from, data);
      // app/agent to master
      this.sendToMaster(data);
      return;
    }

    // master -> parent
    // app -> parent
    // agent -> parent
    if (data.to === 'parent') {
      debug('%s -> parent, data: %j', data.from, data);
      this.sendToParent(data);
      return;
    }

    // parent -> master -> app
    // agent -> master -> app
    if (data.to === 'app') {
      debug('%s -> %s, data: %j', data.from, data.to, data);
      this.sendToAppWorker(data);
      return;
    }

    // parent -> master -> agent
    // app -> master -> agent，可能不指定 to
    if (data.to === 'agent') {
      debug('%s -> %s, data: %j', data.from, data.to, data);
      this.sendToAgentWorker(data);
      return;
    }
  }
複製程式碼

master則是直接根據action資訊emit對應的註冊事件

sendToMaster(data) {
  this.master.emit(data.action, data.data);
}
複製程式碼

而agent和worker則是通過一個sendmessage包， 實際上就是呼叫下面類似的方法

 // 將資訊傳給子程式
 agent.send(data)
 worker.send(data)
複製程式碼

最後， 在agent和app都繼承的基礎類EggApplication上， 呼叫了Messenger類， 該類內部的建構函式如下：

constructor() {
    super();
    ......
    this._onMessage = this._onMessage.bind(this);
    process.on('message', this._onMessage);
  }

_onMessage(message) {
    if (message && is.string(message.action)) {
      // 和master一樣根據action資訊emit對應的註冊事件  
      this.emit(message.action, message.data);
    }
  }
複製程式碼

總結一下：
思路就是利用事件機制和IPC通道來達到各個程式之間的通訊。

其他

學習過程中有遇到一個timeout.unref()的函式， 關於該函式推薦大家參考這個問題的6樓回答

總結

從前端思維轉到後端思維其實還是很吃力的，加上Egg的程式管理實現確實非常厲害， 所以花了很多時間在各種api和思路思考上。

參考與引用

多程式模型和程式間通訊
Egg 原始碼解析之 egg-cluster