模块 encoding

encoding 模块是 FibJS 内置的一个模块，用于实现各种数据编码格式与二进制之间的转换。这些数据编码格式包括了 base64、base32、hex、json、msgpack、multibase、base58 等等一些常用的数据编码格式。

下面是 encoding 模块提供的各个子模块的简要介绍：

• iconv：用于处理各种编码之间的转换。
• base64：提供了一些对 Base64 编解码的支持，可以将字符串编码为 Base64 格式，也可以将 Base64 格式解码为字符串。
• base32：提供了对 Base32 编解码的支持，可以将给定的数据进行 Base32 编码并返回编码后的字符串。也可以将 Base32 编码的字符串解码为原始的数据。
• hex：提供了对十六进制编解码的支持，可以将给定的数据进行十六进制编码，并返回编码后的字符串。也可以将十六进制编码的字符串解码为原始的数据。
• json：提供了对 JSON 编解码的支持，可以将 JavaScript 对象序列化为 JSON 字符串，也可以将 JSON 字符串反序列化为 JavaScript 对象。
• multibase：提供了对 Multibase 编码的支持，Multibase 是在 Base1x 编码的基础上引入了多种编码前缀的编码方式。
• msgpack：提供了对 Msgpack 编解码的支持，Msgpack 是一种比 JSON 更轻量的数据交换格式，它可以将 JSON 对象序列化为二进制数据，以达到更快、更高效的数据交换效果。
• base58：提供了对 Base58 编解码的支持，Base58 是一种数字与字母的组合表示方法，它不包含数字 0、字母 O、字母 I、字母 L 等易混淆字符，具有不易出错的特点。

encoding 模块中的大部分子模块都包含了编码与解码两个函数，使用这些函数可以将特定格式的数据进行编码或解码。使用这些编解码模块时，需要根据模块的类型等特点来选择最适合的模块，才能保证编码和解码的正确性。

encoding` 模块的引用方式：

1
var encoding = require('encoding');

对象

base32

base32 编码与解码模块

1
base32 encoding.base32;

---

base64

base64 编码与解码模块

1
base64 encoding.base64;

---

base58

base58 编码与解码模块

1
base58 encoding.base58;

---

hex

hex 编码与解码模块

1
hex encoding.hex;

---

multibase

multibase 编码与解码模块

1
multibase encoding.multibase;

---

iconv

iconv 编码与解码模块

1
iconv encoding.iconv;

---

json

json 编码与解码模块

1
json encoding.json;

---

msgpack

msgpack 编码与解码模块

1
msgpack encoding.msgpack;

静态函数

isEncoding

判断指定的编码是否支持

1
static Boolean encoding.isEncoding(String codec);

调用参数:

• codec: String, 指定编码格式，允许值为："hex", "base32", "base58", "base64", "utf8", 或者 iconv 模块支持的字符集

返回结果:

• Boolean, 返回编码是否支持

---

encode

将 Buffer 编码为字符串

1
2
static String encoding.encode(Buffer data,
    String codec = "utf8");

调用参数:

• data: Buffer, 初始化字符串，字符串将以 utf-8 格式写入
• codec: String, 指定编码格式，允许值为："hex", "base32", "base58", "base64", "utf8", 或者 iconv 模块支持的字符集，缺省为 "utf8"

返回结果:

• String, 返回编码的字符串

---

decode

将字符串解码为 Buffer

1
2
static Buffer encoding.decode(String str,
    String codec = "utf8");

调用参数:

• str: String, 初始化字符串，字符串将以 utf-8 格式写入
• codec: String, 指定编码格式，允许值为："hex", "base32", "base58", "base64", "utf8", 或者 iconv 模块支持的字符集，缺省为 "utf8"

返回结果:

• Buffer, 返回解码的 Buffer

---

jsstr

将字符串编码为 javascript 转义字符串，用以在 javascript 代码中包含文本

1
2
static String encoding.jsstr(String str,
    Boolean json = false);

调用参数:

• str: String, 要编码的字符串
• json: Boolean, 是否生成json兼容字符串

返回结果:

• String, 返回编码的字符串

---

encodeURI

url 字符串安全编码

1
static String encoding.encodeURI(String url);

调用参数:

• url: String, 要编码的 url

返回结果:

• String, 返回编码的字符串

---

encodeURIComponent

url 部件字符串安全编码

1
static String encoding.encodeURIComponent(String url);

调用参数:

• url: String, 要编码的 url

返回结果:

• String, 返回编码的字符串

---

decodeURI

url 安全字符串解码

1
static String encoding.decodeURI(String url);

调用参数:

• url: String, 要解码的 url

返回结果:

• String, 返回解码的字符串