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类可以通过多种方式创建。

法一
创建长度为10字节的Buffer类实例：

var  buf = new Buffer(10);

法二
通过给定的数组创建Buffer实例：

var buf = new Buffer([10, 20, 30, 40, 50]);

法三
通过给定的数组创建Buffer实例：

var buf = new Buffer("wwww", "utf-8");

utf-8是默认的编码方式，此外它同样支持一下编码：“ascii”，“uft8”，“utf16le”，“ucs2”，“base64”，“hex”。

写入缓冲区

语法

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

参数描述如下：

string-写入缓冲区的字符串
offset-缓冲区开始写入的索引值，默认为0
length-写入的字节数，默认为buffer.length
encoding-使用的编码。默认为'utf8'

返回值

返回实际写入的大小。如果buffer空间不足，则只会写入部分字符串。

实例

创建一个main.js文件

var buf = new Buffer(256);
var len = buf.write("hello node.js");
console.log("写入字节数："+ len);

代码执行结果如下：

$ node main.js
写入字节数 : 13

从缓冲区读取数据

语法

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

参数

参数描述如下

encoding - 使用编码方式。默认为‘utf8’
start - 指定开始读取的索引位置，默认为0
end - 结束位置，默认是缓冲区的末尾。

返回值

解码缓冲区数据并使用指定的编码返回字符串。

实例

var buf = new Buffer(26);
for(var i = 0; i < 26; i++) {
  buf[i] = i + 97;
}
console.log(buf.toString('ascii'));
console.log(buf.toString('ascii', 0, 5));
console.log(buf.toString('utf8', 0, 5));
// 默认使用utf8
console.log(buf.toString(undefined, 0, 5));

执行结果如下：

$ node main.js
abcdefghijklmnopqrstuvwxyz
abcde
abcde
abcde

将Buffer转换成JSON对象

语法

buf.toJSON()

返回值

返回一个JSON对象

实例

var buf = new Buffer('hello');
var json = buf.toJSON(buf);
console.log(json);

以上代码输出结果为：

$ node main.js
{ type: 'Buffer', data: [ 104, 101, 108, 108, 111 ] }

缓冲区合并

语法

Buffer.concat(list[, totalLength])

参数

list - 用于合并的Buffer对象数组列表
totalLength - 指定合并后Buffer对象的总长度

返回值

返回一个多个成员合并的新Buffer对象。

实例

var buffer1 = new Buffer('百度 ');
var buffer2 = new Buffer('www.baidu.com');
var buffer3 = Buffer.concat([buffer1,buffer2]);
console.log("buffer3 内容: " + buffer3.toString());

运行结果：

$ node main.js
buffer3 内容: 百度 www.baidu.com

缓冲区比较

语法

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之前

拷贝缓冲区

语法

buf.copy(targetBuffer[, targetStart[, sourceStart[, sourceEnd]]])

参数

targetBuffer - 要拷贝的Buffer对象
targetStart - 数字，可选，默认：0
sourceStart - 数字，可选，默认：0
sourceEnd - 数字，可选，默认：buffer.length

返回值

无返回值

实例

var buffer1 = new Buffer('ABC');
// 拷贝一个缓冲区
var buffer2 = new Buffer(3);
buffer1.copy(buffer2);
console.log("buffer2 content: " + buffer2.toString());

执行结果为：

buffer2 content: ABC

缓冲区剪裁

语法

buf.slice([start[, end]])

参数

start - 数字, 可选, 默认: 0
end - 数字, 可选, 默认: buffer.length

返回值

返回一个新的缓冲区，他和旧的缓冲区指向同一块内存，但是从索引start到end的位置剪切。

实例

var buffer1 = new Buffer('baidu');
// 剪切缓冲区
var buffer2 = buffer1.slice(0,2);
console.log("buffer2 content: " + buffer2.toString());