Node.js Buffer(缓冲区)
Node.js Buffer(缓冲区)
JavaScript 语言自身只有字符串数据范例,没有二进制数据范例。
但在处理惩罚像TCP流或文件流时,必需利用到二进制数据。因此在 Node.js中,界说了一个 Buffer 类,该类用来建设一个专门存放二进制数据的缓存区。
在 Node.js 中,Buffer 类是随 Node 内核一起宣布的焦点库。Buffer 库为 Node.js 带来了一种存储原始数据的要领,可以让 Node.js 处理惩罚二进制数据,每当需要在 Node.js 中处理惩罚I/O操纵中移动的数据时,就有大概利用 Buffer 库。原始数据存储在 Buffer 类的实例中。一个 Buffer 雷同于一个整数数组,但它对应于 V8 堆内存之外的一块原始内存。
建设 Buffer 类
Node Buffer 类可以通过多种方法来建设。
要领 1
建设长度为 10 字节的 Buffer 实例:
var buf = new Buffer(10);
要领 2
通过给定的数组建设 Buffer 实例:
var buf = new Buffer([10, 20, 30, 40, 50]);
要领 3
通过一个字符串来建设 Buffer 实例:
var buf = new Buffer("www.runoob.com", "utf-8");
utf-8 是默认的编码方法,另外它同样支持以下编码:”ascii”, “utf8”, “utf16le”, “ucs2”, “base64” 和 “hex”。
写入缓冲区
语法
写入 Node 缓冲区的语法如下所示:
buf.write(string[, offset[, length]][, encoding])
参数
参数描写如下:
string – 写入缓冲区的字符串。
offset – 缓冲区开始写入的索引值,默认为 0 。
length – 写入的字节数,默认为 buffer.length
encoding – 利用的编码。默认为 ‘utf8’ 。
返回值
返回实际写入的巨细。假如 buffer 空间不敷, 则只会写入部门字符串。
实例
buf = new Buffer(256); len = buf.write("www.runoob.com"); console.log("写入字节数 : "+ len);
执行以上代码,输出功效为:
$node main.js 写入字节数 : 14
从缓冲区读取数据
语法
读取 Node 缓冲区数据的语法如下所示:
buf.toString([encoding[, start[, end]]])
参数
参数描写如下:
encoding – 利用的编码。默认为 ‘utf8’ 。
start – 指定开始读取的索引位置,默认为 0。
end – 竣事位置,默认为缓冲区的末端。
返回值
解码缓冲区数据并利用指定的编码返回字符串。
实例
buf = new Buffer(26); for (var i = 0 ; i < 26 ; i++) { buf[i] = i + 97; } console.log( buf.toString('ascii')); // 输出: abcdefghijklmnopqrstuvwxyz console.log( buf.toString('ascii',0,5)); // 输出: abcde console.log( buf.toString('utf8',0,5)); // 输出: abcde console.log( buf.toString(undefined,0,5)); // 利用 'utf8' 编码, 并输出: abcde
执行以上代码,输出功效为:
$ node main.js abcdefghijklmnopqrstuvwxyz abcde abcde abcde
将 Buffer 转换为 JSON 工具
语法
将 Node Buffer 转换为 JSON 工具的函数语法名目如下:
buf.toJSON()
返回值
返回 JSON 工具。
实例
var buf = new Buffer('www.runoob.com'); var json = buf.toJSON(buf); console.log(json);
执行以上代码,输出功效为:
[ 119, 119, 119, 46, 114, 117, 110, 111, 111, 98, 46, 99, 111, 109 ]
缓冲区归并
语法
Node 缓冲区归并的语法如下所示:
Buffer.concat(list[, totalLength])
参数
参数描写如下:
list – 用于归并的 Buffer 工具数组列表。
totalLength – 指定归并后Buffer工具的总长度。
返回值
返回一个多个成员归并的新 Buffer 工具。
实例
var buffer1 = new Buffer('菜鸟教程 '); var buffer2 = new Buffer('www.runoob.com'); var buffer3 = Buffer.concat([buffer1,buffer2]); console.log("buffer3 内容: " + buffer3.toString());
执行以上代码,输出功效为:
buffer3 内容: 菜鸟教程 www.runoob.com
缓冲区较量
语法
Node Buffer 较量的函数语法如下所示, 该要领在 Node.js v0.12.2 版本引入:
buf.compare(otherBuffer);
参数
参数描写如下:
otherBuffer – 与 buf 工具较量的别的一个 Buffer 工具。
返回值
返回一个数字,暗示 buf 在 otherBuffer 之前,之后或沟通。
实例
var buffer1 = new Buffer('ABC'); var buffer2 = new Buffer('ABCD'); var result = buffer1.compare(buffer2); if(result < 0) { console.log(buffer1 + " 在 " + buffer2 + "之前"); }else if(result == 0){ console.log(buffer1 + " 与 " + buffer2 + "沟通"); }else { console.log(buffer1 + " 在 " + buffer2 + "之后"); }
执行以上代码,输出功效为:
ABC在ABCD之前
拷贝缓冲区
语法
Node 缓冲区拷贝语法如下所示:
buf.copy(targetBuffer[, targetStart[, sourceStart[, sourceEnd]]])
参数
参数描写如下:
targetBuffer – 要拷贝的 Buffer 工具。
targetStart – 数字, 可选, 默认: 0
sourceStart – 数字, 可选, 默认: 0
sourceEnd – 数字, 可选, 默认: buffer.length
返回值
#p#分页标题#e#
没有返回值。
实例
var buffer1 = new Buffer('ABC'); // 拷贝一个缓冲区 var buffer2 = new Buffer(3); buffer1.copy(buffer2); console.log("buffer2 content: " + buffer2.toString());
执行以上代码,输出功效为:
buffer2 content: ABC
缓冲区裁剪
Node 缓冲区裁剪语法如下所示:
buf.slice([start[, end]])
参数
参数描写如下:
start – 数字, 可选, 默认: 0
end – 数字, 可选, 默认: buffer.length
返回值
返回一个新的缓冲区,它和旧缓冲区指向同一块内存,可是从索引 start 到 end 的位置剪切。
实例
var buffer1 = new Buffer('runoob'); // 剪切缓冲区 var buffer2 = buffer1.slice(0,2); console.log("buffer2 content: " + buffer2.toString());
执行以上代码,输出功效为:
buffer2 content: ru
缓冲区长度
语法
Node 缓冲区长度计较语法如下所示:
buf.length;
返回值
返回 Buffer 工具所占据的内存长度。
实例
var buffer = new Buffer('www.runoob.com'); // 缓冲区长度 console.log("buffer length: " + buffer.length);
执行以上代码,输出功效为:
buffer length: 14
要领参考手册
以下列出了 Node.js Buffer 模块常用的要领(留意有些要领在旧版本是没有的):
序号 | 要领 & 描写 |
---|---|
1 |
new Buffer(size) 分派一个新的 size 巨细单元为8位字节的 buffer。 留意, size 必需小于 kMaxLength,不然,将会抛出异常 RangeError。 |
2 |
new Buffer(buffer) 拷贝参数 buffer 的数据到 Buffer 实例。 |
3 |
new Buffer(str[, encoding]) 分派一个新的 buffer ,个中包括着传入的 str 字符串。 encoding 编码方法默认为 ‘utf8’。 |
4 |
buf.length 返回这个 buffer 的 bytes 数。留意这未必是 buffer 内里内容的巨细。length 是 buffer 工具所分派的内存数,它不会跟着这个 buffer 工具内容的改变而改变。 |
5 |
buf.write(string[, offset[, length]][, encoding]) 按照参数 offset 偏移量和指定的 encoding 编码方法,将参数 string 数据写入buffer。 offset 偏移量默认值是 0, encoding 编码方法默认是 utf8。 length 长度是将要写入的字符串的 bytes 巨细。 返回 number 范例,暗示写入了几多 8 位字节约。假如 buffer 没有足够的空间来放整个 string,它将只会只写入部门字符串。 length 默认是 buffer.length – offset。 这个要领不会呈现写入部门字符。 |
6 |
buf.writeUIntLE(value, offset, byteLength[, noAssert]) 将 value 写入到 buffer 里, 它由 offset 和 byteLength 抉择,最高支持 48 位无标记整数,小端对齐,譬喻: var b = new Buffer(6); b.writeUIntBE(0x1234567890ab, 0, 6); // <Buffer 12 34 56 78 90 ab> noAssert 值为 true 时,不再验证 value 和 offset 的有效性。 默认是 false。 |
7 |
buf.writeUIntBE(value, offset, byteLength[, noAssert]) 将 value 写入到 buffer 里, 它由 offset 和 byteLength 抉择,最高支持 48 位无标记整数,大端对齐。noAssert 值为 true 时,不再验证 value 和 offset 的有效性。 默认是 false。 |
8 |
buf.writeIntLE(value, offset, byteLength[, noAssert]) 将value 写入到 buffer 里, 它由offset 和 byteLength 抉择,最高支持48位有标记整数,小端对齐。noAssert 值为 true 时,不再验证 value 和 offset 的有效性。 默认是 false。 |
9 |
buf.writeIntBE(value, offset, byteLength[, noAssert]) 将value 写入到 buffer 里, 它由offset 和 byteLength 抉择,最高支持48位有标记整数,大端对齐。noAssert 值为 true 时,不再验证 value 和 offset 的有效性。 默认是 false。 |
10 |
buf.readUIntLE(offset, byteLength[, noAssert]) 支持读取 48 位以下的无标记数字,小端对齐。noAssert 值为 true 时, offset 不再验证是否高出 buffer 的长度,默认为 false。 |
11 |
buf.readUIntBE(offset, byteLength[, noAssert]) 支持读取 48 位以下的无标记数字,大端对齐。noAssert 值为 true 时, offset 不再验证是否高出 buffer 的长度,默认为 false。 |
12 |
buf.readIntLE(offset, byteLength[, noAssert]) 支持读取 48 位以下的有标记数字,小端对齐。noAssert 值为 true 时, offset 不再验证是否高出 buffer 的长度,默认为 false。 |
13 |
buf.readIntBE(offset, byteLength[, noAssert]) 支持读取 48 位以下的有标记数字,大端对齐。noAssert 值为 true 时, offset 不再验证是否高出 buffer 的长度,默认为 false。 |
14 |
buf.toString([encoding[, start[, end]]]) 按照 encoding 参数(默认是 ‘utf8’)返回一个解码过的 string 范例。还会按照传入的参数 start (默认是 0) 和 end (默认是 buffer.length)作为取值范畴。 |
15 |
buf.toJSON() 将 Buffer 实例转换为 JSON 工具。 |
16 |
buf[index] 获取或配置指定的字节。返回值代表一个字节,所以返回值的正当范畴是十六进制0x00到0xFF 可能十进制0至 255。 |
17 |
buf.equals(otherBuffer) 较量两个缓冲区是否相等,假如是返回 true,不然返回 false。 |
18 |
buf.compare(otherBuffer) 较量两个 Buffer 工具,返回一个数字,暗示 buf 在 otherBuffer 之前,之后或沟通。 |
19 |
buf.copy(targetBuffer[, targetStart[, sourceStart[, sourceEnd]]]) buffer 拷贝,源和方针可以沟通。 targetStart 方针开始偏移和 sourceStart 源开始偏移默认都是 0。 sourceEnd 源竣事位置偏移默认是源的长度 buffer.length 。 |
20 |
buf.slice([start[, end]]) 剪切 Buffer 工具,按照 start(默认是 0 ) 和 end (默认是 buffer.length ) 偏移和裁剪了索引。 负的索引是从 buffer 尾部开始计较的。 |
21 |
buf.readUInt8(offset[, noAssert]) 按照指定的偏移量,读取一个无标记 8 位整数。若参数 noAssert 为 true 将不会验证 offset 偏移量参数。 假如这样 offset 大概会超出buffer 的末端。默认是 false。 |
22 |
buf.readUInt16LE(offset[, noAssert]) 按照指定的偏移量,利用非凡的 endian 字节序名目读取一个无标记 16 位整数。若参数 noAssert 为 true 将不会验证 offset 偏移量参数。 这意味着 offset 大概会超出 buffer 的末端。默认是 false。 |
23 |
buf.readUInt16BE(offset[, noAssert]) 按照指定的偏移量,利用非凡的 endian 字节序名目读取一个无标记 16 位整数,大端对齐。若参数 noAssert 为 true 将不会验证 offset 偏移量参数。 这意味着 offset 大概会超出 buffer 的末端。默认是 false。 |
24 |
buf.readUInt32LE(offset[, noAssert]) 按照指定的偏移量,利用指定的 endian 字节序名目读取一个无标记 32 位整数,小端对齐。 若参数 noAssert 为 true 将不会验证 offset 偏移量参数。 这意味着 offset 大概会超出buffer 的末端。默认是 false。 |
25 |
buf.readUInt32BE(offset[, noAssert]) 按照指定的偏移量,利用指定的 endian 字节序名目读取一个无标记 32 位整数,大端对齐。 若参数 noAssert 为 true 将不会验证 offset 偏移量参数。 这意味着 offset 大概会超出buffer 的末端。默认是 false。 |
26 |
buf.readInt8(offset[, noAssert]) 按照指定的偏移量,读取一个有标记 8 位整数。 若参数 noAssert 为 true 将不会验证 offset 偏移量参数。 这意味着 offset 大概会超出 buffer 的末端。默认是 false。 |
27 |
buf.readInt16LE(offset[, noAssert]) 按照指定的偏移量,利用非凡的 endian 名目读取一个 有标记 16 位整数,小端对齐。 若参数 noAssert 为 true 将不会验证 offset 偏移量参数。 这意味着 offset 大概会超出 buffer 的末端。默认是 false。 |
28 |
buf.readInt16BE(offset[, noAssert]) 按照指定的偏移量,利用非凡的 endian 名目读取一个 有标记 16 位整数,大端对齐。 若参数 noAssert 为 true 将不会验证 offset 偏移量参数。 这意味着 offset 大概会超出 buffer 的末端。默认是 false。 |
29 |
buf.readInt32LE(offset[, noAssert]) 按照指定的偏移量,利用指定的 endian 字节序名目读取一个有标记 32 位整数,小端对齐。 若参数 noAssert 为 true 将不会验证 offset 偏移量参数。 这意味着 offset 大概会超出buffer 的末端。默认是 false。 |
30 |
buf.readInt32BE(offset[, noAssert]) 按照指定的偏移量,利用指定的 endian 字节序名目读取一个有标记 32 位整数,大端对齐。 若参数 noAssert 为 true 将不会验证 offset 偏移量参数。 这意味着 offset 大概会超出buffer 的末端。默认是 false。 |
31 |
buf.readFloatLE(offset[, noAssert]) 按照指定的偏移量,利用指定的 endian 字节序名目读取一个 32 位双浮点数,小端对齐。 若参数 noAssert 为 true 将不会验证 offset 偏移量参数。 这意味着 offset 大概会超出buffer的末端。默认是 false。 |
32 |
buf.readFloatBE(offset[, noAssert]) 按照指定的偏移量,利用指定的 endian 字节序名目读取一个 32 位双浮点数,大端对齐。 若参数 noAssert 为 true 将不会验证 offset 偏移量参数。 这意味着 offset 大概会超出buffer的末端。默认是 false。 |
33 |
buf.readDoubleLE(offset[, noAssert]) 按照指定的偏移量,利用指定的 endian字节序名目读取一个 64 位双精度数,小端对齐。 若参数 noAssert 为 true 将不会验证 offset 偏移量参数。 这意味着 offset 大概会超出buffer 的末端。默认是 false。 |
34 |
buf.readDoubleBE(offset[, noAssert]) 按照指定的偏移量,利用指定的 endian字节序名目读取一个 64 位双精度数,大端对齐。 若参数 noAssert 为 true 将不会验证 offset 偏移量参数。 这意味着 offset 大概会超出buffer 的末端。默认是 false。 |
35 |
buf.writeUInt8(value, offset[, noAssert]) 按照传入的 offset 偏移量将 value 写入 buffer。留意:value 必需是一个正当的无标记 8 位整数。 若参数 noAssert 为 true 将不会验证 offset 偏移量参数。 这意味着 value 大概过大,可能 offset 大概会超出 buffer 的末端从而造成 value 被扬弃。 除非你对这个参数很是有掌握,不然不要利用。默认是 false。 |
36 |
buf.writeUInt16LE(value, offset[, noAssert]) 按照传入的 offset 偏移量和指定的 endian 名目将 value 写入 buffer。留意:value 必需是一个正当的无标记 16 位整数,小端对齐。 若参数 noAssert 为 true 将不会验证 value 和 offset 偏移量参数。 这意味着 value 大概过大,可能 offset 大概会超出buffer的末端从而造成 value 被扬弃。 除非你对这个参数很是有掌握,不然只管不要利用。默认是 false。 |
37 |
buf.writeUInt16BE(value, offset[, noAssert]) 按照传入的 offset 偏移量和指定的 endian 名目将 value 写入 buffer。留意:value 必需是一个正当的无标记 16 位整数,大端对齐。 若参数 noAssert 为 true 将不会验证 value 和 offset 偏移量参数。 这意味着 value 大概过大,可能 offset 大概会超出buffer的末端从而造成 value 被扬弃。 除非你对这个参数很是有掌握,不然只管不要利用。默认是 false。 |
38 |
buf.writeUInt32LE(value, offset[, noAssert]) 按照传入的 offset 偏移量和指定的 endian 名目(LITTLE-ENDIAN:小字节序)将 value 写入buffer。留意:value 必需是一个正当的无标记 32 位整数,小端对齐。 若参数 noAssert 为 true 将不会验证 value 和 offset 偏移量参数。 这意味着value 大概过大,可能offset大概会超出buffer的末端从而造成 value 被扬弃。 除非你对这个参数很是有掌握,不然只管不要利用。默认是 false。 |
39 |
buf.writeUInt32BE(value, offset[, noAssert]) 按照传入的 offset 偏移量和指定的 endian 名目(Big-Endian:大字节序)将 value 写入buffer。留意:value 必需是一个正当的有标记 32 位整数。 若参数 noAssert 为 true 将不会验证 value 和 offset 偏移量参数。 这意味着 value 大概过大,可能offset大概会超出buffer的末端从而造成 value 被扬弃。 除非你对这个参数很是有掌握,不然只管不要利用。默认是 false。 |
40 |
buf.writeInt8(value, offset[, noAssert]) |
41 |
buf.writeInt16LE(value, offset[, noAssert]) 按照传入的 offset 偏移量和指定的 endian 名目将 value 写入 buffer。留意:value 必需是一个正当的 signed 16 位整数。 若参数 noAssert 为 true 将不会验证 value 和 offset 偏移量参数。 这意味着 value 大概过大,可能 offset 大概会超出 buffer 的末端从而造成 value 被扬弃。 除非你对这个参数很是有掌握,不然只管不要利用。默认是 false 。 |
42 |
buf.writeInt16BE(value, offset[, noAssert]) 按照传入的 offset 偏移量和指定的 endian 名目将 value 写入 buffer。留意:value 必需是一个正当的 signed 16 位整数。 若参数 noAssert 为 true 将不会验证 value 和 offset 偏移量参数。 这意味着 value 大概过大,可能 offset 大概会超出 buffer 的末端从而造成 value 被扬弃。 除非你对这个参数很是有掌握,不然只管不要利用。默认是 false 。 |
43 |
buf.writeInt32LE(value, offset[, noAssert]) 按照传入的 offset 偏移量和指定的 endian 名目将 value 写入 buffer。留意:value 必需是一个正当的 signed 32 位整数。 若参数 noAssert 为 true 将不会验证 value 和 offset 偏移量参数。 这意味着 value 大概过大,可能 offset 大概会超出 buffer 的末端从而造成 value 被扬弃。 除非你对这个参数很是有掌握,不然只管不要利用。默认是 false。 |
44 |
buf.writeInt32BE(value, offset[, noAssert]) 按照传入的 offset 偏移量和指定的 endian 名目将 value 写入 buffer。留意:value 必需是一个正当的 signed 32 位整数。 若参数 noAssert 为 true 将不会验证 value 和 offset 偏移量参数。 这意味着 value 大概过大,可能 offset 大概会超出 buffer 的末端从而造成 value 被扬弃。 除非你对这个参数很是有掌握,不然只管不要利用。默认是 false。 |
45 |
buf.writeFloatLE(value, offset[, noAssert]) 按照传入的 offset 偏移量和指定的 endian 名目将 value 写入 buffer 。留意:当 value 不是一个 32 位浮点数范例的值时,功效将是不确定的。 若参数 noAssert 为 true 将不会验证 value 和 offset 偏移量参数。 这意味着 value大概过大,可能 offset 大概会超出 buffer 的末端从而造成 value 被扬弃。 除非你对这个参数很是有掌握,不然只管不要利用。默认是 false。 |
46 |
buf.writeFloatBE(value, offset[, noAssert]) 按照传入的 offset 偏移量和指定的 endian 名目将 value 写入 buffer 。留意:当 value 不是一个 32 位浮点数范例的值时,功效将是不确定的。 若参数 noAssert 为 true 将不会验证 value 和 offset 偏移量参数。 这意味着 value大概过大,可能 offset 大概会超出 buffer 的末端从而造成 value 被扬弃。 除非你对这个参数很是有掌握,不然只管不要利用。默认是 false。 |
47 |
buf.writeDoubleLE(value, offset[, noAssert]) 按照传入的 offset 偏移量和指定的 endian 名目将 value 写入 buffer。留意:value 必需是一个有效的 64 位double 范例的值。 若参数 noAssert 为 true 将不会验证 value 和 offset 偏移量参数。 这意味着 value 大概过大,可能 offset 大概会超出 buffer 的末端从而造成value被扬弃。 除非你对这个参数很是有掌握,不然只管不要利用。默认是 false。 |
48 |
buf.writeDoubleBE(value, offset[, noAssert]) 按照传入的 offset 偏移量和指定的 endian 名目将 value 写入 buffer。留意:value 必需是一个有效的 64 位double 范例的值。 若参数 noAssert 为 true 将不会验证 value 和 offset 偏移量参数。 这意味着 value 大概过大,可能 offset 大概会超出 buffer 的末端从而造成value被扬弃。 除非你对这个参数很是有掌握,不然只管不要利用。默认是 false。 |
49 |
buf.fill(value[, offset][, end]) 利用指定的 value 来填充这个 buffer。假如没有指定 offset (默认是 0) 而且 end (默认是 buffer.length) ,将会填充整个buffer。 |