node.js的Buffer(缓冲区)之一
不喜欢看文字的朋友可以直接跳到Buffer类的创建哦。
简介
JavaScript语言自身只有字符串数据类型,没有二进制数据类型。但在处理像TCP流或文件流时,必须使用到二进制数据。因此在 Node.js中,定义了一个 Buffer 类,该类用来创建一个专门存放二进制数据的缓存区。
Buffer 库为 Node.js 带来了一种存储原始数据的方法,可以让 Node.js 处理二进制数据,每当需要在 Node.js 中处理I/O操作中移动的数据时,就有可能使用 Buffer 库。原始数据存储在 Buffer 类的实例中。一个 Buffer 类似于一个整数数组,但它对应于 V8 堆内存之外的一块原始内存。
Buffer与字符编码
Buffer 实例一般用于表示编码字符的序列,比如 UTF-8 、 UCS2 、 Base64 、或十六进制编码的数据。 通过使用显式的字符编码,就可以在 Buffer 实例与普通的 JavaScript 字符串之间进行相互转换。
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 实例(参数:size是大小,fill是用什么填充(默认为0),encoding是编码格式,可以参考上面Buffer与字符编码这个标题的内容)
- Buffer.allocUnsafe(size): 返回一个指定大小的 Buffer 实例,但是它不会被初始化,所以它可能包含敏感的数据
- Buffer.allocUnsafeSlow(size): 返回一个指定大小的 Buffer 实例, 如果 size 大于 buffer.constants.MAX_LENGTH 或小于 0,则抛出 ERR_INVALID_OPT_VALUE。 如果 size 为 0,则创建一个长度为零的 Buffer。以这种方式创建的 Buffer 实例的底层内存是未初始化的。 Buffer 的内容是未知的,可能包含敏感数据。
- 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);
console.log(buf1);
// 创建一个长度为 10、且用 0x1 填充的 Buffer。
const buf2 = Buffer.alloc(10, 11);
console.log(buf2);
// 创建一个长度为 10、且未初始化的 Buffer。
// 这个方法比调用 Buffer.alloc() 更快,
// 但返回的 Buffer 实例可能包含旧数据,
// 因此需要使用 fill() 或 write() 重写。
const buf3 = Buffer.allocUnsafe(10);
console.log(buf3);
//使用fill重写
buf3.fill(0);
console.log('重写后的buf3:',buf3);
// 创建一个包含 [0x1, 0x2, 0x3] 的 Buffer。
const buf4 = Buffer.from([1, 2, 3]);
console.log(buf4);
// 创建一个包含 UTF-8 字节 [0x74, 0xc3, 0xa9, 0x73, 0x74] 的 Buffer。
const buf5 = Buffer.from('tést');
console.log(buf5);
// 创建一个包含 Latin-1 字节 [0x74, 0xe9, 0x73, 0x74] 的 Buffer。
const buf6 = Buffer.from('tést', 'latin1');
console.log(buf6);
输出结果如下:
看一下注释跟结果显示应该大概可以看懂吧,然后接着看下面,内容会越来越精彩!
缓冲区的写入和读取
缓冲区的写入
写入的语法如下:
buf.write(string[, offset[, length]][, encoding])
参数描述:
- string - 写入缓冲区的字符串。
- offset - 缓冲区开始写入的索引值,默认为 0 。
- length - 写入的字节数,默认为 buffer.length(就是你开辟的Buffer实例的大小)
- encoding - 使用的编码。默认为 ‘utf8’ 。
返回值:实际写入的大小
举个例子,比如我们现在是
let buf = Buffer.alloc(10);
let length = buf.write('hello',2,3,'utf8');
console.log(buf);
console.log(length);
解释起来就是:根据 encoding 的字符编码(utf8)把 string(‘hello’) 从 buf 中的 offset(2,初始位是0) 位置开始填充 length(3,也就是填充了这个Buffer的2、3、4) 位,如果 buf 没有足够的空间保存整个字符串,则只会写入 string 的一部分。
显示结果如下:
如果是
let buf = Buffer.alloc(10);
let length = buf.write('hellowrold!!!',0,10,'utf8');
console.log(buf);
console.log(length);
那么结果就是:
缓冲区的读取
读取的语法如下:
buf.toString([encoding[, start[, end]]])
参数描述:
- encoding - 使用的编码。默认为 ‘utf8’ 。
- start - 指定开始读取的索引位置,默认为 0。
- end - 结束位置,默认为缓冲区的末尾。
返回值:解码缓冲区数据并使用指定的编码返回字符串。
此处废话不多说,代码来一波:
let buf = Buffer.alloc(15);
let length = buf.write('hello,world!','utf8');
console.log(buf.toString());
console.log(buf.toString('ascii'));
console.log(buf.toString('ascii',0,5));
console.log(buf.toString('utf8',0,5));
console.log(buf.toString('hex'));
显示如下:(事实告诉我们,不是什么码都可以随便解的)
获取Buffer(缓冲区)的长度
只需要使用他的属性:length,使用如下:
var buffer = Buffer.from('123456');
// 缓冲区长度
console.log("buffer length: " + buffer.length);
显示如下: