10、Node.js Buffer(缓冲区)

在Node.js 中，Buffer 类是随 Node 内核一起发布的核心库

Buffer 库为 Node.js 带来了一种存储原始数据的方法，可以让 Node.js 处理二进制数据，每当需要在 Node.js 中处理I/O操作中移动的数据时，就有可能使用 Buffer 库

原始数据存储在 Buffer 类的实例中

一个Buffer 类似于一个整数数组，但它对应于 V8 堆内存之外的一块原始内存

Buffer 类设计的初衷

JavaScript 语言自身只有字符串数据类型，没有二进制数据类型。

但在处理像 TCP 流或文件流时，必须使用到二进制数据。因此在 Node.js中，定义了一个 Buffer 类，该类用来创建一个专门存放二进制数据的缓存区。

创建 Buffer 实例

Node.js 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("ddkk.com", "utf-8");

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

buf.write() 方法

Node.js Buffer 实例 buf.write() 方法将内容写入缓冲区 buf

语法

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

参数列表

返回值

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

范例

/*
 * filename: main.js
 * author: DDKK.COM 弟弟快看，程序员编程资料站(ddkk.com)
 * Copyright © 2015-2065 ddkk.com. All rights reserved.
*/
buf = new Buffer(256);
len = buf.write("ddkk.com");

console.log("写入字节数 : "+  len);

运行以上 Node.js 范例，输出结果如下

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

buf.toString() 方法

Node.js Buffer 对象 buf.toString() 方法将 buf 的内容转换成字符串

语法

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

参数列表

返回值

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

范例

/*
 * filename: main.js
 * author: DDKK.COM 弟弟快看，程序员编程资料站(ddkk.com)
 * Copyright © 2015-2065 ddkk.com. All rights reserved.
*/

var buf = new Buffer('ddkk.com');
var json = buf.toJSON(buf);

console.log(json);

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.js 范例，输出结果如下

$ node main.js
{ type: 'Buffer',
  data: [ 119, 119, 119, 46, 116, 119, 108, 101, 46, 99, 110 ] }
abcdefghijklmnopqrstuvwxyz
abcde
abcde
abcde

buf.toJSON() 方法

Node.js Buffer 实例 buf.toJSON() 方法将 buf 内容转换为 JSON 对象

语法

buf.toJSON()

返回值

返回JSON 对象

范例

/*
 * filename: main.js
 * author: DDKK.COM 弟弟快看，程序员编程资料站(ddkk.com)
 * Copyright © 2015-2065 ddkk.com. All rights reserved.
*/

var buf = new Buffer('ddkk.com');
var json = buf.toJSON(buf);

console.log(json);

运行以上 Node.js 范例，输出结果如下

node main.js
{ type: 'Buffer',
  data: [ 119, 119, 119, 46, 116, 119, 108, 101, 46, 99, 110 ] }

Buffer.concat() 方法

Node.js Buffer.concat() 方法用于缓冲区合并

语法

Buffer.concat(list[, totalLength])

参数列表

返回值

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

范例

/*
 * filename: main.js
 * author: DDKK.COM 弟弟快看，程序员编程资料站(ddkk.com)
 * Copyright © 2015-2065 ddkk.com. All rights reserved.
*/

var buffer1 = new Buffer('教程  ');
var buffer2 = new Buffer('ddkk.com');
var buffer3 = Buffer.concat([buffer1,buffer2]);
console.log("buffer3 内容: " + buffer3.toString());

运行以上 Node.js 范例，输出结果如下

$ node main.js 
buffer3 内容: 教程  ddkk.com

buf.compare() 方法

Node.js Buffer 模块 buf.compare() 方法用于缓冲区比较

版本

=0.12.2

语法

buf.compare(otherBuffer);

参数列表

返回值

返回一个数字，表示 buf 在 otherBuffer 之前，之后或相同:

• 1 : buf 在 otherBuffer 之后
• 0 : buf 和 otherBuffer 重叠
• -1 : buf 在 otherBuffer 之前

范例

/*
 * filename: main.js
 * author: DDKK.COM 弟弟快看，程序员编程资料站(ddkk.com)
 * Copyright © 2015-2065 ddkk.com. All rights reserved.
*/

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 + "之后");
}

运行以上 Node.js 范例，输出结果如下

$ node main.js 
ABC在ABCD之前

buf.copy() 方法

Node.js Buffer 模块 buf.copy() 方法用于拷贝缓冲区

语法

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

参数列表

返回值

无

范例

/*
 * filename: main.js
 * author: DDKK.COM 弟弟快看，程序员编程资料站(ddkk.com)
 * Copyright © 2015-2065 ddkk.com. All rights reserved.
*/

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

运行以上 Node.js 范例，输出结果如下

$ node main.js
buffer2 content: souyunku

buf.slice() 方法

Node.js Buffer 实例 buf.slice() 方法用于缓冲区裁剪

语法

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

参数

返回值

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

实例

/*
 * filename: main.js
 * author: DDKK.COM 弟弟快看，程序员编程资料站(ddkk.com)
 * Copyright © 2015-2065 ddkk.com. All rights reserved.
*/
var buffer1 = new Buffer('souyunku');
// 剪切缓冲区
var buffer2 = buffer1.slice(0,2);
console.log("buffer2 content: " + buffer2.toString());

运行以上 Node.js 范例，输出结果如下

$ node main.js
buffer2 content: tw

buf.length 属性

Node.js Buffer buf.length 属性返回 buf 对象所占据的内存长度

语法

buf.length;

返回值

返回Buffer 对象 buf 所占据的内存长度

范例

/*
 * filename: main.js
 * author: DDKK.COM 弟弟快看，程序员编程资料站(ddkk.com)
 * Copyright © 2015-2065 ddkk.com. All rights reserved.
*/

var buffer = new Buffer('ddkk.com');
//  缓冲区长度
console.log("buffer length: " + buffer.length);

运行以上 Node.js 范例，输出结果如下

$ node main.js                            
buffer length: 11

Buffer 对象方法

下表列出了 Node.js Buffer 模块的方法

buf 是 Buff 的一个实例