純粹的JavaScript
是Unicode友好的,但是不能很好地處理二進(jìn)制數(shù)據(jù)。當(dāng)處理TCP流或者文件流時,操作八進(jìn)制流是必要的。io.js
提供了多種策略來操作,創(chuàng)建和使用八進(jìn)制流。
原始的數(shù)據(jù)被存儲在Buffer
類的實例中,一個Buffer
類似于一個整數(shù)數(shù)組但是使用了V8堆之外的內(nèi)存分配。一個Buffer
不能被改變大小。
Buffer
類是全局的,所以它是少數(shù)的不用require('buffer')
就能使用的對象之一。
Buffer
和JavaScript
字符串對象之間的轉(zhuǎn)換需要指定一個明確地編碼方法。以下是一些不同的字符串編碼。
'ascii' - 僅供7位的ASCII數(shù)據(jù)使用,這個編碼方法非常的快速,而且會剝離過高的位(如果有設(shè)置)。
'utf8' - 多字節(jié)編碼的字符。許多web頁面和一些其他文檔都使用UTF-8編碼。
'utf16le' - 2或4個字節(jié),little endian
編碼字符。支持(U+10000 到 U+10FFFF)的代理對。
'ucs2' - 'utf16le'的別名。
'base64' - Base64 字符串編碼。
'binary' - 一種通過使用每個字符的前八位來將二進(jìn)制數(shù)據(jù)解碼為字符串的方式。這個編碼方法已經(jīng)不被推薦使用,在處理Buffer
對象時應(yīng)避免使用它,這個編碼將會在io.js
的未來版本中移除。
'hex' - 把每個字節(jié)編碼成2個十六進(jìn)制字符。
從一個Buffer
創(chuàng)建一個類型數(shù)組(typed array)遵循以下的說明:
1,Buffer
的內(nèi)存是被復(fù)制的,不是共享的。
2,Buffer
的內(nèi)存被解釋當(dāng)做一個數(shù)組,而不是一個字節(jié)數(shù)組(byte array)。換言之,new Uint32Array(new Buffer([1,2,3,4]))
創(chuàng)建了一個4個元素([1,2,3,4])的Uint32Array
,不是一個只有一個元素([0x1020304] 或 [0x4030201])的Uint32Array
。
注意: Node.js v0.8 只是簡單得在array.buffer
中保留了buffer
的引用,而不是復(fù)制一份。
Buffer類是一個全局類用于直接處理二進(jìn)制數(shù)據(jù)。它的實例可以被多種途徑構(gòu)建。
分配一個大小為指定size
的八位字節(jié)的新buffer
。注意,size
不能超過kMaxLength,否則一個RangeError
將會被拋出。
使用一個八進(jìn)制數(shù)組分配一個新的buffer
。
將傳遞的buffer
復(fù)制進(jìn)一個新的Buffer實例。
根據(jù)給定的str
創(chuàng)建一個新的buffer
,編碼默認(rèn)是UTF-8。
true
若此編碼是合法的,否則返回false
。測試obj
是否為一個buffer
。
給出string
的實際字節(jié)長度。編碼默認(rèn)為UTF-8。這與String.prototype.length
不同,因為String.prototype.length
只返回字符串中字符的數(shù)量。
例子:
str = '\u00bd + \u00bc = \u00be';
console.log(str + ": " + str.length + " characters, " +
Buffer.byteLength(str, 'utf8') + " bytes");
// ? + ? = ?: 9 characters, 12 bytes
若list
為空,或totalLength
為0,那么將返回一個長度為0的buffer。若list
只有一個元素,那么這個元素將被返回。若list
有超過一個元素,那么將創(chuàng)建一個新的Buffer實例。如果totalLength
沒有被提供,那么將會從list
中計算讀取。但是,這增加了函數(shù)的一個額外的循環(huán),所以如果直接長度那么性能會更好。
var arr = [Buffer('1234'), Buffer('0123')];
arr.sort(Buffer.compare);
buf = new Buffer(1234);
console.log(buf.length);
buf.write("some string", 0, "ascii");
console.log(buf.length);
// 1234
// 1234
雖然buffer
的length
屬性并不是不可變的,改變length
屬性的值可能會使之變成undefined
或引起一些不一致的行為。希望去改變buffer
的length
的應(yīng)用應(yīng)當(dāng)把它視作一個只讀的值,并且使用buf.slice
來創(chuàng)建一個新的buffer
。
buf = new Buffer(10);
buf.write("abcdefghj", 0, "ascii");
console.log(buf.length); // 10
buf = buf.slice(0,5);
console.log(buf.length); // 5
buffer.length - offset
從指定的偏移位置(offset)使用給定的編碼向buffer中寫入字符串,偏移位置默認(rèn)為0,編碼默認(rèn)為UTF8。長度為將要寫入的字符串的字節(jié)大小。返回被寫入的八進(jìn)制流的大小。如果buffer沒有足夠的空間寫入整個字符串,那么它將只會寫入一部分。length
參數(shù)默認(rèn)為buffer.length - offset
,這個方法將不會只寫入字符的一部分。
buf = new Buffer(256);
len = buf.write('\u00bd + \u00bc = \u00be', 0);
console.log(len + " bytes: " + buf.toString('utf8', 0, len));
0 <= offset <= buf.length
0 < byteLength <= 6
false
根據(jù)指定的偏移位置(offset)和byteLength
將value
寫入buffer。最高支持48位的精確度。例子:
var b = new Buffer(6);
b.writeUIntBE(0x1234567890ab, 0, 6);
// <Buffer 12 34 56 78 90 ab>
將noAssert
設(shè)置為true將會跳過value
和offset
的檢驗,默認(rèn)為false
。
0 <= offset <= buf.length
0 < byteLength <= 6
false
一個普遍的用來作數(shù)值讀取的方法,最高支持48位的精確度。例子:
var b = new Buffer(6);
b.writeUint16LE(0x90ab, 0);
b.writeUInt32LE(0x12345678, 2);
b.readUIntLE(0, 6).toString(16); // Specify 6 bytes (48 bits)
// output: '1234567890ab'
將noAssert
設(shè)置為true將會跳過value
和offset
的檢驗,這意味著offset
將可能超過buffer的結(jié)束位置,默認(rèn)為false
。
buffer.length
從編碼的buffer數(shù)據(jù)中使用指定的編碼解碼并返回結(jié)果字符串。如果encoding
為undefined
或null
,那么encoding
將默認(rèn)為UTF8。start
和end
參數(shù)默認(rèn)為0
和buffer.length
。
buf = new Buffer(26);
for (var i = 0 ; i < 26 ; i++) {
buf[i] = i + 97; // 97 is ASCII a
}
buf.toString('ascii'); // outputs: abcdefghijklmnopqrstuvwxyz
buf.toString('ascii',0,5); // outputs: abcde
buf.toString('utf8',0,5); // outputs: abcde
buf.toString(undefined,0,5); // encoding defaults to 'utf8', outputs abcde
返回一個Buffer實例的JSON形式。JSON.stringify
被隱式得調(diào)用當(dāng)轉(zhuǎn)換Buffer實例時。
例子:
var buf = new Buffer('test');
var json = JSON.stringify(buf);
console.log(json);
// '{"type":"Buffer","data":[116,101,115,116]}'
var copy = JSON.parse(json, function(key, value) {
return value && value.type === 'Buffer'
? new Buffer(value.data)
: value;
});
console.log(copy);
// <Buffer 74 65 73 74>
獲取或設(shè)置指定位置的八位字節(jié)。這個值是指單個字節(jié),所有合法范圍在0x00
到0xFF
或 0
到 255
。
例子:復(fù)制一個ASCII字符串到一個buffer,一次一個字節(jié):
str = "io.js";
buf = new Buffer(str.length);
for (var i = 0; i < str.length ; i++) {
buf[i] = str.charCodeAt(i);
}
console.log(buf);
// io.js
返回一個布爾值表示是否buf
與otherBuffer
具有相同的字節(jié)。
返回一個數(shù)字表示在排序上buf
在otherBuffer
之前,之后或相同。
buffer.length
從buf
中的指定范圍復(fù)制數(shù)據(jù)到targetBuffer
中的指定范圍,它們是可以重疊的。
例子:創(chuàng)建兩個Buffer,然后復(fù)制buf1的第16字節(jié)到19字節(jié)到buf2,buf2的偏移位置從第8字節(jié)開始:
buf1 = new Buffer(26);
buf2 = new Buffer(26);
for (var i = 0 ; i < 26 ; i++) {
buf1[i] = i + 97; // 97 is ASCII a
buf2[i] = 33; // ASCII !
}
buf1.copy(buf2, 8, 16, 20);
console.log(buf2.toString('ascii', 0, 25));
// !!!!!!!!qrst!!!!!!!!!!!!!
例子: 創(chuàng)建一個單獨的Buffer,然后復(fù)制數(shù)據(jù)到自身的一個重疊的范圍。
buf = new Buffer(26);
for (var i = 0 ; i < 26 ; i++) {
buf[i] = i + 97; // 97 is ASCII a
}
buf.copy(buf, 0, 4, 10);
console.log(buf.toString());
// efghijghijklmnopqrstuvwxyz
buffer.length
start
和end
參數(shù)所偏移和裁剪。修改這個新的buffer的切片,也會改變內(nèi)存中原來的buffer。
例子: 創(chuàng)建一個ASCII字母的Buffer,然后對其進(jìn)行slice
,然后修改源Buffer上的一個字節(jié):
var buf1 = new Buffer(26);
for (var i = 0 ; i < 26 ; i++) {
buf1[i] = i + 97; // 97 is ASCII a
}
var buf2 = buf1.slice(0, 3);
console.log(buf2.toString('ascii', 0, buf2.length));
buf1[0] = 33;
console.log(buf2.toString('ascii', 0, buf2.length));
// abc
// !bc
行為和Array.indexOf()相似。接受一個字符串,Buffer或數(shù)字。字符串被解釋為UTF8編碼,Buffer將使用整個buffer,所以如果要比較部分的Buffer請使用Buffer.slice()
,數(shù)字的范圍需在0到255之間。
false
根據(jù)制定偏移量從buffer中讀取一個無符號8位整數(shù)。
將noAssert
設(shè)置為true將會跳過value
和offset
的檢驗,這意味著offset
將可能超過buffer的結(jié)束位置,默認(rèn)為false
。
例子:
var buf = new Buffer(4);
buf[0] = 0x3;
buf[1] = 0x4;
buf[2] = 0x23;
buf[3] = 0x42;
for (ii = 0; ii < buf.length; ii++) {
console.log(buf.readUInt8(ii));
}
// 0x3
// 0x4
// 0x23
// 0x42
false
根據(jù)制定偏移量從buffer中根據(jù)特定的endian
字節(jié)序讀取一個無符號16位整數(shù)。
將noAssert
設(shè)置為true將會跳過value
和offset
的檢驗,這意味著offset
將可能超過buffer的結(jié)束位置,默認(rèn)為false
。
例子:
var buf = new Buffer(4);
buf[0] = 0x3;
buf[1] = 0x4;
buf[2] = 0x23;
buf[3] = 0x42;
console.log(buf.readUInt16BE(0));
console.log(buf.readUInt16LE(0));
console.log(buf.readUInt16BE(1));
console.log(buf.readUInt16LE(1));
console.log(buf.readUInt16BE(2));
console.log(buf.readUInt16LE(2));
// 0x0304
// 0x0403
// 0x0423
// 0x2304
// 0x2342
// 0x4223
false
根據(jù)制定偏移量從buffer中根據(jù)特定的endian
字節(jié)序讀取一個無符號32位整數(shù)。
將noAssert
設(shè)置為true將會跳過value
和offset
的檢驗,這意味著offset
將可能超過buffer的結(jié)束位置,默認(rèn)為false
。
例子:
var buf = new Buffer(4);
buf[0] = 0x3;
buf[1] = 0x4;
buf[2] = 0x23;
buf[3] = 0x42;
console.log(buf.readUInt32BE(0));
console.log(buf.readUInt32LE(0));
// 0x03042342
// 0x42230403
false
根據(jù)制定偏移量從buffer中讀取一個有符號8位整數(shù)。
將noAssert
設(shè)置為true將會跳過value
和offset
的檢驗,這意味著offset
將可能超過buffer的結(jié)束位置,默認(rèn)為false
。
運作和buffer.readUInt8
相同,除非buffer內(nèi)容中有包含了作為2的補(bǔ)碼的有符號值。
false
根據(jù)制定偏移量從buffer中根據(jù)特定的endian
字節(jié)序讀取一個有符號16位整數(shù)。
將noAssert
設(shè)置為true將會跳過value
和offset
的檢驗,這意味著offset
將可能超過buffer的結(jié)束位置,默認(rèn)為false
。
運作和buffer.readUInt16
相同,除非buffer內(nèi)容中有包含了作為2的補(bǔ)碼的有符號值。
false
根據(jù)制定偏移量從buffer中根據(jù)特定的endian
字節(jié)序讀取一個有符號32位整數(shù)。
將noAssert
設(shè)置為true將會跳過value
和offset
的檢驗,這意味著offset
將可能超過buffer的結(jié)束位置,默認(rèn)為false
。
運作和buffer.readUInt32
相同,除非buffer內(nèi)容中有包含了作為2的補(bǔ)碼的有符號值。
false
根據(jù)制定偏移量從buffer中根據(jù)特定的endian
字節(jié)序讀取一個32位浮點數(shù)。
將noAssert
設(shè)置為true將會跳過value
和offset
的檢驗,這意味著offset
將可能超過buffer的結(jié)束位置,默認(rèn)為false
。
例子:
var buf = new Buffer(4);
buf[0] = 0x00;
buf[1] = 0x00;
buf[2] = 0x80;
buf[3] = 0x3f;
console.log(buf.readFloatLE(0));
// 0x01
false
根據(jù)制定偏移量從buffer中根據(jù)特定的endian
字節(jié)序讀取一個64位雙精度數(shù)。
將noAssert
設(shè)置為true將會跳過value
和offset
的檢驗,這意味著offset
將可能超過buffer的結(jié)束位置,默認(rèn)為false
。
例子:
var buf = new Buffer(8);
buf[0] = 0x55;
buf[1] = 0x55;
buf[2] = 0x55;
buf[3] = 0x55;
buf[4] = 0x55;
buf[5] = 0x55;
buf[6] = 0xd5;
buf[7] = 0x3f;
console.log(buf.readDoubleLE(0));
// 0.3333333333333333
false
向buffer
的指定偏移位置寫入value
。注意,value
必須是一個合法的無符號8位整形數(shù)。
將noAssert
設(shè)置為true
將跳過value
和offset
的驗證。這意味著value
可能會過大,或者offset
超過buffer
的末尾導(dǎo)致value
被丟棄,這個參數(shù)除非你十分有把握否則你不應(yīng)去使用它,默認(rèn)為false
。
例子:
var buf = new Buffer(4);
buf.writeUInt8(0x3, 0);
buf.writeUInt8(0x4, 1);
buf.writeUInt8(0x23, 2);
buf.writeUInt8(0x42, 3);
console.log(buf);
// <Buffer 03 04 23 42>
false
向buffer
的指定偏移位置根據(jù)特定的endian
字節(jié)序?qū)懭?code>value。注意,value
必須是一個合法的無符號16位整形數(shù)。
將noAssert
設(shè)置為true
將跳過value
和offset
的驗證。這意味著value
可能會過大,或者offset
超過buffer
的末尾導(dǎo)致value
被丟棄,這個參數(shù)除非你十分有把握否則你不應(yīng)去使用它,默認(rèn)為false
。
例子:
var buf = new Buffer(4);
buf.writeUInt16BE(0xdead, 0);
buf.writeUInt16BE(0xbeef, 2);
console.log(buf);
buf.writeUInt16LE(0xdead, 0);
buf.writeUInt16LE(0xbeef, 2);
console.log(buf);
// <Buffer de ad be ef>
// <Buffer ad de ef be>
false
向buffer
的指定偏移位置根據(jù)特定的endian
字節(jié)序?qū)懭?code>value。注意,value
必須是一個合法的無符號32位整形數(shù)。
將noAssert
設(shè)置為true
將跳過value
和offset
的驗證。這意味著value
可能會過大,或者offset
超過buffer
的末尾導(dǎo)致value
被丟棄,這個參數(shù)除非你十分有把握否則你不應(yīng)去使用它,默認(rèn)為false
。
例子:
var buf = new Buffer(4);
buf.writeUInt32BE(0xfeedface, 0);
console.log(buf);
buf.writeUInt32LE(0xfeedface, 0);
console.log(buf);
// <Buffer fe ed fa ce>
// <Buffer ce fa ed fe>
false
向buffer
的指定偏移位置中寫入value
。注意,value
必須是一個合法的無符號32位整形數(shù)。
將noAssert
設(shè)置為true
將跳過value
和offset
的驗證。這意味著value
可能會過大,或者offset
超過buffer
的末尾導(dǎo)致value
被丟棄,這個參數(shù)除非你十分有把握否則你不應(yīng)去使用它,默認(rèn)為false
。
運作和buffer.writeUInt8
相同,除非buffer內(nèi)容中有包含了作為2的補(bǔ)碼的有符號值。
false
向buffer
的指定偏移位置根據(jù)特定的endian
字節(jié)序?qū)懭?code>value。注意,value
必須是一個合法的有符號16位整形數(shù)。
將noAssert
設(shè)置為true
將跳過value
和offset
的驗證。這意味著value
可能會過大,或者offset
超過buffer
的末尾導(dǎo)致value
被丟棄,這個參數(shù)除非你十分有把握否則你不應(yīng)去使用它,默認(rèn)為false
。
運作和buffer.writeUInt16
相同,除非buffer內(nèi)容中有包含了作為2的補(bǔ)碼的有符號值。
false
向buffer
的指定偏移位置根據(jù)特定的endian
字節(jié)序?qū)懭?code>value。注意,value
必須是一個合法的有符號32位整形數(shù)。
將noAssert
設(shè)置為true
將跳過value
和offset
的驗證。這意味著value
可能會過大,或者offset
超過buffer
的末尾導(dǎo)致value
被丟棄,這個參數(shù)除非你十分有把握否則你不應(yīng)去使用它,默認(rèn)為false
。
運作和buffer.writeUInt32
相同,除非buffer內(nèi)容中有包含了作為2的補(bǔ)碼的有符號值。
false
向buffer
的指定偏移位置根據(jù)特定的endian
字節(jié)序?qū)懭?code>value。注意,value
必須是一個合法的32位浮點數(shù)。
將noAssert
設(shè)置為true
將跳過value
和offset
的驗證。這意味著value
可能會過大,或者offset
超過buffer
的末尾導(dǎo)致value
被丟棄,這個參數(shù)除非你十分有把握否則你不應(yīng)去使用它,默認(rèn)為false
。
例子:
var buf = new Buffer(4);
buf.writeFloatBE(0xcafebabe, 0);
console.log(buf);
buf.writeFloatLE(0xcafebabe, 0);
console.log(buf);
// <Buffer 4f 4a fe bb>
// <Buffer bb fe 4a 4f>
false
向buffer
的指定偏移位置根據(jù)特定的endian
字節(jié)序?qū)懭?code>value。注意,value
必須是一個合法的64位雙精度數(shù)。
將noAssert
設(shè)置為true
將跳過value
和offset
的驗證。這意味著value
可能會過大,或者offset
超過buffer
的末尾導(dǎo)致value
被丟棄,這個參數(shù)除非你十分有把握否則你不應(yīng)去使用它,默認(rèn)為false
。
例子:
var buf = new Buffer(8);
buf.writeDoubleBE(0xdeadbeefcafebabe, 0);
console.log(buf);
buf.writeDoubleLE(0xdeadbeefcafebabe, 0);
console.log(buf);
// <Buffer 43 eb d5 b7 dd f9 5f d7>
// <Buffer d7 5f f9 dd b7 d5 eb 43>
使用指定的value
填充buffer。如果offset
(默認(rèn)為0)和end
(默認(rèn)為buffer.length
)沒有指定,將會填充整個buffer。
var b = new Buffer(50);
b.fill("h");
創(chuàng)建一個buffer內(nèi)的值(bytes)的迭代器。這個函數(shù)會被自動調(diào)用當(dāng)buffer被用于for..of
語句中時。
創(chuàng)建一個buffer的索引的迭代器。
創(chuàng)建一個[index, byte]數(shù)組迭代器。
Number 默認(rèn)值: 50
表示有多少字節(jié)會被返回當(dāng)調(diào)用buffer.inspect()
時。它可以被用戶的模塊所覆蓋。
注意這是一個由require('buffer')
返回的buffer模塊
的屬性,并不是全局Buffer
對象或buffer實例的。
Buffers
可以被ES6的for..of
語法迭代:
var buf = new Buffer([1, 2, 3]);
for (var b of buf)
console.log(b)
// 1
// 2
// 3
另外的,buffer.values()
,buffer.keys()
和buffer.entries()
方法都可以被用來創(chuàng)建迭代器。
返回一個不被池管理的Buffer
。
為了避免創(chuàng)建許多單個的被分配內(nèi)存的小Buffer的垃圾回收開銷。默認(rèn)得,分配小于4KB的空間將會被從一個更大的被分配好內(nèi)存的對象(allocated object)中切片(sliced)得到。這個方法改進(jìn)了性能以及內(nèi)存占用,因為V8的垃圾回收機(jī)制不再需要追蹤和清理許多的小對象。
當(dāng)開發(fā)者需要將池中一小塊數(shù)據(jù)保留不確定的一段時間,較為妥當(dāng)?shù)霓k法是用 SlowBuffer
創(chuàng)建一個不被池管理的Buffer
實例并將相應(yīng)數(shù)據(jù)拷貝出來。
// need to keep around a few small chunks of memory
var store = [];
socket.on('readable', function() {
var data = socket.read();
// allocate for retained data
var sb = new SlowBuffer(10);
// copy the data into the new allocation
data.copy(sb, 0, 0, 10);
store.push(sb);
});
請謹(jǐn)慎使用,僅作為開發(fā)者察覺到在應(yīng)用中有過度的內(nèi)存保留時的最后手段。
更多建議: