AI 助理
备案控制台
开发者社区 开发与运维 文章 正文

[Node.js源码解读(1)]Node.js的启动过程

2018-05-14 2358
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介：

本文原载于https://github.com/DavidCai1993/my-blog/issues/26 经原作者授权连载于alinode官方博客，未经原作者允许，不得转载。

大家可能会好奇，在 Node.js 启动后，第一个执行的 JavaScript 文件会是哪个？它具体又会干些什么事？

一步步来看，翻开 Node.js 的源码，不难看出，入口文件在 src/node_main.cc 中，主要任务为将参数传入 node::Start 函数：

// src/node_main.cc
// ...

int main(int argc, char *argv[]) {
  setvbuf(stderr, NULL, _IOLBF, 1024);
  return node::Start(argc, argv);
}

node::Start 函数定义于 src/node.cc 中，它进行了必要的初始化工作后，会调用 StartNodeInstance ：

// src/node.cc
// ...

int Start(int argc, char** argv) {
    // ...
    NodeInstanceData instance_data(NodeInstanceType::MAIN,
                                   uv_default_loop(),
                                   argc,
                                   const_cast<const char**>(argv),
                                   exec_argc,
                                   exec_argv,
                                   use_debug_agent);
    StartNodeInstance(&instance_data);
}

而在 StartNodeInstance 函数中，又调用了 LoadEnvironment 函数，其中的 ExecuteString(env, MainSource(env), script_name); 步骤，便执行了第一个 JavaScript 文件代码：

// src/node.cc
// ...
void LoadEnvironment(Environment* env) {
  // ...
  Local<Value> f_value = ExecuteString(env, MainSource(env), script_name);
  // ...
}

static void StartNodeInstance(void* arg) {
  // ...
  {
      Environment::AsyncCallbackScope callback_scope(env);
      LoadEnvironment(env);
  }
  // ...
}

// src/node_javascript.cc
// ...

Local<String> MainSource(Environment* env) {
  return String::NewFromUtf8(
      env->isolate(),
      reinterpret_cast<const char*>(internal_bootstrap_node_native),
      NewStringType::kNormal,
      sizeof(internal_bootstrap_node_native)).ToLocalChecked();
}

其中的 internal_bootstrap_node_native ，即为 lib/internal/bootstrap_node.js 中的代码。（注：很多以前的 Node.js 源码分析文章中，所写的第一个执行的 JavaScript 文件代码为 src/node.js ，但这个文件在 Node.js v5.10 中已被移除，并被拆解为了 lib/internal/bootstrap_node.js 等其他 lib/internal 下的文件，PR 为： https://github.com/nodejs/node/pull/5103 ）

正文

作为第一段被执行的 JavaScript 代码，它的历史使命免不了就是进行一些环境和全局变量的初始化工作。代码的整体结构很简单，所有的初始化逻辑都被封装在了 startup 函数中：

// lib/internal/bootstrap_node.js
'use strict';

(function(process) {
  function startup() {
    // ...
  }
  // ...
  startup();
});

而在 startup 函数中，逻辑可以分为四块：

  • 初始化全局 process 对象上的部分属性 / 行为
  • 初始化全局的一些 timer 方法
  • 初始化全局 console 等对象
  • 开始执行用户执行指定的 JavaScript 代码

让我们一个个来解析。

初始化全局 process 对象上的部分属性 / 行为

添加 process 上 uncaughtException 事件的默认行为

在 Node.js 中，如果没有为 process 上的 uncaughtException 事件注册监听器，那么该事件触发时，将会导致进程退出，这个行为便是在 startup 函数里添加的：

// lib/internal/bootstrap_node.js
'use strict';

(function(process) {
  function startup() {
    setupProcessFatal();
  }
  // ...

  function setupProcessFatal() {

    process._fatalException = function(er) {
      var caught;
      // ...
      if (!caught)
        caught = process.emit('uncaughtException', er);

      if (!caught) {
        try {
          if (!process._exiting) {
            process._exiting = true;
            process.emit('exit', 1);
          }
        } catch (er) {
        }
      }
      // ...
      return caught;
    };
  }
});

逻辑十分直白，使用到了 EventEmitter#emit 的返回值来判断该事件上是否有注册过的监听器，并最终调用 c++ 的 exit() 函数退出进程：

// src/node.cc
// ...

void FatalException(Isolate* isolate,
                    Local<Value> error,
                    Local<Message> message) {
  // ...
  Local<Value> caught =
      fatal_exception_function->Call(process_object, 1, &error);

  // ...
  if (false == caught->BooleanValue()) {
    ReportException(env, error, message);
    exit(1);
  }
}

根据 Node.js 在启动时所带的某些参数，来调整 process 上 warning 事件触发时的行为

具体来说，这些参数是：--no-warnings，--no-deprecation，--trace-deprecation 和 --throw-deprecation。这些参数的有无信息，会先被挂载在 process 对象上：

// src/node.cc
// ...

  if (no_deprecation) {
    READONLY_PROPERTY(process, "noDeprecation", True(env->isolate()));
  }

  if (no_process_warnings) {
    READONLY_PROPERTY(process, "noProcessWarnings", True(env->isolate()));
  }

  if (trace_warnings) {
    READONLY_PROPERTY(process, "traceProcessWarnings", True(env->isolate()));
  }

  if (throw_deprecation) {
    READONLY_PROPERTY(process, "throwDeprecation", True(env->isolate()));
  }

然后根据这些信息，控制行为：

// lib/internal/bootstrap_node.js
'use strict';

(function(process) {
  function startup() {
    // ...
    NativeModule.require('internal/process/warning').setup();
  }
  // ...
  startup();
});
// lib/internal/process/warning.js
'use strict';

const traceWarnings = process.traceProcessWarnings;
const noDeprecation = process.noDeprecation;
const traceDeprecation = process.traceDeprecation;
const throwDeprecation = process.throwDeprecation;
const prefix = `(${process.release.name}:${process.pid}) `;

exports.setup = setupProcessWarnings;

function setupProcessWarnings() {
  if (!process.noProcessWarnings) {
    process.on('warning', (warning) => {
      if (!(warning instanceof Error)) return;
      const isDeprecation = warning.name === 'DeprecationWarning';
      if (isDeprecation && noDeprecation) return;
      const trace = traceWarnings || (isDeprecation && traceDeprecation);
      if (trace && warning.stack) {
        console.error(`${prefix}${warning.stack}`);
      } else {
        var toString = warning.toString;
        if (typeof toString !== 'function')
          toString = Error.prototype.toString;
        console.error(`${prefix}${toString.apply(warning)}`);
      }
    });
  }
  // ...
}

具体行为的话，文档中已经有详细说明，逻辑总结来说，就是按需将警告打印到控制台，或者按需抛出特定的异常。其中 NativeModule 对象为 Node.js 在当前的函数体的局部作用域内，实现的一个最小可用的模块加载器，具有缓存等基本功能。

为 process 添加上 stdin, stdout 和 stderr 属性

通常为 tty.ReadStream 类和 tty.WriteStream 类的实例：

// lib/internal/bootstrap_node.js
'use strict';

(function(process) {
  function startup() {
    // ...
    NativeModule.require('internal/process/stdio').setup();
  }
  // ...
  startup();
});
// lib/internal/process/stdio.js
// ...

function setupStdio() {
  var stdin, stdout, stderr;

  process.__defineGetter__('stdout', function() {
    if (stdout) return stdout;
    stdout = createWritableStdioStream(1);
    // ...
    return stdout
  }

  process.__defineGetter__('stderr', function() {
    if (stderr) return stderr;
    stderr = createWritableStdioStream(2);
    // ...
    return stderr;
  });

  process.__defineGetter__('stdin', function() {
    if (stdin) return stdin;

    var tty_wrap = process.binding('tty_wrap');
    var fd = 0;

    switch (tty_wrap.guessHandleType(fd)) {
      case 'TTY':
        var tty = require('tty');
        stdin = new tty.ReadStream(fd, {
          highWaterMark: 0,
          readable: true,
          writable: false
        });
        break;
      // ...
    }
    return stdin;
  }
}

function createWritableStdioStream(fd) {
  var stream;
  var tty_wrap = process.binding('tty_wrap');

  // Note stream._type is used for test-module-load-list.js

  switch (tty_wrap.guessHandleType(fd)) {
    case 'TTY':
      var tty = require('tty');
      stream = new tty.WriteStream(fd);
      stream._type = 'tty';
      break;
    // ...
  }
  // ...
}

为 process 添加上 nextTick 方法

具体的做法便是将注册的回调推进队列中，等待事件循环的下一次 Tick ，一个个取出执行：

// lib/internal/bootstrap_node.js
'use strict';

(function(process) {
  function startup() {
    // ...
    NativeModule.require('internal/process/next_tick').setup();
  }
  // ...
  startup();
});
// lib/internal/process/next_tick.js
'use strict';

exports.setup = setupNextTick;

function setupNextTick() {
  var nextTickQueue = [];
  // ...
  var kIndex = 0;
  var kLength = 1;

  process.nextTick = nextTick;
  process._tickCallback = _tickCallback;

  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 (1e4 < tickInfo[kIndex])
          tickDone();
      }
      tickDone();
    } while (tickInfo[kLength] !== 0);
  }

  function nextTick(callback) {
    if (typeof callback !== 'function')
      throw new TypeError('callback is not a function');
    if (process._exiting)
      return;

    var args;
    if (arguments.length > 1) {
      args = new Array(arguments.length - 1);
      for (var i = 1; i < arguments.length; i++)
        args[i - 1] = arguments[i];
    }

    nextTickQueue.push(new TickObject(callback, args));
    tickInfo[kLength]++;
  }
}
// ...

为 process 添加上 hrtime, kill, exit 方法

// lib/internal/bootstrap_node.js
'use strict';

(function(process) {
  function startup() {
    // ...
    _process.setup_hrtime();
    _process.setupKillAndExit();
  }
  // ...
  startup();
});

这些功能的核心实现也重度依赖于 c++ 函数：

  • hrtime 方法依赖于 libuv 提供的 uv_hrtime() 函数
  • kill 方法依赖于 libuv 提供的 uv_kill(pid, sig) 函数
  • exit 方法依赖于 c++ 提供的 exit(code) 函数

初始化全局的一些 timer 方法和 console 等对象

这些初始化都干的十分简单，直接赋值：

// lib/internal/bootstrap_node.js
'use strict';

(function(process) {
  function startup() {
    // ...
    setupGlobalVariables();
    if (!process._noBrowserGlobals) {
      setupGlobalTimeouts();
      setupGlobalConsole();
    }

    function setupGlobalVariables() {
      global.process = process;
      // ...
      global.Buffer = NativeModule.require('buffer').Buffer;
      process.domain = null;
      process._exiting = false;
    }

    function setupGlobalTimeouts() {
      const timers = NativeModule.require('timers');
      global.clearImmediate = timers.clearImmediate;
      global.clearInterval = timers.clearInterval;
      global.clearTimeout = timers.clearTimeout;
      global.setImmediate = timers.setImmediate;
      global.setInterval = timers.setInterval;
      global.setTimeout = timers.setTimeout;
    }

    function setupGlobalConsole() {
      global.__defineGetter__('console', function() {
        return NativeModule.require('console');
      });
    }
  }
  // ...
  startup();
});

值得注意的一点是，由于 console 是通过 __defineGetter__ 赋值给 global 对象的，所以在严格模式下给它赋值将会抛出异常，而非严格模式下，赋值将被忽略。

开始执行用户执行指定的 JavaScript 代码

这一部分的逻辑已经在之前的文章中有所阐述，这边就不再重复说明啦。

最后

还是再次总结下:

  • lib/internal/bootstrap_node.js 中的代码 为 Node.js 执行后第一段被执行的 JavaScript 代码，从 src/node.cc 中的 node::LoadEnvironment 被调用

  • lib/internal/bootstrap_node.js 主要进行了一些初始化工作：

    • 初始化全局 process 对象上的部分属性 / 行为

      • 添加接收到 uncaughtException 事件时的默认行为
      • 根据 Node.js 启动时参数，调整 warning 事件的行为
      • 添加上 stdin，stdout 和 stderr 属性
      • 添加上 nextTick，hrtime，exit 方法
    • 初始化全局的一些 timer 方法
    • 初始化全局 console 等对象
    • 开始执行用户执行指定的 JavaScript 代码

参考

文章标签：
JavaScript
C++
前端开发
关键词：
JavaScript源码
JavaScript Node
JavaScript Node.js
node.js js
源码JavaScript
_朴灵_
目录
相关文章
疯狂的猿
|
24天前
|
JavaScript
JS实现简单的打地鼠小游戏源码
这是一款基于JS实现简单的打地鼠小游戏源码。画面中的九宫格中随机出现一个地鼠，玩家移动并点击鼠标控制画面中的锤子打地鼠。打中地鼠会出现卡通爆破效果。同时左上角统计打地鼠获得的分数
疯狂的猿
51 1
路边两盏灯
|
22天前
|
JavaScript 前端开发
【Azure Developer】在使用Azure Bot Service JavaScript的实例代码遇见Cannot find module 'node:crypto'
Error: Cannot find module 'node:crypto'
路边两盏灯
43 6
【Azure Developer】在使用Azure Bot Service JavaScript的实例代码遇见Cannot find module 'node:crypto'
温轻舟
|
15天前
|
前端开发 JavaScript
用HTML CSS JS打造企业级官网 —— 源码直接可用
必看！用HTML+CSS+JS打造企业级官网-源码直接可用，文章代码仅用于学习，禁止用于商业
温轻舟
67 1
疯狂的猿
|
21天前
|
JavaScript
JS趣味打字金鱼小游戏特效源码
hi fish是一款打字趣味小游戏，捞出海里的鱼，捞的越多越好。这款游戏用于电脑初学者练习打字。初学者可以根据自己的水平设置游戏难度。本段代码可以在各个网页使用，有需要的朋友可以直接下载使用，本段代码兼容目前最新的各类主流浏览器，是一款非常优秀的特效源码！
疯狂的猿
29 3
疯狂的猿
|
23天前
|
JavaScript
JS鼠标框选并删除HTML源码
这是一个js鼠标框选效果，可实现鼠标右击出现框选效果的功能。右击鼠标可拖拽框选元素，向下拖拽可实现删除效果，简单实用，欢迎下载
疯狂的猿
38 4
疯狂的猿
|
23天前
|
JavaScript
js实现简洁实用的网页计算器功能源码
这是一款使用js实现简洁实用的网页计算器功能源码。可实现比较基本的加减乘除四则运算功能，界面简洁实用，是一款比较基本的js运算功能源码。该源码可兼容目前最新的各类主流浏览器。
疯狂的猿
24 2
疯狂的猿
|
22天前
|
移动开发 HTML5
html5+three.js公路开车小游戏源码
html5公路开车小游戏是一款html5基于three.js制作的汽车开车小游戏源代码，在公路上开车网页小游戏源代码。
疯狂的猿
52 0
html5+three.js公路开车小游戏源码
疯狂的猿
|
22天前
|
JavaScript
JS趣味打字金鱼小游戏特效源码
hi fish是一款打字趣味小游戏，捞出海里的鱼，捞的越多越好。这款游戏用于电脑初学者练习打字。初学者可以根据自己的水平设置游戏难度。本段代码可以在各个网页使用，有需要的朋友可以直接下载使用，本段代码兼容目前最新的各类主流浏览器，是一款非常优秀的特效源码！
疯狂的猿
33 0
JS趣味打字金鱼小游戏特效源码
进步`于辰
|
23天前
|
JavaScript 前端开发 中间件
JS服务端技术—Node.js知识点
本文介绍了Node.js中的几个重要模块，包括NPM、Buffer、fs模块、path模块、express模块、http模块以及mysql模块。每部分不仅提供了基础概念，还推荐了相关博文供深入学习。特别强调了express模块的使用，包括响应相关函数、中间件、Router和请求体数据解析等内容。文章还讨论了静态资源无法访问的问题及其解决方案，并总结了一些通用设置。适合Node.js初学者参考学习。
进步`于辰
33 1
dasein58
|
JavaScript Java 程序员
[Coke,浏览器,JS,Node,js]Node.js开发者必须了解的4个JS要点
　　1. 非阻塞(Non-blocking)或异步I/O 　　由于Node.js一个服务器端框架，所以它主要工作之一是处理浏览器请求。在传统的I/O系统中，每个请求的发出都是在上一请求到达之后才发出的。所以这被称为阻塞(blocking)I/O。服务器会阻挡其它的请求以处理当前请求，从而导致浏览器等待。
dasein58
158 0

热门文章

最新文章

  • 1
    【转】Javascript关键字和保留字
  • 2
    OC与JS互相调用
  • 3
    JavaScript 操作 Cookie
  • 4
    05.javascript访问CSS
  • 5
    javascript工厂模式和构造方法
  • 6
    如何让你的JavaScript代码更加语义化
  • 7
    js数组遍历some,foreach,map,filter,every对比
  • 8
    前端 时间个性化 插件 jquery.timeago.js
  • 9
    第14章 使用Kotlin开发JavaScript代码 《Kotin 编程思想·实战》
  • 10
    Nightwatch.js – 轻松实现浏览器的自动测试
  • 1
    使用Node.js构建实时聊天应用的技术指南
    116
  • 2
    DOM 节点列表长度（Node List Length）
    36
  • 3
    为了学习vue3，安装nvm进行node的多版本管理
    166
  • 4
    node node-sass sass-loader版本对应问题，对于npm编译大家经常遇到这个问题
    747
  • 5
    npm install没问题，但npm run dev的时候报Node Sass version 6.0.1 is incompatible with ^4.0.0 ^5.0.0
    63
  • 6
    Node.js新手必备：超实用命令行入门教程
    55
  • 7
    jenkins 自动安装nodejs16.16.0版本报错处理
    759
  • 8
    LabVIEW使用VI服务器的调用节点将数据传递到另一个VI 使用调用节点（Invoke Node）与通过引用调用节点（Call by Reference）调用VI时有什么差别？
    168
  • 9
    nodejs环境安装与配置记录
    56
  • 10
    nvm, node.js, npm, yarn 安装配置
    305

    • 相关课程

    更多
  • Node.js 入门与实战
  • JavaScript入门与实战
  • Node.js 入门教程文档
  • JavaScript 自学手册文档教程

    • 相关电子书

    更多
  • 探究 Node.js 的服务端之路
  • 个推微服务实践 基于OpenResty 和Node.js
  • 沪江基于Node.js大规模应用实践

    • 相关实验场景

    更多
  • Html5和Webpack2：Webpack5打包JS和样式表
  • 前端开发基础6：Node.js和LESS预编译工具
  • 搭建Node.js编程环境
    • 下一篇
    阿里云无影云电脑免费试用，最长可试用3个月