Node.js 代码阅读笔记系列 — process.nextTick() 的实现

eth 以太坊系列线下活动：《开发者的以太坊进阶指南》北京站来了！开发者的以太坊进阶指南 | Jeth 以太坊系列线下活动第四期北京场

process 是一个全局对象，它提供了当前 Node.js 线程的相关信息和一些控制方法。因为 process 挂载了太多属性和方法，这篇文章先从 process.nextTick() 开始吧。

setupNextTick

function setupNextTick() {
	// 设置 Promise 模块的调度方法
  const promises = require('internal/process/promises');
  const emitPendingUnhandledRejections = promises.setup(scheduleMicrotasks);
  
  var nextTickQueue = [];
  // microtask 标记
  var microtasksScheduled = false;

  // 接收 V8  micro task 队列的运行的对象.
  var _runMicrotasks = {};

  // 这里 kIndex kLength 是一个约定的 Environment::TickInfo 的 index 和 length 的索引 
  var kIndex = 0;
  var kLength = 1;

  process.nextTick = nextTick;
  // Needs to be accessible from beyond this scope.
  process._tickCallback = _tickCallback;
  process._tickDomainCallback = _tickDomainCallback;
  
  // 通过 process._setupNextTick 注册 _tickCallback， 获取 _runMicrotasks
  // `tickInfo` 也接收了 `process._setupNextTick()` 的返回参数，通过 `tickInfo` 能使 C++ 模块能访问到 nextTick 队列的状态。
  
  const tickInfo = process._setupNextTick(_tickCallback, _runMicrotasks);
	
	// 接收驱动 V8's micro task 队列的方法
  _runMicrotasks = _runMicrotasks.runMicrotasks;
	
	function tickDone() {
	...
	}
	
	function scheduleMicrotasks() {
	...
	}
	
	function runMicrotasksCallback() {
	...
	}
	
	function _combinedTickCallback() {
	...
	}
	
	function _tickCallback() {
	...
	}
	
	function _tickDomainCallback() {
	...
	}
	
	function nextTick() {
	...
	}
}

_tickCallback & _tickDomainCallback

这里两个大体都是执行一定数量（ 最大 1e4 ）的数量 callbacks， 前者不需要执行 domain 进入上下文。

function _tickCallback() {
    var callback, args, tock;

    do {
      while (tickInfo[kIndex] < tickInfo[kLength]) {
        tock = nextTickQueue[tickInfo[kIndex]++];
        callback = tock.callback;
        args = tock.args;
        _combinedTickCallback(args, callback);
        if (kMaxCallbacksPerLoop < tickInfo[kIndex])
          tickDone();
      }
      tickDone();
      // V8 promise microtasks
      _runMicrotasks();
      emitPendingUnhandledRejections();
    } while (tickInfo[kLength] !== 0);
  }

_combinedTickCallback

这里的参数处理还是体现了 Nodejs 中贯穿的性能追求以及 80/20 的理念。

function _combinedTickCallback(args, callback) {
    if (args === undefined) {
      callback();
    } else {
      switch (args.length) {
        case 1:
          callback(args[0]);
          break;
        case 2:
          callback(args[0], args[1]);
          break;
        case 3:
          callback(args[0], args[1], args[2]);
          break;
        default:
          callback.apply(null, args);
      }
    }
  }

tickDone

执行正常的清理操作，删除刚执行完的 callback 或者 清空队列。

function tickDone() {
    if (tickInfo[kLength] !== 0) {
      if (tickInfo[kLength] <= tickInfo[kIndex]) {
        nextTickQueue = [];
        tickInfo[kLength] = 0;
      } else {
      	 // 推出队列的首个元素
        nextTickQueue.splice(0, tickInfo[kIndex]);
        tickInfo[kLength] = nextTickQueue.length;
      }
    }
    tickInfo[kIndex] = 0;
  }

scheduleMicrotasks

再回头看一下 setupNextTick 中的 Promise setup 那段 promises.setup(scheduleMicrotasks)。下面我们来看看 scheduleMicrotasks.

function setupNextTick() {
  const promises = require('internal/process/promises');
  const emitPendingUnhandledRejections = promises.setup(scheduleMicrotasks);
  var microtasksScheduled = false;
  ...
}

先判断 microtasksScheduled ，如果为 false 就会执行到给 nextTickQueue 添加一个新的节点，callback 为 runMicrotasksCallback。接着 tickInfo[kLength] 增加 1 并将 microtasksScheduled 设置为 true , 确保在未执行 microtask 之前不会重复执行。

function scheduleMicrotasks() {
    if (microtasksScheduled)
      return;

    nextTickQueue.push({
      callback: runMicrotasksCallback,
      domain: null
    });

    tickInfo[kLength]++;
    microtasksScheduled = true;
  }

runMicrotasksCallback

可以看到这里与之前对应的， 这里首先执行 microtasksScheduled = false, 接着调用 _runMicrotasks。在 nextTickQueue 以及 Promise 还有 Listeners 时继续调用 scheduleMicrotasks 来向 nextTickQueue 添加 callback。

function runMicrotasksCallback() {
    microtasksScheduled = false;
    _runMicrotasks();

    if (tickInfo[kIndex] < tickInfo[kLength] ||
        emitPendingUnhandledRejections())
      scheduleMicrotasks();
  }

SetupNextTick

通过上面的 JS 部分我们了解到，process.nextTick, Microtasks 以及 Promise 的 callback 都是通过一个队列 nextTickQueue 调度, 而这一切都是从
_tickCallback （ _tickDomainCallback ）开始的。

// src/node.cc
void SetupNextTick(const FunctionCallbackInfo& args) {
  Environment* env = Environment::GetCurrent(args);

  CHECK(args[0]->IsFunction());
  CHECK(args[1]->IsObject());

  // 将之前的 `_tickCallback` 设置到环境变量中 tick_callback_function
  env->set_tick_callback_function(args[0].As());
	
	// 将传过来的 _runMicrotasks ({}) 对象添加 runMicrotasks 方法
  env->SetMethod(args[1].As