Node.js教程 Npm教程 Node.js REPL Node.js回调函数 Node.js事件循环 Node.js EventEmitter Node.js Buffer Node.js Stream Node.js模块系统 Node.js 函数 Node.js路由 Node.js全局对象 Node.js util模块 Node.js文件系统(fs) Node.js GET请求 Node.js POST请求 Node.js Express框架 Node.js RESTful API Nodejs多进程 Node.js连接MongoDB

Node.js util模块

栏目： NodeJs 发布时间：2024-12-05

Node.js Util 模块教程

Node.js 的 util 模块提供了一套实用的工具函数，用于处理各种常见的任务，比如格式化字符串、检查数据类型、继承类等。这些工具函数可以极大地简化代码，提高开发效率。本文将详细介绍 Node.js util 模块中的一些常用功能及其使用方法。

1. 引入 `util` 模块

首先，你需要在你的 Node.js 文件中引入 util 模块：

const util = require('util');

2. 格式化字符串：`util.format`

util.format 方法用于格式化字符串，类似于 C 语言的 printf 或 JavaScript 的模板字符串（但功能更强大）。

const str = util.format('%s is %d years old.', 'Alice', 30);
console.log(str);  // 输出: Alice is 30 years old.

3. 检查数据类型：`util.types`

util.types 提供了一系列用于检查数据类型的函数，如 isArray(), isRegExp(), isDate() 等。

const util = require('util');

console.log(util.types.isArray([1, 2, 3]));  // 输出: true
console.log(util.types.isRegExp(/abc/));     // 输出: true
console.log(util.types.isDate(new Date()));  // 输出: true

注意：在 Node.js v14.0.0 及更高版本中，util.types 已被单独拆分为 util.types 模块，但 util 模块内部仍然可以访问这些函数。

4. 继承类：`util.inherits`

util.inherits 方法用于实现类的继承。虽然 ES6 引入了 class 语法和 extends 关键字，但在某些情况下，你可能仍然需要使用 util.inherits。

const util = require('util');

function Base() {
  this.name = 'Base';
}

Base.prototype.sayHello = function() {
  console.log('Hello from ' + this.name);
};

function Derived() {
  Base.call(this); // 调用父类的构造函数
  this.name = 'Derived';
}

util.inherits(Derived, Base);

const derived = new Derived();
derived.sayHello();  // 输出: Hello from Derived

5. 回调函数的 Promise 化：`util.promisify`

util.promisify 方法用于将一个遵循 Node.js 回调风格的函数转换为返回 Promise 的函数。这对于将旧的异步函数转换为基于 Promise 的异步函数非常有用。

const util = require('util');
const fs = require('fs');

const readFilePromise = util.promisify(fs.readFile);

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

6. 调试：`util.debuglog`

util.debuglog 方法用于创建一个函数，该函数可以根据环境变量 NODE_DEBUG 的值来决定是否输出调试信息。

const debug = util.debuglog('mymodule');

// 假设环境变量 NODE_DEBUG 包含 'mymodule'，则以下代码会输出调试信息
debug('This is a debug message.');

要在运行时启用调试输出，你可以设置环境变量 NODE_DEBUG：

NODE_DEBUG=mymodule node your_script.js

总结

Node.js 的 util 模块提供了一系列实用的工具函数，可以极大地简化代码和提高开发效率。本文介绍了 util 模块中的一些常用功能，包括格式化字符串、检查数据类型、继承类、回调函数的 Promise 化以及调试。希望这些内容能帮助你更好地理解和使用 util 模块。

本文地址：https://www.tides.cn/p_node-util

Node.js util模块