[node] Node.js的内置模块

Domain 模块

Node.js Domain(域) 简化异步代码的异常处理，可以捕捉处理try catch无法捕捉的异常。

使用方式

var domain = require("domain")

domain模块，把处理多个不同的IO的操作作为一个组。注册事件和回调到domain，当发生一个错误事件或抛出一个错误时，domain对象会被通知，不会丢失上下文环境，也不导致程序错误立即退出，与process.on(‘uncaughtException’)不同。

Domain 模块可分为隐式绑定和显式绑定：

• 隐式绑定: 把在domain上下文中定义的变量，自动绑定到domain对象
• 显式绑定: 把不是在domain上下文中定义的变量，以代码的方式绑定到domain对象

方法概览

属性

示例

main.js

var EventEmitter = require("events").EventEmitter;
var domain = require("domain");

var emitter1 = new EventEmitter();
// 创建域
var domain1 = domain.create();
domain1.on("error", function (err) {
   
  console.log("domain1 处理这个错误 (" + err.message + ")");
});
// 显式绑定
domain1.add(emitter1);
emitter1.on("error", function (err) {
   
  console.log("监听器处理此错误 (" + err.message + ")");
});
emitter1.emit("error", new Error("通过监听器来处理"));
emitter1.removeAllListeners("error");
emitter1.emit("error", new Error("通过 domain1 处理"));
var domain2 = domain.create();
domain2.on("error", function (err) {
   
  console.log("domain2 处理这个错误 (" + err.message + ")");
});
// 隐式绑定
domain2.run(function () {
   
  var emitter2 = new EventEmitter();
  emitter2.emit("error", new Error("通过 domain2 处理"));
});
domain1.remove(emitter1);
emitter1.emit("error", new Error("转换为异常，系统将崩溃!"));
//终端执行 node main.js
//输出
// 监听器处理此错误 (通过监听器来处理)
// domain1 处理这个错误 (通过 domain1 处理)
// domain2 处理这个错误 (通过 domain2 处理)
// node:events:491
//       throw er; // Unhandled 'error' event
//       ^

// Error: 转换为异常，系统将崩溃!
//     at Object.<anonymous> (D:\test\temp1.cjs:28:24)
//     at Module._compile (node:internal/modules/cjs/loader:1254:14)
//     at Module._extensions..js (node:internal/modules/cjs/loader:1308:10)
//     at Module.load (node:internal/modules/cjs/loader:1117:32)
//     at Module._load (node:internal/modules/cjs/loader:958:12)
//     at Function.executeUserEntryPoint [as runMain] (node:internal/modules/run_main:81:12)
//     at node:internal/main/run_main_module:23:47

DNS 模块

Node.js DNS 模块用于解析域名

使用方式

var dns = require("dns")

方法概览

rrtypes

以下列出了 dns.resolve() 方法中有效的 rrtypes值:

• A,IPV4 地址, 默认
• AAAA, IPV6 地址
• MX, 邮件交换记录
• TXT, text 记录
• SRV, SRV 记录
• PTR, 用来反向 IP 查找
• NS, 域名服务器记录
• CNAME, 别名记录
• SOA, 授权记录的初始值

错误码

DNS 查询返回的错误码：

• dns.NODATA: 无数据响应。
• dns.FORMERR: 查询格式错误。
• dns.SERVFAIL: 常规失败。
• dns.NOTFOUND: 没有找到域名。
• dns.NOTIMP: 未实现请求的操作。
• dns.REFUSED: 拒绝查询。
• dns.BADQUERY: 查询格式错误。
• dns.BADNAME: 域名格式错误。
• dns.BADFAMILY: 地址协议不支持。
• dns.BADRESP: 回复格式错误。
• dns.CONNREFUSED: 无法连接到 DNS 服务器。
• dns.TIMEOUT: 连接 DNS 服务器超时。
• dns.EOF: 文件末端。
• dns.FILE: 读文件错误。
• dns.NOMEM: 内存溢出。
• dns.DESTRUCTION: 通道被摧毁。
• dns.BADSTR: 字符串格式错误。
• dns.BADFLAGS: 非法标识符。
• dns.NONAME: 所给主机不是数字。
• dns.BADHINTS: 非法HINTS标识符。
• dns.NOTINITIALIZED: c/c-ares 库未初始化。
• dns.LOADIPHLPAPI: 加载 iphlpapi.dll 出错。
• dns.ADDRGETNETWORKPARAMS: 无法找到 GetNetworkParams 函数。
• dns.CANCELLED: 取消 DNS 查询。

示例

main.js

var dns = require("dns");
dns.lookup("echarts.apache.org", function onLookup(err, address, family) {
   
  console.log("ip 地址:", address);
  dns.reverse(address, function (err, hostnames) {
   
    if (err) {
   
      console.log(err.stack);
    }
    console.log("反向解析 " + address + ": " + JSON.stringify(hostnames));
  });
});
//终端执行 node main.js
//输出
// ip 地址: 151.101.2.132
// Error: getHostByAddr ENOTFOUND 151.101.2.132
//     at QueryReqWrap.onresolve [as oncomplete] (node:internal/dns/callback_resolver:47:19)
// 反向解析 151.101.2.132: undefined

Net 模块

Node.js Net 模块提供了一些用于底层的网络通信的小工具，包含了创建服务器/客户端的方法

使用方式

var net = require("net")

方法概览

net.Server

net.Server通常用于创建一个 TCP 或本地服务器:

方法

事件

net.Socket

net.Socket 对象是 TCP 或 UNIX Socket 的抽象。net.Socket 实例实现了一个双工流接口。可以在用户创建客户端(使用 connect())时使用, 或者由 Node 创建它们，并通过 connection 服务器事件传递给用户

net.Socket 事件

属性

net.Socket 提供了很多有用的属性，便于控制 socket 交互：

方法

示例

server.js 文件：

var net = require("net");
var server = net.createServer(function (connection) {
   
  console.log("client connected");
  connection.on("end", function () {
   
    console.log("客户端关闭连接");
  });
  connection.write("Hello World!\r\n");
  connection.pipe(connection);
});
server.listen(8080, function () {
   
  console.log("server is listening");
});
//终端执行 node server.js
//输出
// server is listening

client.js 文件：

var net = require("net");
var client = net.connect({
    port: 8080 }, function () {
   
  console.log("连接到服务器！");
});
client.on("data", function (data) {
   
  console.log(data.toString());
  client.end();
});
client.on("end", function () {
   
  console.log("断开与服务器的连接");
});
//终端执行 node main.js
//输出
// 连接到服务器！
// Hello World!
// 断开与服务器的连接

os

提供基本的系统操作函数，主要是用于处理与操作系统相关的功能模块

使用方式

var os = require("os")

方法概览

os的属性：

• os.EOL:定义了操作系统的行尾符的常量。

示例

main.js 文件：

var os = require("os");
console.log("endianness : " + os.endianness()); // CPU 的字节序
console.log("type : " + os.type()); // 操作系统名
console.log("platform : " + os.platform()); // 操作系统名
console.log("Total memory : " + os.totalmem() + " bytes."); // 系统内存总量
console.log("Free memory : " + os.freemem() + " bytes."); // 操作系统空闲内存量
//终端执行 node main.js
//输出
// endianness : LE
// type : Windows_NT
// platform : win32
// Total memory : 17015451648 bytes.
// Free memory : 5720956928 bytes.

util

是Node.js的核心模块，提供了一些常用函数的合集，弥补javascript功能过于精简的问题

使用方式

const util = require('util');

常用方法

util.callbackify

util.callbackify(original) 将 async 异步函数(或者返回值为 Promise 的函数)转换成遵循异常优先的回调风格的函数.例如将 (err, value) => … 回调作为最后一个参数。 在回调中，err为拒绝(Promise reject)的原因(若Promise resolve，则err为 null)，value则是解决的值。

const util = require('util');

async function fn() {
   
  return 'hello world';
}
const callbackFunction = util.callbackify(fn);

callbackFunction((err, ret) => {
   
  if (err) throw err;
  console.log(ret);
});
//输出
//hello world

回调函数是异步执行的，并且有异常堆栈错误追踪。 如果回调函数抛出一个异常，进程会触发一个 ‘uncaughtException’ 异常，如果没有被捕获，进程将会退出。

null 在回调函数中作为一个参数有其特殊的意义，如果回调函数的首个参数为 Promise 拒绝的原因且带有返回值，且值可以转换成布尔值 false，这个值会被封装在 Error 对象里，可以通过属性 reason 获取。

function fn() {
   
  return Promise.reject(null);
}
const callbackFunction = util.callbackify(fn);
callbackFunction((err, ret) => {
   
  //Promise 被以 `null` reject时，被包装为Error并且原始值存储在 `reason` 中
  err && err.hasOwnProperty('reason') && err.reason === null;  // true
});

original 为 async 异步函数,该函数返回传统回调函数。

util.inherits

util.inherits(constructor, superConstructor) 是一个实现对象间原型继承的函数。已经废弃。
JavaScript 的面向对象特性是基于原型的，与常见的基于类的不同。JavaScript 没有提供对象继承的语言级别特性，而是通过原型复制来实现的。所以constructor继承superConstructor的原型

var util = require('util'); 
function Base() {
    
    this.name = 'base'; 
    this.base = 1991; 
    this.sayHello = function() {
    
      console.log('Hello ' + this.name); 
    }; 
} 
Base.prototype.showName = function() {
    
    console.log(this.name);
}; 
function Sub() {
    
    this.name = 'sub'; 
} 
util.inherits(Sub, Base); 
var objBase = new Base(); 
objBase.showName(); //base
objBase.sayHello(); //Hello base
console.log(objBase); //Base { name: 'base', base: 1991, sayHello: [Function (anonymous)] }
var objSub = new Sub(); 
objSub.showName(); //sub
//objSub.sayHello(); 
console.log(objSub); //Sub { name: 'sub' }

定义的基础对象 Base 和一个继承 Base 的 Sub，Base 有三个在构造函数内定义的属性和一个原型中定义的函数，通过util.inherits 实现继承。运行结果请查看上述注释

注意：Sub 仅仅继承了 Base 在原型中定义的函数，而Base构造函数内部创造的属性和函数都没有被 Sub 继承。

所以如果去掉 objSub.sayHello(); 这行的注释就会报错：TypeError: objSub.sayHello is not a function

在原型中定义的属性不会被 console.log 作为对象的属性输出。

因为当前继承方式已废弃，现有继承方法：

class Base {
   
  name = "base";
  base = 1991;
  sayHello = function () {
   
    console.log("Hello " + this.name);
  };
}
Base.prototype.showName = function () {
   
  console.log(this.name);
};
class Sub extends Base {
   
  name = "sub";
}
var objBase = new Base();
objBase.showName();
objBase.sayHello();
console.log(objBase);
var objSub = new Sub();
objSub.showName();
objSub.sayHello();
console.log(objSub);
//输出：
// base
// Hello base
// Base { name: 'base', base: 1991, sayHello: [Function: sayHello] }
// sub
// Hello sub
// Sub { name: 'sub', base: 1991, sayHello: [Function: sayHello] }

extends 方式，不论是原型还是构造函数中的属性与方法均继承

util.inspect

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

• object,必填参数，即要转换的对象
• showHidden ,可选参数，值为 true，将会输出更多隐藏信息。
• depth,可选参数，表示最大递归的层数，默认值为2.如果对象很复杂，可以指定depth 以控制输出信息的层数。如果depth指定为 null 表示将无限递归层数完整遍历对象。
• colors，可选参数，如果 colors 为 true，输出格式将会以 ANSI 颜色编码，通常用于在终端显示更漂亮的效果。

特别要指出的是，util.inspect 并不会简单地直接把对象转换为字符串，即使该对象定义了 toString 方法也不会调用。

var util = require('util'); 
function Person() {
    
    this.name = 'byvoid'; 
    this.toString = function() {
    
    return this.name; 
    }; 
} 
var obj = new Person(); 
console.log(util.inspect(obj)); 
console.log(util.inspect(obj, true)); 
//输出
// Person { name: 'byvoid', toString: [Function (anonymous)] }
// Person {
   
//   name: 'byvoid',
//   toString: <ref *1> [Function (anonymous)] {
   
//     [length]: 0,
//     [name]: '',
//     [arguments]: null,
//     [caller]: null,
//     [prototype]: { [constructor]: [Circular *1] }
//   }
// }

util.isArray

util.isArray(object)，如果给定的参数 “object” 是一个数组返回 true，否则返回 false

var util = require('util');
util.isArray([])// true
util.isArray(new Array)// true
util.isArray({
   })// false

util.isRegExp

util.isRegExp(object),如果参数 “object” 是一个正则表达式返回true，否则返回false。

var util = require('util');
util.isRegExp(/some regexp/)// true
util.isRegExp(new RegExp('another regexp'))// true
util.isRegExp({
   }) // false

util.isDate

util.isDate(object),如果参数 “object” 是一个日期,返回true，否则返回false。

var util = require('util');
util.isDate(new Date())  // true
util.isDate(Date())  // false (without 'new' returns a String)
util.isDate({
   })  // false

如何调试

node --inspect-brk xxx.js
chrome 浏览器输入网址：
chrome://inspect
检查当前被调试的程序

   <script type="text/javascript">
      function loadScript() {
   
        console.log("current loadScript is");
        let script = document.createElement("script");
        script.type = "text/javascript";
        script.src = "<%= BASE_URL %>env.js";
        script.async=false;
       document.head.appendChild(script);
      }
      console.log("current BASE_URL is"+"<%= BASE_URL %>");
      // if("<%= BASE_URL %>"!==""){
   

      // }
      window.function(){
   
        loadScript();
      }
   </script>