buffer · Magic_sword2

[TOC] # 简介说明 原文链接： - [buffer](https://github.com/nodejs/node/blob/main/doc/api/buffer.md) ``` 版本：buffer 作用：Buffer 类是一个全局变量，用于直接处理二进制数据 ``` # buffer # *INSPECT_MAX_BYTES ***** 返回当调用 buf.inspect() 时将会返回的最大字节数 # *kMaxLength ***** 分配给单个 Buffer 实例的最大内存 # *transcode() ***** 将指定的 Buffer 或 Uint8Array 实例从一个字符编码重新编码到另一个字符 ### 参数说明 source : * 类型：对象 * 默认值：无 * 描述：一个 Buffer 或 Uint8Array 实例 * 可选值：[ ] fromEnc : * 类型：整型 * 默认值：0 * 描述：当前字符编码 * 可选值：[ ] toEnc : * 类型：整型 * 默认值：0 * 描述：目标字符编码 * 可选值：[ ] # buffer.constants # *MAX_LENGTH ***** 在 32 位的架构上，该值是 (2^30)-1 (~1GB)。在 64 位的架构上，该值是 (2^31)-1 (~2GB)。 # *MAX_STRING_LENGTH ***** 表示 string 原始数据类型能有的最大 length，以 UTF-16 代码为单位 # buffer.Blob # [new]-Blob() ***** 封装了可以在多个工作线程之间安全共享的不可变原始数据 # buffer.Buffer # *poolSize ***** 这是用于缓冲池的预分配的内部 Buffer 实例的大小（以字节为单位）。该值可以修改 # byteOffset ***** 偏移量 # length ***** buffer对象大小 # *alloc() ***** 创建指定大小，并且使用0填充的buffer ### 参数说明 size: * 类型：整型 * 默认值：无 * 描述：指定大小 * 可选值：[ ] fill: * 类型：十六进制 * 默认值：无 * 描述：string | Buffer | Uint8Array | integer 用于预填充新 Buffer 的值。默认值: 0 * 可选值：[ ] encoding: * 类型：字符串 * 默认值：utf8 * 描述：如果 fill 是一个字符串，则这是它的字符编码 * 可选值：[ ] # *allocUnsafe() ***** 创建速度快，但是可能包含旧数据 ### 参数说明 size: * 类型：整型 * 默认值：无 * 描述：指定大小 * 可选值：[ ] # *allocUnsafeSlow() ***** 只用作开发人员已经在其应用程序中观察到过度的内存之后的最后手段 ### 参数说明 size: * 类型：整型 * 默认值：无 * 描述：指定大小 * 可选值：[ ] # *from() ***** 创建一个包含 [数组中指定内容] 的 Buffer，使用八位字节数组 array 分配一个新的 Buffer。 ### 参数说明 obj: * 类型：对象 * 默认值：无 * 描述：批量指定内容，可以是数组或字符串 * 可选值：[ ] encoding: * 类型：字符串 * 默认值：无 * 描述：指定编码 * 可选值：[ ascii | utf8 | utf16le | ucs2 | base64 | latin1 | binary | hex ] # *byteLength() ***** 返回字符串的实际字节长度。与 String.prototype.length 不同，后者返回字符串的字符数 ### 参数说明 string: * 类型：对象 * 默认值：无 * 描述：批量指定内容，可以是数组或字符串 * 可选值：[ string | buffer | typedArray | DataView | ArrayBuffer | SharedArrayBuffer ] encoding: * 类型：字符串 * 默认值：无 * 描述：指定编码 * 可选值：[ ascii | utf8 | utf16le | ucs2 | base64 | latin1 | binary | hex ] # *compare() ***** 比较 buf1 与 buf2，主要用于 Buffer 实例数组的排序 ### 参数说明 buf1: * 类型：Buffer * 默认值：无 * 描述：用于比较的buffer * 可选值：[ ] buf1: * 类型：Buffer * 默认值：无 * 描述：用于比较的buffer * 可选值：[ ] ### 示例内容 1. 举例说明 ``` const buf1 = Buffer.from('1234'); const buf2 = Buffer.from('0123'); const arr = [buf1, buf2]; console.log(arr.sort(Buffer.compare)); // 打印: [ <Buffer 30 31 32 33>, <Buffer 31 32 33 34> ] // (结果相当于: [buf2, buf1]) ``` # *concat() ***** 返回一个合并了 list 中所有 Buffer 实例的新 Buffer ### 示例内容 1. 举例说明 ``` // 用含有三个 `Buffer` 实例的数组创建一个单一的 `Buffer`。 const buf1 = Buffer.alloc(10); const buf2 = Buffer.alloc(14); const buf3 = Buffer.alloc(18); const totalLength = buf1.length + buf2.length + buf3.length; console.log(totalLength); // 打印: 42 const bufA = Buffer.concat([buf1, buf2, buf3], totalLength); console.log(bufA); // 打印: <Buffer 00 00 00 00 ...> console.log(bufA.length); // 打印: 42 ``` # *isBuffer() ***** 如果 obj 是一个 Buffer，则返回 true，否则返回 false # *isEncoding() ***** 如果 encoding 是支持的字符编码，则返回 true，否则返回 false。 # write() ***** 根据 encoding 指定的字符编码将 string 写入到 buf 中的 offset 位置 ### 参数说明 string : * 类型：对象 * 默认值：无 * 描述：要写入 buf 的字符串 * 可选值：[ ] offset : * 类型：整型 * 默认值：0 * 描述：开始写入 string 之前要跳过的字节数 * 可选值：[ ] length : * 类型：整型 * 默认值：0 * 描述：要写入的字节数 * 可选值：[ ] encoding : * 类型：整型 * 默认值：buf.length * 描述：string 的字符编码 * 可选值：[ ] ### 示例内容 1. 举例说明 ``` const buf = Buffer.alloc(256); const len = buf.write('\u00bd + \u00bc = \u00be', 0); console.log(`${len} 个字节: ${buf.toString('utf8', 0, len)}`); // 打印: 12 个字节: ½ + ¼ = ¾ ``` # writeBigInt64BE() ***** 用指定的字节序格式写入大端序 # writeBigInt64LE() ***** 用指定的字节序格式写入小端序 # writeBigUInt64BE() ***** 用指定的字节序格式写入大端序 # writeBigUInt64LE() ***** 用指定的字节序格式写入小端序 # writeDoubleBE() ***** 用指定的字节序格式写入大端序 # writeBigInt64LE() ***** 用指定的字节序格式写入小端序 # writeDoubleLE() ***** 用指定的字节序格式写入大端序 # writeFloatBE() ***** 用指定的字节序格式写入小端序 # writeFloatLE() ***** 用指定的字节序格式写入大端序 # writeInt8() ***** 用指定的字节序格式写入小端序 # writeInt16BE() ***** 用指定的字节序格式写入大端序 # writeInt16LE() ***** 用指定的字节序格式写入小端序 # writeInt32BE() ***** 用指定的字节序格式写入大端序 # writeInt32LE() ***** 用指定的字节序格式写入小端序 # writeIntBE() ***** 用指定的字节序格式写入大端序 # writeIntLE() ***** 用指定的字节序格式写入小端序 # writeUInt8() ***** 用指定的字节序格式写入大端序 # writeUInt16BE() ***** 用指定的字节序格式写入小端序 # writeUInt16LE() ***** 用指定的字节序格式写入小端序 # writeUInt32BE() ***** 用指定的字节序格式写入小端序 # writeUInt32LE() ***** 用指定的字节序格式写入小端序 # writeUIntBE() ***** 用指定的字节序格式写入小端序 # writeUIntLE() ***** 用指定的字节序格式写入小端序 # readBigInt64BE() ***** 返回BigInt64大端序 # readBigInt64LE() ***** 返回BigInt64小端序 # readBigUInt64BE() ***** readBigUInt64BE # readBigUInt64LE() ***** readBigUInt64LE # readDoubleBE() ***** readDoubleBE # readDoubleLE() ***** readDoubleLE # readFloatBE() ***** readFloatBE # readFloatLE() ***** readFloatLE # readInt8() ***** readInt8 # readInt16BE() ***** readInt16BE # readInt16LE() ***** readInt16LE # readInt32BE() ***** readInt32BE # readInt32LE() ***** readInt32LE # readIntBE() ***** readIntBE # readIntLE() ***** readIntLE # readUInt8() ***** readUInt8 # readUInt16BE() ***** readUInt16BE # readUInt16LE() ***** readUInt16LE # readUInt32BE() ***** readUInt32BE # readUInt32LE() ***** readUInt32LE # readUIntBE() ***** readUIntBE # readUIntLE() ***** readUIntLE # copy() ***** 拷贝 buf 中某个区域的数据到 target 中的某个区域，即使 target 的内存区域与 buf 的重叠 ### 参数说明 target : * 类型：对象 * 默认值：无 * 描述：要拷贝进的 Buffer 或 Uint8Array * 可选值：[ ] targetStart: * 类型：整型 * 默认值：0 * 描述：target 中开始写入之前要跳过的字节数 * 可选值：[ ] sourceStart : * 类型：整型 * 默认值：0 * 描述：buf 中开始拷贝的偏移量 * 可选值：[ ] sourceEnd : * 类型：整型 * 默认值：buf.length * 描述：buf 中结束拷贝的偏移量（不包含） * 可选值：[ ] ### 示例内容 1. 举例说明 ``` // 创建两个 `Buffer` 实例。 const buf1 = Buffer.allocUnsafe(26); const buf2 = Buffer.allocUnsafe(26).fill('!'); for (let i = 0; i < 26; i++) { // 97 是 'a' 的十进制 ASCII 值。 buf1[i] = i + 97; } // 拷贝 `buf1` 中第 16 至 19 字节偏移量的数据到 `buf2` 第 8 字节偏移量开始。 buf1.copy(buf2, 8, 16, 20); console.log(buf2.toString('ascii', 0, 25)); // 打印: !!!!!!!!qrst!!!!!!!!!!!!! ``` # entries() ***** 返回一个可迭代对象 # equals() ***** 与其它buffer比较查看是否相同 # fill() ***** 用指定的 value 填充 buf。如果没有指定 offset 与 end，则填充整个 buf ### 参数说明 value : * 类型：对象性 * 默认值：无 * 描述：用于填充的内容 * 可选值：[ ] offset : * 类型：整型 * 默认值：无 * 描述：开始填充 buf 的偏移量 * 可选值：[ ] end: * 类型：整型 * 默认值：无 * 描述：结束填充 buf 的偏移量（不包含） * 可选值：[ ] encoding: * 类型：字符串 * 默认值：utf8 * 描述：如果 value 是一个字符串，则这是它的字符编码 * 可选值：[ ] # includes() ***** 如果 buf 查找到 value，则返回 true，否则返回 false # indexOf() ***** 首次出现 value 的索引，如果 buf 没包含 value 则返回 -1 # values() ***** 建并返回 buf 键值（字节）的迭代器。 # keys() ***** 创建并返回 buf 键名（索引）的迭代器。 # lastIndexOf() ***** buf 中最后一次出现 value 的索引，如果 buf 没包含 value 则返回 -1 # subarray() ***** 一个新的 Buffer，它引用与原始的 Buffer 相同的内存，但是由 start 和 end 索引进行偏移和裁剪 ### 参数说明 start: * 类型：整型 * 默认值：无 * 描述：开始索引 * 可选值：[ ] end: * 类型：十六进制 * 默认值：无 * 描述：结束索引 * 可选值：[ ] # slice() ***** 与subarray相同，此方法与 Uint8Array.prototype.slice() 不兼容，后者是 Buffer 的超类 ### 参数说明 start: * 类型：整型 * 默认值：无 * 描述：开始索引 * 可选值：[ ] end: * 类型：十六进制 * 默认值：无 * 描述：结束索引 * 可选值：[ ] # swap16() ***** 将 buf 解析成无符号的 16 位整数的数组，并且以字节顺序原地进行交换 ### 示例内容 1. 举例说明 ``` const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]); console.log(buf1); // 打印: <Buffer 01 02 03 04 05 06 07 08> buf1.swap16(); console.log(buf1); // 打印: <Buffer 02 01 04 03 06 05 08 07> const buf2 = Buffer.from([0x1, 0x2, 0x3]); buf2.swap16(); // 抛出异常 ERR_INVALID_BUFFER_SIZE。 ``` # swap32() ***** 将 buf 解析成无符号的 32 位整数的数组，并且以字节顺序原地进行交换 # swap64() ***** 将 buf 解析成无符号的 64 位整数的数组，并且以字节顺序原地进行交换 # toJSON() ***** 返回 buf 的 JSON 格式 # toString() ***** 转成字符串可以指定编码base64或hex