“Node.js：工具模块”的版本间差异
跳到导航
跳到搜索
（→Net 模块） |
（→示例） |
||
| 第470行： | 第470行： | ||
</syntaxhighlight> | </syntaxhighlight> | ||
: [[File:Node.js：Net 模块：示例.gif| | : [[File:Node.js：Net 模块：示例.gif|800px]] | ||
== DNS 模块 == | == DNS 模块 == | ||
2021年5月31日 (一) 02:26的版本
关于
在 Node.js 模块库中有很多好用的模块。
几种常用模块的使用：
- OS 模块：提供基本的系统操作函数。
- Path 模块：提供了处理和转换文件路径的工具。
- Net 模块：用于底层的网络通信。提供了服务端和客户端的的操作。
- DNS 模块：用于解析域名。
- Domain 模块：简化异步代码的异常处理，可以捕捉处理try catch无法捕捉的。
OS 模块
Node.js os 模块提供了一些基本的系统操作函数。
可以通过以下方式引入该模块：
var os = require("os")
方法
| 命令 | 描述 |
|---|---|
| os.tmpdir() | 返回操作系统的默认临时文件夹。 |
| os.endianness() | 返回 CPU 的字节序，可能的是 "BE" 或 "LE"。 |
| os.hostname() | 返回操作系统的主机名。 |
| os.type() | 返回操作系统名 |
| os.platform() | 返回编译时的操作系统名 |
| os.arch() | 返回操作系统 CPU 架构，可能的值有 "x64"、"arm" 和 "ia32"。 |
| os.release() | 返回操作系统的发行版本。 |
| os.uptime() | 返回操作系统运行的时间，以秒为单位。 |
| os.loadavg() | 返回一个包含 1、5、15 分钟平均负载的数组。 |
| os.totalmem() | 返回系统内存总量，单位为字节。 |
| os.freemem() | 返回操作系统空闲内存量，单位是字节。 |
| os.cpus() | 返回一个对象数组。
包含所安装的每个 CPU/内核的信息：
|
| os.networkInterfaces() | 获得网络接口列表。 |
属性
| 命令 | 描述 |
|---|---|
| os.EOL | 定义了操作系统的行尾符的常量。 |
示例
创建 main.js 文件：
var os = require("os");
// CPU 的字节序
console.log('endianness : ' + os.endianness());
// 操作系统名
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 : Linux
platform : linux
total memory : 25103400960 bytes.
free memory : 20676710400 bytes.
Path 模块
Node.js path 模块提供了一些用于处理文件路径的小工具。
可以通过以下方式引入该模块：
var path = require("path")
方法
| 命令 | 描述 |
|---|---|
| path.normalize(p) | 规范化路径，注意'..' 和 '.'。 |
| path.join([path1][, path2][, ...]) | 用于连接路径。
该方法的主要用途在于，会正确使用当前系统的路径分隔符，Unix系统是"/"，Windows系统是"\"。 |
| path.resolve([from ...], to) | 将 to 参数解析为绝对路径，给定的路径的序列是从右往左被处理的，后面每个 path 被依次解析，直到构造完成一个绝对路径。
例如，给定的路径片段的序列为：/foo、/bar、baz，则调用 path.resolve('/foo', '/bar', 'baz') 会返回 /bar/baz。 path.resolve('/foo/bar', './baz');
// 返回: '/foo/bar/baz'
path.resolve('/foo/bar', '/tmp/file/');
// 返回: '/tmp/file'
path.resolve('wwwroot', 'static_files/png/', '../gif/image.gif');
// 如果当前工作目录为 /home/myself/node，
// 则返回 '/home/myself/node/wwwroot/static_files/gif/image.gif'
|
| path.isAbsolute(path) | 判断参数 path 是否是绝对路径。 |
| path.relative(from, to) | 用于将绝对路径转为相对路径，返回从 from 到 to 的相对路径（基于当前工作目录）。
在 Linux 上： path.relative('/data/orandea/test/aaa', '/data/orandea/impl/bbb');
// 返回: '../../impl/bbb'
在 Windows 上： path.relative('C:\\orandea\\test\\aaa', 'C:\\orandea\\impl\\bbb');
// 返回: '..\\..\\impl\\bbb'
|
| path.dirname(p) | 返回路径中代表文件夹的部分，同 Unix 的dirname 命令类似。 |
| path.basename(p[, ext]) | 返回路径中的最后一部分。同 Unix 命令 bashname 类似。 |
| path.extname(p) | 返回路径中文件的后缀名，即路径中最后一个'.'之后的部分。
|
| path.parse(pathString) | 返回路径字符串的对象。 |
| path.format(pathObject) | 从对象中返回路径字符串，和 path.parse 相反。 |
属性
| 命令 | 描述 |
|---|---|
| path.sep | 平台的文件路径分隔符，'\\' 或 '/'。 |
| path.delimiter | 平台的分隔符, ; or ':'. |
| path.posix | 提供上述 path 的方法，不过总是以 posix 兼容的方式交互。 |
| path.win32 | 提供上述 path 的方法，不过总是以 win32 兼容的方式交互。 |
示例
创建 main.js 文件：
var path = require("path");
// 格式化路径
console.log('normalization : ' + path.normalize('/test/test1//2slashes/1slash/tab/..'));
// 连接路径
console.log('joint path : ' + path.join('/test', 'test1', '2slashes/1slash', 'tab', '..'));
// 转换为绝对路径
console.log('resolve : ' + path.resolve('main.js'));
// 路径中文件的后缀名
console.log('ext name : ' + path.extname('main.js'));
代码执行结果如下：
$ node main.js
normalization : /test/test1/2slashes/1slash
joint path : /test/test1/2slashes/1slash
resolve : /web/com/1427176256_27423/main.js
ext name : .js
Net 模块【？？？】
Node.js Net 模块提供了一些用于底层的网络通信的小工具，包含了创建 服务器 / 客户端 的方法。
可以通过以下方式引入该模块：
var net = require("net")
方法
| 方法 | 描述 |
|---|---|
| net.createServer([options][, connectionListener]) | 创建一个 TCP 服务器。
|
| net.connect(options[, connectionListener]) | 返回一个新的 'net.Socket'，并连接到指定的地址和端口。
|
| net.connect(port[, host][, connectListener]) | 创建一个端口为 port 和主机为 host的 TCP 连接 。
|
| net.connect(path[, connectListener]) | 创建连接到 path 的 unix socket 。
|
| net.createConnection(options[, connectionListener]) | 创建一个到端口 port 和 主机 host的 TCP 连接。
|
| net.createConnection(port[, host][, connectListener]) | 创建一个端口为 port 和主机为 host的 TCP 连接 。
|
| net.createConnection(path[, connectListener]) | 创建连接到 path 的 unix socket 。
|
| net.isIP(input) | 检测输入的是否为 IP 地址：IPV4 返回 4， IPV6 返回 6，其他情况返回 0。 |
| net.isIPv4(input) | 如果输入的地址为 IPV4，返回 true，否则返回 false。 |
| net.isIPv6(input) | 如果输入的地址为 IPV6，返回 true，否则返回 false。 |
net.Server
net.Server通常用于创建一个 TCP 或本地服务器。
方法
| 方法 | 描述 |
|---|---|
| server.listen(port[, host][, backlog][, callback]) | 监听指定端口 port 和 主机 host ac连接。
|
| server.listen(path[, callback]) | 通过指定 path 的连接，启动一个本地 socket 服务器。 |
| server.listen(handle[, callback]) | 通过指定句柄连接。 |
| server.listen(options[, callback]) | options 的属性：端口 port, 主机 host, 和 backlog, 以及可选参数 callback 函数。
他们在一起调用server.listen(port, [host], [backlog], [callback])。 还有，参数 path 可以用来指定 UNIX socket。 |
| server.close([callback]) | 服务器停止接收新的连接，保持现有连接。
|
| server.address() | 操作系统返回绑定的地址，协议族名和服务器端口。 |
| server.unref() | 如果这是事件系统中唯一一个活动的服务器，调用 unref 将允许程序退出。 |
| server.ref() | 与 unref 相反，如果这是唯一的服务器，在之前被 unref 了的服务器上调用 ref 将不会让程序退出（默认行为）。
|
| server.getConnections(callback) | 异步获取服务器当前活跃连接的数量。
|
事件
| 事件 | 描述 |
|---|---|
| listening | 当服务器调用 server.listen 绑定后会触发。 |
| connection | 当新连接创建后会被触发。
|
| close | 服务器关闭时会触发。
|
| error | 发生错误时触发。'close' 事件将被下列事件直接调用。 |
net.Socket
net.Socket 对象是 TCP 或 UNIX Socket 的抽象。
- net.Socket 实例实现了一个双工流接口。
- 他们可以在用户创建客户端（使用 connect()）时使用, 或者由 Node 创建它们，并通过 connection 服务器事件传递给用户。
事件
| 事件 | 描述 |
|---|---|
| lookup | 在解析域名后，但在连接前，触发这个事件。
|
| connect | 成功建立 socket 连接时触发。 |
| data | 当接收到数据时触发。 |
| end | 当 socket 另一端发送 FIN 包时，触发该事件。 |
| timeout | 当 socket 空闲超时时触发，仅是表明 socket 已经空闲。
|
| drain | 当写缓存为空得时候触发。
|
| error | 错误发生时触发。 |
| close | 当 socket 完全关闭时触发。
|
属性
net.Socket 提供了很多有用的属性，便于控制 socket 交互：
| 属性 | 描述 |
|---|---|
| socket.bufferSize | 该属性显示了要写入缓冲区的字节数。 |
| socket.remoteAddress | 远程的 IP 地址字符串，例如：'74.125.127.100' or '2001:4860:a005::68'。 |
| socket.remoteFamily | 远程IP协议族字符串，比如 'IPv4' or 'IPv6'。 |
| socket.remotePort | 远程端口，数字表示，例如：80 or 21。 |
| socket.localAddress | 网络连接绑定的本地接口 远程客户端正在连接的本地 IP 地址，字符串表示。【？？？】
例如，如果你在监听'0.0.0.0'而客户端连接在'192.168.1.1'，这个值就会是 '192.168.1.1'。 |
| socket.localPort | 本地端口地址，数字表示。例如：80 or 21。 |
| socket.bytesRead | 接收到得字节数。 |
| socket.bytesWritten | 发送的字节数。 |
方法
| 命令 | 描述 |
|---|---|
| new net.Socket([options]) | 构造一个新的 socket 对象。 |
| socket.connect(port[, host][, connectListener]) | 指定端口 port 和 主机 host，创建 socket 连接。
|
| socket.connect(path[, connectListener]) | 打开指定路径的 unix socket。
|
| socket.setEncoding([encoding]) | 设置编码 |
| socket.write(data[, encoding][, callback]) | 在 socket 上发送数据。
|
| socket.end([data][, encoding]) | 半关闭 socket。
例如，它发送一个 FIN 包。可能服务器仍在发送数据。 |
| socket.destroy() | 确保没有 I/O 活动在这个套接字上。
|
| socket.pause() | 暂停读取数据。就是说，不会再触发 data 事件。
|
| socket.resume() | 调用 pause() 后想恢复读取数据。 |
| socket.setTimeout(timeout[, callback]) | socket 闲置时间超过 timeout 毫秒后 ，将 socket 设置为超时。 |
| socket.setNoDelay([noDelay]) | 禁用纳格（Nagle）算法。
|
| socket.setKeepAlive([enable][, initialDelay]) | 禁用/启用长连接功能，并在发送第一个在闲置 socket 上的长连接 probe 之前，可选地设定初始延时。
|
| socket.address() | 操作系统返回绑定的地址，协议族名和服务器端口。
|
| socket.unref() | 如果这是事件系统中唯一一个活动的服务器，调用 unref 将允许程序退出。
|
| socket.ref() | 与 unref 相反，如果这是唯一的服务器，在之前被 unref 了的服务器上调用 ref 将不会让程序退出（默认行为）。
|
示例
创建 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 # 服务已创建并监听 8080 端口
新开一个窗口，创建 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('断开与服务器的连接');
});
执行以上客户端的代码：
连接到服务器！
Hello World!
断开与服务器的连接
DNS 模块
| 命令 | 描述 |
|---|---|
Domain 模块
| 命令 | 描述 |
|---|---|