©
This document uses PHP Chinese website manual Release
稳定性: 3 - 稳定
纯 Javascript 语言对 Unicode 友好,但是难以处理二进制数据。在处理 TCP 流和文件系统时经常需要操作字节流。Node 提供了一些机制,用于操作、创建、以及消耗字节流。
在 Buffer 类实例化中存储了原始数据。 Buffer 类似于一个整数数组,在 V8 堆(the V8 heap)原始存储空间给它分配了内存。一旦创建了 Buffer 实例,则无法改变大小。
Buffer
类是全局对象,所以访问它不必使用 require('buffer')
。
Buffers 和 Javascript 字符串对象之间转换时需要一个明确的编码方法。下面是字符串的不同编码。
'ascii'
- 7位的 ASCII 数据。这种编码方式非常快,它会移除最高位内容。
'utf8'
- 多字节编码 Unicode 字符。大部分网页和文档使用这类编码方式。
'utf16le'
- 2个或4个字节, Little Endian (LE) 编码 Unicode 字符。编码范围 (U+10000 到 U+10FFFF) 。
'ucs2'
- 'utf16le'
的子集。
'base64'
- Base64 字符编码。
'binary'
- 仅使用每个字符的头8位将原始的二进制信息进行编码。在需使用 Buffer 的情况下,应该尽量避免使用这个已经过时的编码方式。这个编码方式将会在未来某个版本中弃用。
'hex'
- 每个字节都采用 2 进制编码。
在Buffer
中创建一个数组,需要注意以下规则:
Buffer 是内存拷贝,而不是内存共享。
Buffer 占用内存被解释为一个数组,而不是字节数组。比如,new Uint32Array(new Buffer([1,2,3,4]))
创建了4个 Uint32Array
,它的成员为 [1,2,3,4]
,而不是[0x1020304]
或 [0x4030201]
。
注意:Node.js v0.8 只是简单的引用了array.buffer
里的 buffer ,而不是克隆(cloning)。
介绍一个高效的方法,ArrayBuffer#slice()
拷贝了一份切片,而 Buffer#slice()
新建了一份。
Buffer 类是全局变量类型,用来直接处理2进制数据。 它能够使用多种方式构建。
size
Number 类型
分配一个新的 size
大小单位为8位字节的 buffer。 注意, size
必须小于kMaxLength,否则,将会抛出异常 RangeError
。
array
Array
使用一个8位字节 array
数组分配一个新的 buffer。
buffer
{Buffer}
拷贝参数 buffer
的数据到 Buffer
实例。
str
String 类型 - 需要编码的字符串。
encoding
String 类型 - 编码方式, 可选。
分配一个新的 buffer ,其中包含着传入的 str
字符串。encoding
编码方式默认为 'utf8'
。
encoding
{String} 用来测试给定的编码字符串
如果参数编码 encoding
是有效的,返回 true,否则返回 false。
obj
对象
返回: Boolean
obj
如果是 Buffer
返回 true, 否则返回 false。
string
String 类型
encoding
String 类型, 可选, 默认: 'utf8'
返回: Number 类型
将会返回这个字符串真实字节长度。 encoding 编码默认是:utf8
。 这和 String.prototype.length
不一样,因为那个方法返回这个字符串中字符的数量。
例如:
str = '\u00bd + \u00bc = \u00be'; console.log(str + ": " + str.length + " characters, " + Buffer.byteLength(str, 'utf8') + " bytes"); // ½ + ¼ = ¾: 9 characters, 12 bytes
list
{Array} 用来连接的数组
totalLength
{Number 类型} 数组里所有对象的总buffer大小
返回一个buffer对象,它将参数 buffer 数组中所有 buffer 对象拼接在一起。
如果传入的数组没有内容,或者 totalLength 是 0,那将返回一个长度为 0 的buffer。
如果数组长度为 1,返回数组第一个成员。
如果数组长度大于 0,将会创建一个新的 Buffer 实例。
如果没有提供 totalLength 参数,会根据 buffer 数组计算,这样会增加一个额外的循环计算,所以提供一个准确的 totalLength 参数速度更快。
buf1
{Buffer}
buf2
{Buffer}
和 buf1.compare(buf2)
一样。 用来对数组排序:
var arr = [Buffer('1234'), Buffer('0123')]; arr.sort(Buffer.compare);
Number 类型
返回这个 buffer 的 bytes 数。注意这未必是 buffer 里面内容的大小。length
是 buffer 对象所分配的内存数,它不会随着这个 buffer 对象内容的改变而改变。
buf = new Buffer(1234); console.log(buf.length); buf.write("some string", 0, "ascii"); console.log(buf.length); // 1234 // 1234
length
不能改变,如果改变 length
将会导致不可以预期的结果。如果想要改变 buffer 的长度,需要使用 buf.slice
来创建新的 buffer。
buf = new Buffer(10); buf.write("abcdefghj", 0, "ascii"); console.log(buf.length); // 10 buf = buf.slice(0,5); console.log(buf.length); // 5
string
String 类型 - 写到 buffer 里
offset
Number 类型, 可选参数, 默认值: 0
length
Number 类型, 可选参数, 默认值: buffer.length - offset
encoding
String 类型, 可选参数, 默认值: 'utf8'
根据参数 offset 偏移量和指定的 encoding 编码方式,将参数 string 数据写入buffer。 offset 偏移量默认值是 0, encoding 编码方式默认是 utf8
。 length 长度是将要写入的字符串的 bytes 大小。 返回 number 类型,表示写入了多少 8 位字节流。如果 buffer 没有足够的空间来放整个 string,它将只会只写入部分字符串。 length 默认是 buffer.length - offset。 这个方法不会出现写入部分字符。
buf = new Buffer(256); len = buf.write('\u00bd + \u00bc = \u00be', 0); console.log(len + " bytes: " + buf.toString('utf8', 0, len));
value
{Number 类型} 准备写到 buffer 字节数
offset
{Number 类型} 0 <= offset <= buf.length
byteLength
{Number 类型} 0 < byteLength <= 6
noAssert
{Boolean} 默认值: false
返回: {Number 类型}
将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
。
offset
{Number 类型} 0 <= offset <= buf.length
byteLength
{Number 类型} 0 < byteLength <= 6
noAssert
{Boolean} 默认值: false
返回: {Number 类型}
支持 48 位以下的数字读取。 例如:
var b = new Buffer(6); b.writeUint16LE(0x90ab, 0); b.writeUInt32LE(0x12345678, 2); b.readUIntLE(0, 6).toString(16); // 指定为 6 bytes (48 bits) // 输出: '1234567890ab'
noAssert
值为 true 时, offset
不再验证是否超过 buffer 的长度,默认为 false
。
encoding
String 类型, 可选参数, 默认值: 'utf8'
start
Number 类型, 可选参数, 默认值: 0
end
Number 类型, 可选参数, 默认值: buffer.length
根据 encoding 参数(默认是 'utf8')返回一个解码过的 string 类型。还会根据传入的参数 start (默认是 0) 和 end (默认是 buffer.length)作为取值范围。
buf = new Buffer(26); for (var i = 0 ; i < 26 ; i++) { buf[i] = i + 97; // 97 is ASCII a } buf.toString('ascii'); // 输出: abcdefghijklmnopqrstuvwxyz buf.toString('ascii',0,5); // 输出: abcde buf.toString('utf8',0,5); // 输出: abcde buf.toString(undefined,0,5); // encoding defaults to 'utf8', 输出 abcde
查看上面 buffer.write()
例子。
返回一个 JSON 表示的 Buffer 实例。JSON.stringify
将会默认调用字符串序列化这个 Buffer 实例。
例如:
var buf = new Buffer('test'); var json = JSON.stringify(buf); console.log(json); // '{"type":"Buffer","data":[116,101,115,116]}' var copy = JSON.parse(json, function(key, value) { return value && value.type === 'Buffer' ? new Buffer(value.data) : value; }); console.log(copy); // <Buffer 74 65 73 74>
获取或设置指定 index 位置的 8 位字节。这个值是指单个字节,所以必须在合法的范围取值,16 进制的 0x00 到 0xFF,或者 0 到 255。
例如: 拷贝一个 ASCII 编码的 string 字符串到一个 buffer, 一次一个 byte 进行拷贝:
str = "node.js"; buf = new Buffer(str.length); for (var i = 0; i < str.length ; i++) { buf[i] = str.charCodeAt(i); } console.log(buf); // node.js
otherBuffer
{Buffer}
如果 this
和 otherBuffer
拥有相同的内容,返回 true。
otherBuffer
{Buffer}
返回一个数字,表示 this
在 otherBuffer
之前,之后或相同。
targetBuffer
Buffer 对象 - Buffer to copy into
targetStart
Number 类型, 可选参数, 默认值: 0
sourceStart
Number 类型, 可选参数, 默认值: 0
sourceEnd
Number 类型, 可选参数, 默认值: buffer.length
buffer 拷贝,源和目标可以相同。 targetStart
目标开始偏移和 sourceStart
源开始偏移默认都是 0。 sourceEnd
源结束位置偏移默认是源的长度 buffer.length
。
例如:创建 2 个Buffer,然后把 buf1 的 16 到 19 位内容拷贝到 buf2 第 8 位之后。
buf1 = new Buffer(26); buf2 = new Buffer(26); for (var i = 0 ; i < 26 ; i++) { buf1[i] = i + 97; // 97 is ASCII a buf2[i] = 33; // ASCII ! } buf1.copy(buf2, 8, 16, 20); console.log(buf2.toString('ascii', 0, 25)); // !!!!!!!!qrst!!!!!!!!!!!!!
例如: 在同一个buffer中,从一个区域拷贝到另一个区域
buf = new Buffer(26); for (var i = 0 ; i < 26 ; i++) { buf[i] = i + 97; // 97 is ASCII a } buf.copy(buf, 0, 4, 10); console.log(buf.toString()); // efghijghijklmnopqrstuvwxyz
start
Number 类型, 可选参数, 默认值: 0
end
Number 类型, 可选参数, 默认值: buffer.length
返回一个新的buffer,这个buffer将会和老的buffer引用相同的内存地址,根据 start
(默认是 0
) 和 end
(默认是 buffer.length
) 偏移和裁剪了索引。 负的索引是从 buffer 尾部开始计算的。
修改这个新的 buffer 实例 slice 切片,也会改变原来的 buffer!
例如: 创建一个 ASCII 字母的 Buffer,进行 slice 切片,然后修改源 Buffer 上的一个 byte。
var buf1 = new Buffer(26); for (var i = 0 ; i < 26 ; i++) { buf1[i] = i + 97; // 97 is ASCII a } var buf2 = buf1.slice(0, 3); console.log(buf2.toString('ascii', 0, buf2.length)); buf1[0] = 33; console.log(buf2.toString('ascii', 0, buf2.length)); // abc // !bc
offset
Number 类型
noAssert
Boolean, 可选参数, 默认值: false
返回: Number 类型
从这个 buffer 对象里,根据指定的偏移量,读取一个有符号 8 位整数 整形。
若参数 noAssert
为 true 将不会验证 offset
偏移量参数。 如果这样 offset
可能会超出buffer 的末尾。默认是 false
。
例如:
var buf = new Buffer(4); buf[0] = 0x3; buf[1] = 0x4; buf[2] = 0x23; buf[3] = 0x42; for (ii = 0; ii < buf.length; ii++) { console.log(buf.readUInt8(ii)); } // 0x3 // 0x4 // 0x23 // 0x42
offset
Number 类型
noAssert
Boolean, 可选参数, 默认值: false
返回: Number 类型
从 buffer 对象里,根据指定的偏移量,使用特殊的 endian 字节序格式读取一个有符号 16 位整数。
若参数 noAssert
为 true 将不会验证 offset
偏移量参数。 这意味着 offset
可能会超出 buffer 的末尾。默认是 false
。
例如:
var buf = new Buffer(4); buf[0] = 0x3; buf[1] = 0x4; buf[2] = 0x23; buf[3] = 0x42; console.log(buf.readUInt16BE(0)); console.log(buf.readUInt16LE(0)); console.log(buf.readUInt16BE(1)); console.log(buf.readUInt16LE(1)); console.log(buf.readUInt16BE(2)); console.log(buf.readUInt16LE(2)); // 0x0304 // 0x0403 // 0x0423 // 0x2304 // 0x2342 // 0x4223
offset
Number 类型
noAssert
Boolean, 可选参数, 默认值: false
返回: Number 类型
从这个 buffer 对象里,根据指定的偏移量,使用指定的 endian 字节序格式读取一个有符号 32 位整数。
若参数 noAssert
为 true 将不会验证 offset
偏移量参数。 这意味着 offset
可能会超出buffer 的末尾。默认是 false
。
例如:
var buf = new Buffer(4); buf[0] = 0x3; buf[1] = 0x4; buf[2] = 0x23; buf[3] = 0x42; console.log(buf.readUInt32BE(0)); console.log(buf.readUInt32LE(0)); // 0x03042342 // 0x42230403
offset
Number 类型
noAssert
Boolean, 可选参数, 默认值: false
返回: Number 类型
从这个 buffer 对象里,根据指定的偏移量,读取一个 signed 8 位整数。
若参数 noAssert
为 true 将不会验证 offset
偏移量参数。 这意味着 offset 可能会超出 buffer 的末尾。默认是 false
。
返回和 buffer.readUInt8
一样,除非 buffer 中包含了有作为2 的补码的有符号值。
offset
Number 类型
noAssert
Boolean, 可选参数, 默认值: false
返回: Number 类型
从这个 buffer 对象里,根据指定的偏移量,使用特殊的 endian 格式读取一个 signed 16 位整数。
若参数 noAssert
为 true 将不会验证 offset
偏移量参数。 这意味着 offset 可能会超出 buffer 的末尾。默认是 false
。
返回和 buffer.readUInt16
一样,除非 buffer 中包含了有作为 2 的补码的有符号值。
offset
Number 类型
noAssert
Boolean, 可 位选参数, 默认值: false
返回: Number 类型
从这个 buffer 对象里,根据指定的偏移量,使用指定的 endian 字节序格式读取一个 signed 32 位整数。
若参数 noAssert
为 true 将不会验证 offset
偏移量参数。 这意味着 offset
可能会超出buffer 的末尾。默认是 false
。
和 buffer.readUInt32
一样返回,除非 buffer 中包含了有作为 2 的补码的有符号值。
offset
Number 类型
noAssert
Boolean, 可选参数, 默认值: false
返回: Number 类型
从这个 buffer 对象里,根据指定的偏移量,使用指定的 endian 字节序格式读取一个 32 位浮点数。
若参数 noAssert
为 true 将不会验证 offset
偏移量参数。 这意味着 offset
可能会超出buffer的末尾。默认是 false
。
例如:
var buf = new Buffer(4); buf[0] = 0x00; buf[1] = 0x00; buf[2] = 0x80; buf[3] = 0x3f; console.log(buf.readFloatLE(0)); // 0x01
offset
Number 类型
noAssert
Boolean, 可选参数, 默认值: false
返回: Number 类型
从这个 buffer 对象里,根据指定的偏移量,使用指定的 endian字节序格式读取一个 64 位double。
若参数 noAssert
为 true 将不会验证 offset
偏移量参数。 这意味着 offset
可能会超出buffer 的末尾。默认是 false
。
例如:
var buf = new Buffer(8); buf[0] = 0x55; buf[1] = 0x55; buf[2] = 0x55; buf[3] = 0x55; buf[4] = 0x55; buf[5] = 0x55; buf[6] = 0xd5; buf[7] = 0x3f; console.log(buf.readDoubleLE(0)); // 0。3333333333333333
value
Number 类型
offset
Number 类型
noAssert
Boolean, 可选参数, 默认值: false
根据传入的 offset
偏移量将 value
写入 buffer。注意:value
必须是一个合法的有符号 8 位整数。
若参数 noAssert
为 true 将不会验证 offset
偏移量参数。 这意味着 value
可能过大,或者 offset
可能会超出 buffer 的末尾从而造成 value 被丢弃。 除非你对这个参数非常有把握,否则不要使用。默认是 false
。
例如:
var buf = new Buffer(4); buf.writeUInt8(0x3, 0); buf.writeUInt8(0x4, 1); buf.writeUInt8(0x23, 2); buf.writeUInt8(0x42, 3); console.log(buf); // <Buffer 03 04 23 42>
value
Number 类型
offset
Number 类型
noAssert
Boolean, 可选参数, 默认值: false
根据传入的 offset
偏移量和指定的 endian 格式将 value
写入 buffer。注意:value
必须是一个合法的有符号 16 位整数。
若参数 noAssert
为 true 将不会验证 value
和 offset
偏移量参数。 这意味着 value
可能过大,或者 offset
可能会超出buffer的末尾从而造成 value 被丢弃。 除非你对这个参数非常有把握,否则尽量不要使用。默认是 false
。
例如:
var buf = new Buffer(4); buf.writeUInt16BE(0xdead, 0); buf.writeUInt16BE(0xbeef, 2); console.log(buf); buf.writeUInt16LE(0xdead, 0); buf.writeUInt16LE(0xbeef, 2); console.log(buf); // <Buffer de ad be ef> // <Buffer ad de ef be>
value
Number 类型
offset
Number 类型
noAssert
Boolean, 可选参数, 默认值: false
根据传入的 offset
偏移量和指定的 endian 格式将 value
写入buffer。注意:value
必须是一个合法的有符号 32 位整数。
若参数 noAssert
为 true 将不会验证 value
和 offset
偏移量参数。 这意味着value
可能过大,或者offset可能会超出buffer的末尾从而造成 value
被丢弃。 除非你对这个参数非常有把握,否则尽量不要使用。默认是 false
。
例如:
var buf = new Buffer(4); buf.writeUInt32BE(0xfeedface, 0); console.log(buf); buf.writeUInt32LE(0xfeedface, 0); console.log(buf); // <Buffer fe ed fa ce> // <Buffer ce fa ed fe>
value
Number 类型
offset
Number 类型
noAssert
Boolean, 可选参数, 默认值: false
根据传入的 offset
偏移量将 value
写入 buffer 。注意:value
必须是一个合法的 signed 8 位整数。
若参数 noAssert
为 true 将不会验证 value
和 offset
偏移量参数。 这意味着 value
可能过大,或者 offset 可能会超出 buffer 的末尾从而造成 value
被丢弃。 除非你对这个参数非常有把握,否则尽量不要使用。默认是 false
。
和 buffer.writeUInt8
一样工作,除非是把有2的补码的 有符号整数
有符号整形写入buffer。
value
Number 类型
offset
Number 类型
noAssert
Boolean, 可选参数, 默认值: false
根据传入的 offset
偏移量和指定的 endian 格式将 value
写入 buffer。注意:value
必须是一个合法的 signed 16 位整数。
若参数 noAssert
为 true 将不会验证 value
和 offset
偏移量参数。 这意味着 value
可能过大,或者 offset 可能会超出 buffer 的末尾从而造成 value
被丢弃。 除非你对这个参数非常有把握,否则尽量不要使用。默认是 false
。
和 buffer.writeUInt16*
一样工作,除非是把有2的补码的有符号整数 有符号整形写入buffer
。
value
Number 类型
offset
Number 类型
noAssert
Boolean, 可选参数, 默认值: false
根据传入的 offset
偏移量和指定的 endian 格式将 value
写入 buffer。注意:value
必须是一个合法的 signed 32 位整数。
若参数 noAssert
为 true 将不会验证 value
和 offset
偏移量参数。 这意味着 value
可能过大,或者 offset
可能会超出 buffer 的末尾从而造成 value
被丢弃。 除非你对这个参数非常有把握,否则尽量不要使用。默认是 false
。
和 buffer.writeUInt32*
一样工作,除非是把有2的补码的有符号整数 有符号整形写入buffer。
value
Number 类型
offset
Number 类型
noAssert
Boolean, 可选参数, 默认值: false
根据传入的 offset
偏移量和指定的 endian 格式将 value
写入 buffer 。注意:当 value
不是一个 32 位浮点数类型的值时,结果将是不确定的。
若参数 noAssert
为 true 将不会验证 value
和 offset
偏移量参数。 这意味着 value可能过大,或者 offset 可能会超出 buffer 的末尾从而造成 value
被丢弃。 除非你对这个参数非常有把握,否则尽量不要使用。默认是 false
。
例如:
var buf = new Buffer(4); buf.writeFloatBE(0xcafebabe, 0); console.log(buf); buf.writeFloatLE(0xcafebabe, 0); console.log(buf); // <Buffer 4f 4a fe bb> // <Buffer bb fe 4a 4f>
value
Number 类型
offset
Number 类型
noAssert
Boolean, 可选参数, 默认值: false
根据传入的 offset
偏移量和指定的 endian 格式将 value
写入 buffer。注意:value
必须是一个有效的 64 位double 类型的值。
若参数 noAssert
为 true 将不会验证 value
和 offset
偏移量参数。 这意味着 value
可能过大,或者 offset 可能会超出 buffer 的末尾从而造成value
被丢弃。 除非你对这个参数非常有把握,否则尽量不要使用。默认是 false
。
例如:
var buf = new Buffer(8); buf.writeDoubleBE(0xdeadbeefcafebabe, 0); console.log(buf); buf.writeDoubleLE(0xdeadbeefcafebabe, 0); console.log(buf); // <Buffer 43 eb d5 b7 dd f9 5f d7> // <Buffer d7 5f f9 dd b7 d5 eb 43>
value
offset
Number 类型, Optional
end
Number 类型, Optional
使用指定的 value
来填充这个 buffer。如果没有指定 offset
(默认是 0) 并且 end
(默认是 buffer.length
) ,将会填充整个buffer。
var b = new Buffer(50); b.fill("h");
Number 类型, 默认值: 50
设置当调用 buffer.inspect()
方法后,将会返回多少 bytes 。用户模块重写这个值可以。
注意这个属性是 require('buffer')
模块返回的。这个属性不是在全局变量 Buffer 中,也不在 buffer 的实例里。
返回一个不被池管理的 Buffer
。
大量独立分配的 Buffer 容易带来垃圾,为了避免这个情况,小于 4KB 的空间都是切割自一个较大的独立对象。这种策略既提高了性能也改善了内存使用率。V8 不需要跟踪和清理过多的 Persistent
对象。
当开发者需要将池中一小块数据保留一段时间,比较好的办法是用 SlowBuffer 创建一个不被池管理的 Buffer 实例,并将相应数据拷贝出来。
// need to keep around a few small chunks of memory var store = []; socket。on('readable', function() { var data = socket。read(); // allocate for retained data var sb = new SlowBuffer(10); // copy the data into the new allocation data。copy(sb, 0, 0, 10); store。push(sb); });
请谨慎使用,仅作为经常发现他们的应用中过度的内存保留时的最后手段。