notes_estom/NodeJS/5buffer模块.md

buffer模块

1 模块说明

作用

• Buffer 类，该类用来创建一个专门存放二进制数据的缓存区

Node.js 目前支持的字符编码包括：

• ascii - 仅支持 7 位 ASCII 数据。如果设置去掉高位的话，这种编码是非常快的。

• utf8 - 多字节编码的 Unicode 字符。许多网页和其他文档格式都使用 UTF-8 。

• utf16le - 2 或 4 个字节，小字节序编码的 Unicode 字符。支持代理对（U+10000 至 U+10FFFF）。

• ucs2 - utf16le 的别名。

• base64 - Base64 编码。

• latin1 - 一种把 Buffer 编码成一字节编码的字符串的方式。

• binary - latin1 的别名。

• hex - 将每个字节编码为两个十六进制字符。

2 模块应用

创建Buffer 类

• Buffer.alloc(size[, fill[, encoding]])： 返回一个指定大小的 * Buffer 实例，如果没有设置 fill，则默认填满 0
• Buffer.allocUnsafe(size)： 返回一个指定大小的 Buffer 实例，但是它不会被初始化，所以它可能包含敏感的数据
• Buffer.allocUnsafeSlow(size)
• Buffer.from(array)： 返回一个被 array 的值初始化的新的 Buffer 实例（传入的 array 的元素只能是数字，不然就会自动被 0 覆盖）
• Buffer.from(arrayBuffer[, byteOffset[, length]])： 返回一个新建的与给定的 ArrayBuffer 共享同一内存的 Buffer。
• Buffer.from(buffer)： 复制传入的 Buffer 实例的数据，并返回一个新的Buffer 实例
• Buffer.from(string[, encoding])： 返回一个被 string 的值初始化的新的 Buffer 实例

// 创建一个长度为 10、且用 0 填充的 Buffer。
const buf1 = Buffer.alloc(10);

// 创建一个长度为 10、且用 0x1 填充的 Buffer。 
const buf2 = Buffer.alloc(10, 1);

// 创建一个长度为 10、且未初始化的 Buffer。
// 这个方法比调用 Buffer.alloc() 更快，
// 但返回的 Buffer 实例可能包含旧数据，
// 因此需要使用 fill() 或 write() 重写。
const buf3 = Buffer.allocUnsafe(10);

// 创建一个包含 [0x1, 0x2, 0x3] 的 Buffer。
const buf4 = Buffer.from([1, 2, 3]);

// 创建一个包含 UTF-8 字节 [0x74, 0xc3, 0xa9, 0x73, 0x74] 的 Buffer。
const buf5 = Buffer.from('tést');

// 创建一个包含 Latin-1 字节 [0x74, 0xe9, 0x73, 0x74] 的 Buffer。
const buf6 = Buffer.from('tést', 'latin1');

写入缓冲区

buf.write(string[, offset[, length]][, encoding])

• string - 写入缓冲区的字符串。

• offset - 缓冲区开始写入的索引值，默认为 0 。

• length - 写入的字节数，默认为 buffer.length

• encoding - 使用的编码。默认为 'utf8' 。

读取缓冲区

buf.toString([encoding[, start[, end]]])

• encoding - 使用的编码。默认为 'utf8' 。

• start - 指定开始读取的索引位置，默认为 0。

• end - 结束位置，默认为缓冲区的末尾。

将 Buffer 转换为 JSON 对象

buf.toJSON()
const buf = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]);
const json = JSON.stringify(buf);

// 输出: {"type":"Buffer","data":[1,2,3,4,5]}
console.log(json);

const copy = JSON.parse(json, (key, value) => {
  return value && value.type === 'Buffer' ?
    Buffer.from(value.data) :
    value;
});

// 输出: <Buffer 01 02 03 04 05>
console.log(copy);

缓冲区合并

Buffer.concat(list[, totalLength])

• list - 用于合并的 Buffer 对象数组列表。

• totalLength - 指定合并后Buffer对象的总长度。