Node.js Buffer(缓冲区)

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

但在处理像tcp流或文件流时，必须使用到二进制数据。

因此在 node.js中，定义了一个 buffer 类，该类用来创建一个专门存放二进制数据的缓存区。

 

在v6.0之前创建buffer对象直接使用new buffer()构造函数来创建对象实例，但是buffer对内存的权限操作相比很大，可以直接捕获一些敏感信息。

所以在v6.0以后，官方文档里面建议使用 buffer.from() 接口去创建buffer对象。

 

buffer 实例一般用于表示编码字符的序列，比如 utf-8 、 ucs2 、 base64 、或十六进制编码的数据。

通过使用显式的字符编码，就可以在 buffer 实例与普通的 javascript 字符串之间进行相互转换。

const buf=buffer.from("cyy","ascii");

//字符编码转换
console.log(buf.tostring("ascii"));
console.log(buf.tostring("utf8"));
console.log(buf.tostring("utf16le"));
console.log(buf.tostring("base64"));
console.log(buf.tostring("latin1"));
console.log(buf.tostring("hex"));

 

 

 

node.js 目前支持的字符编码包括：

• ascii - 仅支持 7 位 ascii 数据。如果设置去掉高位的话，这种编码是非常快的。

• utf8 - 多字节编码的 unicode 字符。许多网页和其他文档格式都使用 utf-8 。

• utf16le - 2 或 4 个字节，小字节序编码的 unicode 字符。支持代理对（u+10000 至 u+10ffff）。

• ucs2 - utf16le 的别名。

• base64 - base64 编码。

• latin1 - 一种把 buffer 编码成一字节编码的字符串的方式。

• binary - latin1 的别名。

• hex - 将每个字节编码为两个十六进制字符。

 

buffer 提供了以下 api 来创建 buffer 类：

• buffer.alloc(size[, fill[, encoding]])： 返回一个指定大小的 buffer 实例，如果没有设置 fill，则默认填满 0
• buffer.allocunsafe(size)： 返回一个指定大小的 buffer 实例，但是它不会被初始化，所以它可能包含敏感的数据
• buffer.allocunsafeslow(size)
• buffer.from(array)： 返回一个被 array 的值初始化的新的 buffer 实例（传入的 array 的元素只能是数字，不然就会自动被 0 覆盖）
• buffer.from(arraybuffer[, byteoffset[, length]])： 返回一个新建的与给定的 arraybuffer 共享同一内存的 buffer。
• buffer.from(buffer)： 复制传入的 buffer 实例的数据，并返回一个新的 buffer 实例
• buffer.from(string[, encoding])： 返回一个被 string 的值初始化的新的 buffer 实例

 

// 创建一个长度为 5、且用 0 填充的 buffer。
const buf1=buffer.alloc(5);
// 创建一个长度为 5、且用 0x1 填充的 buffer。
const buf2=buffer.alloc(5,1);
console.log(buf1);//<buffer 00 00 00 00 00>
console.log(buf2);//<buffer 01 01 01 01 01>

// 创建一个长度为 10、且未初始化的 buffer。
// 这个方法比调用 buffer.alloc() 更快，
// 但返回的 buffer 实例可能包含旧数据，
// 因此需要使用 fill() 或 write() 重写。
const buf3 = buffer.allocunsafe(10);
console.log(buf3);//<buffer 15 08 00 00 08 03 00 00 10 d0>

// 创建一个包含 [0x1, 0x2, 0x3] 的 buffer。
const buf4=buffer.from([1,2,3]);
console.log(buf4);//<buffer 01 02 03>

// 创建一个包含 utf-8 字节 的 buffer。
const buf5=buffer.from("cyy");
console.log(buf5);//<buffer 63 79 79>

// 创建一个包含 latin-1 字节 的 buffer。
const buf6=buffer.from("cyy","latin1");
console.log(buf6);//<buffer 63 79 79>

 

写入 node 缓冲区

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

参数描述如下：

• string - 写入缓冲区的字符串。

• offset - 缓冲区开始写入的索引值，默认为 0 。

• length - 写入的字节数，默认为 buffer.length

• encoding - 使用的编码。默认为 'utf8' 。

根据 encoding 的字符编码写入 string 到 buf 中的 offset 位置。 length 参数是写入的字节数。 如果 buf 没有足够的空间保存整个字符串，则只会写入 string 的一部分。 只部分解码的字符不会被写入。

返回值

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

 

var buf=buffer.alloc(256);//长度256，用0填充
var len=buf.write("i am cyy~");//写入缓存，返回存入的长度
console.log(len);

 

 

 

读取 node 缓冲区数据

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

参数描述如下：

• encoding - 使用的编码。默认为 'utf8' 。

• start - 指定开始读取的索引位置，默认为 0。

• end - 结束位置，默认为缓冲区的末尾。

返回值

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

var buf=buffer.alloc(26);

for(var i=0;i<26;i++){
    buf[i]=i+97;//存入26个字母
}

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));//abcde

 

将 node buffer 转换为 json 对象

buf.tojson()

当字符串化一个 buffer 实例时，json.stringify() 会隐式地调用该 tojson()。

var buf=buffer.from([0x1,0x2,0x3,0x4,0x5]);//十进制0-5
var json=json.stringify(buf);//字符串转json
console.log(json);//{"type":"buffer","data":[1,2,3,4,5]}


//缓冲区的json转字符串
var data=json.parse(json,(key,value)=>{
    return value&&value.type=="buffer"?buffer.from(value.data):value;
});
console.log(data);//<buffer 01 02 03 04 05>

 

 

 

node 缓冲区合并

buffer.concat(list[, totallength])

• list - 用于合并的 buffer 对象数组列表。

• totallength - 指定合并后buffer对象的总长度。

var buf1=buffer.from("hello~");
var buf2=buffer.from("i am cyy~");
var buf3=buffer.concat([buf1,buf2]);
console.log(buf3.tostring());

 

 

 

node buffer 比较的函数语法如下所示, 该方法在 node.js v0.12.2 版本引入：

buf.compare(otherbuffer);

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

var buf1=buffer.from("abcd");
var buf2=buffer.from("abcdefg");
var res=buf1.compare(buf2);

if(res<0){
    console.log("buf1小于buf2");
}else if(buf1==buf2){
    console.log("buf1等于buf2");
}else{
    console.log("buf1大于buf2");
}

 

 

 这个方法是按位比较的。buffer1.compare(buffer2)，这个方法是按位比较的。buffer1 的第一位比较 buffer2 的第一位，相等的话比较第二位以此类推直到得出结果。

var buffer1 = buffer.from('abcdef99');
var buffer2 = buffer.from('abcdef98765');
console.log(buffer1.compare(buffer2));//1

数字和字母比较的结果就是 -1

node 缓冲区拷贝

buf.copy(targetbuffer[, targetstart[, sourcestart[, sourceend]]])

参数描述如下：

• targetbuffer - 要拷贝的 buffer 对象。

• targetstart - 数字, 可选, 默认: 0

• sourcestart - 数字, 可选, 默认: 0

• sourceend - 数字, 可选, 默认: buffer.length

 

var buf1=buffer.from("hello");
var buf2=buffer.from("cyy呀");
buf2.copy(buf1,3);

console.log(buf1.tostring());

 

 

 

node 缓冲区裁剪

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

参数描述如下：

• start - 数字, 可选, 默认: 0

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

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

var buf1=buffer.from("hello,cyy");
var buf2=buf1.slice(0,6);

console.log(buf2.tostring());

 

 

 

node 缓冲区长度计算

buf.length;

var buf1=buffer.from("hello,cyy");
console.log(buf1.length);

 

 

 

 

 它和旧缓冲区指向同一块内存，操作的是与原始 buffer 同一块内存区域。

// 裁剪
var oldbuf=buffer.from('cyycyy');
var newbuf=oldbuf.slice(0,3);
console.log("old: "+oldbuf.tostring());
console.log("new: "+newbuf.tostring());
newbuf.write("new!"); // write buffer slice

// 裁剪前与原始字符串的改变
console.log("old: "+oldbuf.tostring());
console.log("new: "+newbuf.tostring());