Node.js API详解之 util模块用法实例分析

下面是 Node.js API 详解之 util 模块用法实例分析的完整攻略。

一、util 模块简介

在 Node.js 中，util 是一个专门提供了常用工具函数的模块。通过 require('util') 获取到其中的方法。在 Node.js 中，我们可以使用以下方法：

• util.debuglog()
• util.format()
• util.inherits()
• util.inspect()
• util.promisify()
• ...

本文将主要介绍 util.inspect() 和 util.promisify()。

二、util.inspect()

util.inspect() 是 util 模块中最常用的函数之一，用于将一个对象转化为字符串输出。我们可以使用以下代码进行简单的测试：

const util = require('util');
const obj = {
  name: 'Tom',
  age: 22,
  info: function() {
    console.log('I am ' + this.name + ', ' + this.age + ' years old.');
  }
}
console.log(util.inspect(obj));

输出结果如下：

{ name: 'Tom', age: 22, info: [Function: info] }

可以看到，通过 util.inspect() 方法可以将 obj 对象转化为字符串输出。

在使用 util.inspect() 方法时，我们可以使用一些可选参数来控制输出格式，常用的可选参数如下：

• showHidden: 如果为 true，将会输出更多的非枚举属性和 Symbol 属性，默认为 false。
• depth: 定义对象输出的递归深度，默认为 2。
• colors: 如果为 true，则在输出对象字符串时将会带有 ANSI 颜色编码，以便于阅读。默认为 false。
• maxArrayLength: 定义一个数组的最大输出长度。

我们可以运用可选参数继续完善上面的实例，例如：

const util = require('util');
const obj = {
  name: 'Tom',
  age: 22,
  info: function() {
    console.log('I am ' + this.name + ', ' + this.age + ' years old.');
  },
  friends: ['Jerry', 'Mike', 'Nick', 'Jack', 'Lily']
}
console.log(util.inspect(obj, {showHidden: true, depth: null, colors: true, maxArrayLength: 3}));

输出结果如下：

三、util.promisify()

util.promisify() 是另一个常用的函数，主要用于将 Node.js 回调风格的异步函数转化为基于 Promise 的函数。我们可以使用以下代码进行简单的测试：

const util = require('util');
const fs = require('fs');
const readFileAsync = util.promisify(fs.readFile);

readFileAsync('./example.txt', 'utf8')
  .then(data => {
    console.log(data);
  })
  .catch(err => {
    console.error(err);
  });

在上面的代码中，我们使用 util.promisify() 方法将 Node.js 中的异步读取文件的方法 fs.readFile() 转化为基于 Promise 的函数 readFileAsync()，避免了回调函数的使用，使代码更加简洁。

总结

在 Node.js 中，util 模块是非常常用的模块之一。本文主要介绍了 util.inspect() 和 util.promisify() 两个常用的函数，并给出了相应的示例。需要注意的是，在使用 util.inspect() 方法时可以使用可选参数来控制输出格式，在使用 util.promisify() 方法时需要注意异步方法的参数和 Promise 的参数的对应关系。