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