教程 > nodejs 教程 > 阅读:100

nodejs buffer(缓冲区)——迹忆客-ag捕鱼王app官网

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

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

在 nodejs 中,buffer 类是随 node 内核一起发布的核心库。buffer 库为 nodejs 带来了一种存储原始数据的方法,可以让 node.js 处理二进制数据,每当需要在 nodejs 中处理i/o操作中移动的数据时,就有可能使用 buffer 库。原始数据存储在 buffer 类的实例中。一个 buffer 类似于一个整数数组,但它对应于 v8 堆内存之外的一块原始内存。

在v6.0之前创建buffer对象直接使用new buffer()构造函数来创建对象实例,但是buffer对内存的权限操作相比很大,可以直接捕获一些敏感信息,所以在v6.0以后,官方文档里面建议使用 buffer.from() 接口去创建buffer对象。


buffer 与字符编码

buffer 实例一般用于表示编码字符的序列,比如 utf-8 、 ucs2 、 base64 、或十六进制编码的数据。 通过使用显式的字符编码,就可以在 buffer 实例与普通的 javascript 字符串之间进行相互转换。

const buf = buffer.from('runoob', 'ascii');
// 输出 72756e6f6f62
console.log(buf.tostring('hex'));
// 输出 cnvub29i
console.log(buf.tostring('base64'));

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 类

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 实例
// 创建一个长度为 10、且用 0 填充的 buffer。
const buf1 = buffer.alloc(10);
// 创建一个长度为 10、且用 0x1 填充的 buffer。 
const buf2 = buffer.alloc(10, 1);
// 创建一个长度为 10、且未初始化的 buffer。
// 这个方法比调用 buffer.alloc() 更快,
// 但返回的 buffer 实例可能包含旧数据,
// 因此需要使用 fill() 或 write() 重写。
const buf3 = buffer.allocunsafe(10);
// 创建一个包含 [0x1, 0x2, 0x3] 的 buffer。
const buf4 = buffer.from([1, 2, 3]);
// 创建一个包含 utf-8 字节 [0x74, 0xc3, 0xa9, 0x73, 0x74] 的 buffer。
const buf5 = buffer.from('tést');
// 创建一个包含 latin-1 字节 [0x74, 0xe9, 0x73, 0x74] 的 buffer。
const buf6 = buffer.from('tést', 'latin1');

写入缓冲区

语法

写入 node 缓冲区的语法如下所示:

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

参数

参数描述如下:

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

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

返回值

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

示例

buf = buffer.alloc(256);
len = buf.write("www.jiyik.com");
console.log("写入字节数 : "   len);

执行以上代码,输出结果为:

$node main.js

写入字节数 : 14


从缓冲区读取数据

语法

读取 node 缓冲区数据的语法如下所示:

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

参数

参数描述如下:

  • encoding - 使用的编码。默认为 'utf8' 。
  • start - 指定开始读取的索引位置,默认为 0。
  • end - 结束位置,默认为缓冲区的末尾。

返回值

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

示例

buf = buffer.alloc(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));   //使用 'ascii' 编码, 并输出: abcde
console.log( buf.tostring('utf8',0,5));    // 使用 'utf8' 编码, 并输出: abcde
console.log( buf.tostring(undefined,0,5)); // 使用默认的 'utf8' 编码, 并输出: abcde

执行以上代码,输出结果为:

$ node main.js
abcdefghijklmnopqrstuvwxyz
abcde
abcde
abcde

将 buffer 转换为 json 对象

语法

将 node buffer 转换为 json 对象的函数语法格式如下:

buf.tojson()

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

返回值

返回 json 对象。

示例

const buf = buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]);
const json = json.stringify(buf);
// 输出: {"type":"buffer","data":[1,2,3,4,5]}
console.log(json);
const copy = json.parse(json, (key, value) => {
  return value && value.type === 'buffer' ?
    buffer.from(value.data) :
    value;
});
// 输出: 
console.log(copy);

执行以上代码,输出结果为:

{"type":"buffer","data":[1,2,3,4,5]}


缓冲区合并

语法

node 缓冲区合并的语法如下所示:

buffer.concat(list[, totallength])

参数

参数描述如下:

  • list - 用于合并的 buffer 对象数组列表。
  • totallength - 指定合并后buffer对象的总长度。

返回值

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

示例

var buffer1 = buffer.from(('迹忆客'));
var buffer2 = buffer.from(('www.jiyik.com'));
var buffer3 = buffer.concat([buffer1,buffer2]);
console.log("buffer3 内容: "   buffer3.tostring());

执行以上代码,输出结果为:

buffer3 内容: 迹忆客www.jiyik.com

缓冲区比较

语法

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

buf.compare(otherbuffer);

参数

参数描述如下:

  • otherbuffer - 与 buf 对象比较的另外一个 buffer 对象。

返回值

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

示例

var buffer1 = buffer.from('abc');
var buffer2 = buffer.from('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

返回值

没有返回值。

示例

var buf1 = buffer.from('abcdefghijkl');
var buf2 = buffer.from('runoob');
//将 buf2 插入到 buf1 指定位置上
buf2.copy(buf1, 2);
console.log(buf1.tostring());

执行以上代码,输出结果为:

abrunoobijkl

缓冲区裁剪

node 缓冲区裁剪语法如下所示:

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

参数

参数描述如下:

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

返回值

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

示例

var buffer1 = buffer.from('runoob');
// 剪切缓冲区
var buffer2 = buffer1.slice(0,2);
console.log("buffer2 content: "   buffer2.tostring());

执行以上代码,输出结果为:

buffer2 content: ru

缓冲区长度

语法

node 缓冲区长度计算语法如下所示:

buf.length;

返回值

返回 buffer 对象所占据的内存长度。

示例

var buffer = buffer.from('www.jiyik.com');
//  缓冲区长度
console.log("buffer length: "   buffer.length);

执行以上代码,输出结果为:

buffer length: 14

方法参考手册

以下列出了 node.js buffer 模块常用的方法(注意有些方法在旧版本是没有的):

序号 方法 描述
1 new buffer(size) 分配一个新的 size 大小单位为8位字节的 buffer。 注意, size 必须小于 kmaxlength,否则,将会抛出异常 rangeerror。废弃的: 使用 buffer.alloc() 代替(或 buffer.allocunsafe())
2 new buffer(buffer) 拷贝参数 buffer 的数据到 buffer 实例。废弃的: 使用 buffer.from(buffer) 代替
3 new buffer(str[, encoding]) 分配一个新的 buffer ,其中包含着传入的 str 字符串。 encoding 编码方式默认为 'utf8'。 废弃的: 使用 buffer.from(string[, encoding]) 代替
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 位无符号整数,小端对齐
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。

查看笔记

扫码一下
查看教程更方便
网站地图