npm 包 multiaddr 使用教程-JavaScript中文网-JavaScript教程资源分享门户

前言

在现代计算机网络中，地址已经成为重要的概念之一，而多种多样的网络协议带来了各自的地址格式，如 IPv4/IPv6/Domain Name 等，我们需要统一管理这些地址，才能便捷地在网络中进行通信与交互。Multiaddr 就是一种有效的多地址格式，它将各种地址统一编码，同时支持多种传输协议，如 TCP/UDP/SCTP/DCCP 和 UDT 等。在本篇文章中，我们将学习 npm 包 multiaddr 的基本使用方法，并结合示例代码展示多种地址转换方式。

安装

我们可以直接在 npm 上下载 multiaddr，使用以下命令即可安装：

npm install multiaddr

使用

Multiaddr 的基本操作就是将各种地址转换成统一的格式，同时支持从统一格式解析出具体的地址信息。我们接下来看一看这两个操作的具体实现方法。

编码

Multiaddr 将地址编码成以下两部分：

Varint 编码的协议编号，该编号表示使用哪种通信协议；
编码后的实际地址值，该地址值由协议特定的地址数据组成。

下面我们分别看一看如何进行这两个编码操作：

协议编号编码

通过使用 multiaddr.fromNodeAddress 函数，我们可以将 Node.js 内置的网络地址编码成 Multiaddr 格式。我们使用的是 ip 协议（协议号为 4），具体示例如下：

const multiaddr = require('multiaddr')
const addr = multiaddr.fromNodeAddress({
  address: '127.0.0.1', // IP 地址
  port: 8080, // 端口
  family: 'IPv4' // 地址族
})
console.log(addr.toString())
// "/ip4/127.0.0.1/tcp/8080"

通过这段代码，我们可以将本地 IP 地址编码成 Multiaddr 格式，并且附带上本地的端口号。

地址编码

通过 multiaddr() 构造函数和 .stringTobuffer() 方法，我们可以将各种网络地址编码成 Multiaddr 格式。下面我们选取常见的几种网络地址以及对应的协议，来演示具体的编码操作：

IPv4 地址

const ip4 = multiaddr('127.0.0.1')
console.log(ip4.toOptions())
// { family: 'IPv4', address: '127.0.0.1' }
console.log(ip4.toString())
// "/ip4/127.0.0.1"

IPv6 地址

const ip6 = multiaddr('::1')
console.log(ip6.toOptions())
// { family: 'IPv6',
//   address: '0000:0000:0000:0000:0000:0000:0000:0001' }
console.log(ip6.toString())
// "/ip6/0000:0000:0000:0000:0000:0000:0000:0001"

IPFS 地址

const ipfs = multiaddr('/ip4/127.0.0.1/tcp/5001/http')
console.log(ipfs.toString())
// "/ip4/127.0.0.1/tcp/5001/http"

WebSocket 地址

const ws = multiaddr('/dns4/www.baidu.com/tcp/443/wss')
console.log(ws.toString())
// "/dns4/www.baidu.com/tcp/443/wss"

解码

与地址编码相对应的是地址解码，即将 Multiaddr 格式的地址解析成原始的网络地址。我们使用 multiaddr() 构造函数和 .toOptions() 方法，可以实现 Multiaddr 解码成 Node.js 地址的功能。下面我们来看一看具体的实现方法：

const addr = multiaddr('/ip4/127.0.0.1/tcp/8080')
const nodeAddr = addr.toOptions()
console.log(nodeAddr)
// { family: 'IPv4', address: '127.0.0.1', port: 8080 }

通过这段代码，我们可以将 Multiaddr 格式的地址转换成 Node.js 地址格式，便于我们进行网络通信与交互。

小结

本文介绍了 npm 包 multiaddr 的使用方法，包括地址编码和解码的具体实现，以及适用于多种网络通信协议的地址格式。同时，本文也给出了具体的示例代码，以帮助我们更好地理解和使用这个有用的 npm 包。

参考链接

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/72696