这篇文章上次修改于 268 天前,可能其部分内容已经发生变化,如有疑问可询问作者。

Node.js全局对象和常用工具·

Node.js全局对象

JavaScript 中有一个特殊的对象,称为全局对象(Global Object),它及其所有属性都可以在程序的任何地方访问,即全局变量。在浏览器 JavaScript 中,通常 window 是全局对象, 而 Node.js 中的全局对象是 global,所有全局变量(除了 global 本身以外)都是 global 对象的属性。

全局对象与全局变量

全局对象(global)是全局变量的宿主,全局变量是全局对象的一个属性。

最好不要使用 var 定义变量以避免引入全局变量,因为全局变量会污染命名空间,提高代码的耦合风险。

常用的全局变量

__filename

表示当前正在执行脚本的文件名。输出的是文件所在位置的绝对路径,且和命令行参数所指定的文件名不一定相同。 如果在模块中,返回的值是模块文件的路径。

// app.js
console.log(__filename);

输出:

C:\Users\23036\Desktop\node>node app.js
C:\Users\23036\Desktop\node\app.js

__dirname

表示当前执行脚本所在的目录。

// app.js
console.log(__dirname);

输出:

C:\Users\23036\Desktop\node>node app.js
C:\Users\23036\Desktop\node

SetTimeout(callback, ms)

setTimeout(cb, ms) 全局函数在指定的毫秒(ms)数后执行指定函数(cb)。:setTimeout() 只执行一次指定函数。

返回一个代表定时器的句柄值。

// app.js
function print(){
  console.log( "2333333");
}
// 一秒后执行以上函数
setTimeout(print, 1000);

输出:

C:\Users\23036\Desktop\node>node app.js
2333333

clearTimeout(t)

clearTimeout( t ) 全局函数用于停止一个之前通过 setTimeout() 创建的定时器。 参数 t 是通过 setTimeout() 函数创建的定时器。

// app.js
function print(){
  console.log( "2333333");
}
// 一秒后执行以上函数
var timer = setTimeout(print, 1000);

clearTimeout(timer);

输出:

C:\Users\23036\Desktop\node>node app.js

setInterval(callback, ms)

setInterval(callback, ms) 全局函数在指定的毫秒(ms)数后执行指定函数(cb)。返回一个代表定时器的句柄值。可以使用 clearInterval(t) 函数来清除定时器。setInterval() 方法会不停地调用函数,直到 clearInterval() 被调用或窗口被关闭。

// app.js
function print(){
  console.log( "2333333");
}
// 每隔一秒后执行以上函数
var timer = setInterval(print, 1000);

输出:

C:\Users\23036\Desktop\node>node app.js
2333333
2333333

console

1、console.log([data] [...])

向标准输出流打印字符并以换行符结束。该方法接收若干 个参数,如果只有一个参数,则输出这个参数的字符串形式。如果有多个参数,则 以类似于C 语言 printf() 命令的格式输出。

console.log(1, 'asd', __dirname);

// 输出
1 'asd' 'C:\\Users\\23036\\Desktop\\node'

2、console.info([data] [, ...])
该命令的作用是返回信息性消息,这个命令与console.log差别并不大,除了在chrome中只会输出文字外,其余的会显示一个蓝色的惊叹号。

console.info(1, 'asd', __dirname);

// 输出
1 'asd' 'C:\Users\23036\Desktop\node'

3、console.error([data] [, ...])
输出错误消息的。

console.error(new Error('err'));

// 输出
Error: err
    at Object.<anonymous> (C:\Users\23036\Desktop\node\demo.js:1:77)
    at Module._compile (internal/modules/cjs/loader.js:734:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:745:10)
    at Module.load (internal/modules/cjs/loader.js:626:32)
    at tryModuleLoad (internal/modules/cjs/loader.js:566:12)
    at Function.Module._load (internal/modules/cjs/loader.js:558:3)
    at Function.Module.runMain (internal/modules/cjs/loader.js:797:12)
    at executeUserCode (internal/bootstrap/node.js:526:15)
    at startMainThreadExecution (internal/bootstrap/node.js:439:3)

4、console.warn([data] [, ...])
输出警告消息。

console.warn('xiaoliu');

5、console.time(label)
输出时间,表示计时开始。

console.time('start')

6、console.dir(obj[, options])
用来对一个对象进行检查(inspect),并以易于阅读和打印的格式显示。

console.dir({a: 1, 'a1':'asdas', 1: 2})

// 输出
{ '1': 2, a: 1, a1: 'asdas' }

7、console.timeEnd(label)
结束时间,表示计时结束。

console.time('label')
for (i = 0; i < 1000; i++) {
  // 代码部分
}
console.timeEnd('label')

// 输出
label: 0.420ms

8、console.trace(message[, ...])
当前执行的代码在堆栈中的调用路径,这个测试函数运行很有帮助,只要给想测试的函数里面加入 console.trace 就行了。

function test () {
  console.trace();
}
test();

// 输出
Trace
    at test (C:\Users\23036\Desktop\node\demo.js:2:11)
    at Object.<anonymous> (C:\Users\23036\Desktop\node\demo.js:4:1)
    at Module._compile (internal/modules/cjs/loader.js:734:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:745:10)
    at Module.load (internal/modules/cjs/loader.js:626:32)
    at tryModuleLoad (internal/modules/cjs/loader.js:566:12)
    at Function.Module._load (internal/modules/cjs/loader.js:558:3)
    at Function.Module.runMain (internal/modules/cjs/loader.js:797:12)
    at executeUserCode (internal/bootstrap/node.js:526:15)
    at startMainThreadExecution (internal/bootstrap/node.js:439:3)

9、console.assert(value[, message] [, ...])
用于判断某个表达式或变量是否为真,接收两个参数,第一个参数是表达式,第二个参数是字符串。只有当第一个参数为false,才会输出第二个参数,否则不会有任何结果。

console.assert(1 === '1', false);
console.assert(1 !== '1', true);

// 输出
Assertion failed: false

process

process 是一个全局变量,即 global 对象的属性。它用于描述当前Node.js 进程状态的对象,提供了一个与操作系统的简单接口。

1exit :当进程准备退出时触发。
2beforeExit :当 node 清空事件循环,并且没有其他安排时触发这个事件。通常来说,当没有进程安排时 node 退出,但是 'beforeExit' 的监听器可以异步调用,这样 node 就会继续执行。
3uncaughtException :当一个异常冒泡回到事件循环,触发这个事件。如果给异常添加了监视器,默认的操作(打印堆栈跟踪信息并退出)就不会发生。
4Signal 事件 当进程接收到信号时就触发。信号列表详见标准的 POSIX 信号名,如 SIGINT、SIGUSR1 等。
process.on('exit', function(code) {

  // 以下代码永远不会执行
  setTimeout(function() {
    console.log("该代码不会执行");
  }, 0);
  
  console.log('退出码为:', code);
});
console.log("程序执行结束");

执行 main.js 文件,代码如下所示:

程序执行结束
退出码为: 0

常用工具

util 是一个Node.js 核心模块,提供常用函数的集合,用于弥补核心JavaScript 的功能 过于精简的不足。

util.inherits

util.inherits(constructor, superConstructor) 是一个实现对象间原型继承的函数。

const util = require('util')
function Parent(){
}
function Child(){
}
util.inherits(Child, Parent);
const child = new Parent();
console.log(child.__proto__);

// 输出
Parent {}

util.inspect

util.inspect(object,[showHidden],[depth],[colors]) 是一个将任意对象转换 为字符串的方法,通常用于调试和错误输出。它至少接受一个参数 object,即要转换的对象。

  • showHidden 是一个可选参数,如果值为 true,将会输出更多隐藏信息。
  • depth 表示最大递归的层数,如果对象很复杂,你可以指定层数以控制输出信息的多 少。如果不指定depth,默认会递归2层,指定为 null 表示将不限递归层数完整遍历对象。
  • 如果color 值为 true,输出格式将会以ANSI 颜色编码,通常用于在终端显示更漂亮 的效果。

util.inspect 并不会简单地直接把对象转换为字符串,即使该对 象定义了 toString 方法也不会调用。

var util = require('util');
function Person() {
  this.name = 'xiaoliu';
  this.toString = function () {
    return this.name;
  };
}
var person = new Person();
console.log(util.inspect(person));
console.log(util.inspect(person, true, 2, true)); 

输出:

Person { name: 'xiaoliu', toString: [Function] }
Person {
  name: 'xiaoliu',
  toString:
   { [Function]
     [length]: 0,
     [name]: '',
     [arguments]: null,
     [caller]: null,
     [prototype]: { [constructor]: [Circular] } } }

util.isArray(object)

如果给定的参数 "object" 是一个数组返回true,否则返回false。

const util = require('util');

console.log(util.isArray([1, 2])); // ==> true
console.log(util.isArray({a: 1})); // ==> false
console.log(util.isArray('object')); // ==> false

util.isRegExp(object)

如果给定的参数 "object" 是一个正则表达式返回true,否则返回false。

var util = require('util');

util.isRegExp(/regexp/)  // ==> true
util.isRegExp(new RegExp('regexp')) // ==> true
util.isRegExp({}) // ==> false

util.isDate(object)

如果给定的参数 "object" 是一个日期返回true,否则返回false。

var util = require('util');

console.log(util.isDate(new Date())); // ==> true
console.log(util.isDate(Date())) // ==> false
console.log(util.isDate(Date.now())) // ==> false
console.log(util.isDate({})) // ==> false

util.isError(object)

如果给定的参数 "object" 是一个错误对象返回true,否则返回false。

var util = require('util');

util.isError(new Error()) // ==> true
util.isError(new TypeError()) // ==> true
util.isError({error: 'err'}) // ==> false