Maison  >  Article  >  interface Web  >  Explication détaillée des API courantes du module Nodejs Buffer

Explication détaillée des API courantes du module Nodejs Buffer

青灯夜游
青灯夜游avant
2021-05-13 10:49:591917parcourir

Cet article vous donnera une introduction détaillée aux API communes du module Nodejs Buffer. Il a une certaine valeur de référence. Les amis dans le besoin peuvent s'y référer. J'espère qu'il sera utile à tout le monde.

Explication détaillée des API courantes du module Nodejs Buffer

Présentation du module

Buffer est le module principal de Node. Les développeurs peuvent l'utiliser pour traiter des données binaires, telles que des flux de fichiers. . Lecture et écriture, traitement des données des requêtes réseau, etc.

Il existe de nombreuses API pour Buffer. Cet article sélectionne uniquement les API les plus couramment utilisées/faciles à comprendre à expliquer, notamment la création, la comparaison, la connexion, la copie, la recherche, la traversée, la conversion de type, l'interception, conversion d'encodage, etc. des instances de Buffer. [Apprentissage recommandé : "Tutoriel nodejs"]

Créer

  • nouveau Buffer(array)
  • Buffer. alloc(length)
  • Buffer.allocUnsafe(length)
  • Buffer.from(array)

via un nouveau Buffer(array)

// Creates a new Buffer containing the ASCII bytes of the string 'buffer'
const buf = new Buffer([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]);

Vérifier :

var array = 'buffer'.split('').map(function(v){
    return '0x' + v.charCodeAt(0).toString(16)
});

console.log( array.join() );
// 输出:0x62,0x75,0x66,0x66,0x65,0x72

via Buffer.alloc(length)

var buf1 = Buffer.alloc(10);  // 长度为10的buffer,初始值为0x0
var buf2 = Buffer.alloc(10, 1);  // 长度为10的buffer,初始值为0x1
var buf3 = Buffer.allocUnsafe(10);  // 长度为10的buffer,初始值不确定
var buf4 = Buffer.from([1, 2, 3])  // 长度为3的buffer,初始值为 0x01, 0x02, 0x03

via Buffer.from()

Exemple 1 : Buffer.from(array)

// [0x62, 0x75, 0x66, 0x66, 0x65, 0x72] 为字符串 "buffer" 
// 0x62 为16进制,转成十进制就是 98,代表的就是字母 b
var buf = Buffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]);
console.log(buf.toString());

Exemple 2 : Buffer.from(string[, encoding])

Créez un tampon via une chaîne et convertissez le tampon en caractères Quand chaîne, n'oubliez pas de garder l'encodage cohérent, sinon des caractères tronqués apparaîtront, comme indiqué ci-dessous.

var buf = Buffer.from('this is a tést');  // 默认采用utf8

// 输出:this is a tést
console.log(buf.toString());  // 默认编码是utf8,所以正常打印

// 输出:this is a tC)st
console.log(buf.toString('ascii'));  // 转成字符串时,编码不是utf8,所以乱码

L'analyse des caractères tronqués est la suivante :

var letter = 'é';
var buff = Buffer.from(letter);  // 默认编码是utf8,这里占据两个字节 <Buffer c3 a9>
var len = buff.length;  // 2
var code = buff[0]; // 第一个字节为0xc3,即195:超出ascii的最大支持范围
var binary = code.toString(2);  // 195的二进制:10101001
var finalBinary = binary.slice(1);  // 将高位的1舍弃,变成:0101001
var finalCode = parseInt(finalBinary, 2);  // 0101001 对应的十进制:67
var finalLetter = String.fromCharCode(finalCode);  // 67对应的字符:C

// 同理 0xa9最终转成的ascii字符为)
// 所以,最终输出为 this is a tC)st

Exemple 3 : Buffer.from(buffer)

Créez une nouvelle instance de Buffer et copiez les données du tampon dans le nouveau Allez à l'exemple.

var buff = Buffer.from(&#39;buffer&#39;);
var buff2 = Buffer.from(buff);

console.log(buff.toString());  // 输出:buffer
console.log(buff2.toString());  // 输出:buffer

buff2[0] = 0x61;

console.log(buff.toString());  // 输出:buffer
console.log(buff2.toString());  // 输出:auffer

comparaison de tampon

buf.equals(otherBuffer)

Déterminez si les données stockées dans deux instances de tampon sont les idem, si c'est le cas, retournez vrai, sinon retournez faux.

// 例子一:编码一样,内容相同
var buf1 = Buffer.from(&#39;A&#39;);
var buf2 = Buffer.from(&#39;A&#39;);

console.log( buf1.equals(buf2) );  // true

// 例子二:编码一样,内容不同
var buf3 = Buffer.from(&#39;A&#39;);
var buf4 = Buffer.from(&#39;B&#39;);

console.log( buf3.equals(buf4) );  // false

// 例子三:编码不一样,内容相同
var buf5 = Buffer.from(&#39;ABC&#39;);  // <Buffer 41 42 43>
var buf6 = Buffer.from(&#39;414243&#39;, &#39;hex&#39;);

console.log(buf5.equals(buf6));    //true

//只要比较的两者内容相同,`buf.equals(otherBuffer)` 就返回true

buf.compare(target[, targetStart[, targetEnd[, sourceStart[, sourceEnd]]]])

compare également deux instances de tampon, la différence est :

  • Vous pouvez spécifier la plage d'une comparaison spécifique (spécifiée par le début et la fin)

  • La valeur de retour est un entier, et le standard buf, La relation de taille de la cible

Supposons que la valeur de retour soit

  • 0 : buf et target ont la même taille.
  • 1 : buf est supérieur à la cible, ce qui signifie que buf doit être classé après la cible.
  • -1 : buf est plus petit que la cible, ce qui signifie que buf doit être classé avant la cible.

Regardez l'exemple, l'exemple officiel est plutôt bon, collez-le simplement :

const buf1 = Buffer.from(&#39;ABC&#39;);
const buf2 = Buffer.from(&#39;BCD&#39;);
const buf3 = Buffer.from(&#39;ABCD&#39;);

// Prints: 0
console.log(buf1.compare(buf1));

// Prints: -1
console.log(buf1.compare(buf2));

// Prints: -1
console.log(buf1.compare(buf3));

// Prints: 1
console.log(buf2.compare(buf1));

// Prints: 1
console.log(buf2.compare(buf3));

// Prints: [ <Buffer 41 42 43>, <Buffer 41 42 43 44>, <Buffer 42 43 44> ]
// (This result is equal to: [buf1, buf3, buf2])
console.log([buf1, buf2, buf3].sort(Buffer.compare));

Buffer.compare(buf1, buf2)

Semblable à buf.compare(target), il est généralement utilisé pour le tri. Postez directement l'exemple officiel :

const buf1 = Buffer.from(&#39;1234&#39;);
const buf2 = Buffer.from(&#39;0123&#39;);
const arr = [buf1, buf2];

// Prints: [ <Buffer 30 31 32 33>, <Buffer 31 32 33 34> ]
// (This result is equal to: [buf2, buf1])
console.log(arr.sort(Buffer.compare));

Parlons de Buffer.from([62])

Étudions un peu Buffer.from(array) ici. Ce qui suit est la description de l'API tirée du document officiel, c'est-à-dire que chaque élément du tableau correspond à 1 octet (8 bits), et la valeur varie de 0 à 255.

Alloue un nouveau Buffer en utilisant un tableau d'octets.

Les éléments du tableau sont des nombres

Premier aperçu, transmettez-le éléments pour la scène numérique. Les éléments suivants sont décimaux, octaux et hexadécimaux, qui correspondent aux résultats attendus.

var buff = Buffer.from([62])
// <Buffer 3e>
// buff[0] === parseInt(&#39;3e&#39;, 16) === 62
var buff = Buffer.from([062])
// <Buffer 32>
// buff[0] === parseInt(62, 8) === parseInt(32, 16) === 50
var buff = Buffer.from([0x62])
// <Buffer 62>
// buff[0] === parseInt(62, 16) === 98

L'élément du tableau est une chaîne

Regardez encore, l'élément entrant est une chaîne. La chaîne commençant par

  • 0 peut être interprétée comme 62 ou 50 (octal) lorsque parseInt('062') est utilisé. Ici, nous voyons que le premier type d'explication.

  • La question de savoir si le scénario de chaîne a quelque chose à voir avec parseInt() n'a pas encore été explorée en profondeur, juste une supposition. TODO (trouver le temps d'étudier)

var buff = Buffer.from([&#39;62&#39;])
// <Buffer 3e>
// buff[0] === parseInt(&#39;3e&#39;, 16) === parseInt(&#39;62&#39;) === 62
var buff = Buffer.from([&#39;062&#39;])
// <Buffer 3e>
// buff[0] === parseInt(&#39;3e&#39;, 16) === parseInt(&#39;062&#39;) === 62
var buff = Buffer.from([&#39;0x62&#39;])
// <Buffer 62>
// buff[0] === parseInt(&#39;62&#39;, 16) === parseInt(&#39;0x62&#39;) === 98

La taille de l'élément du tableau dépasse 1 octet

Les étudiants intéressés peuvent explorer par eux-mêmes.

var buff = Buffer.from([256])
// <Buffer 00>

Buffer.from('1')

Au début, vous assimilerez inconsciemment Buffer.from('1')[0] à "1", mais en réalité "1" correspond à l'encodage est 49.

var buff = Buffer.from(&#39;1&#39;)  // <Buffer 31>
console.log(buff[0] === 1)  // false

Comme vous pouvez le voir sur cette comparaison, celui codé comme 1 est un caractère de contrôle, ce qui signifie Début de Titre.

console.log( String.fromCharCode(49) )  // &#39;1&#39;
console.log( String.fromCharCode(1) )  // &#39;\u0001&#39;

buffer connection: Buffer.concat(list[, totalLength])

Remarque : Personnellement, je pense que ce paramètre totalLength est assez redondant, à en juger par le la documentation officielle, est considérée dans une perspective d'amélioration des performances. Cependant, l'implémentation interne ne fait que parcourir la liste et accumule de la longueur pour obtenir totalLength. De ce point de vue, l'optimisation des performances est presque négligeable.

var buff1 = Buffer.alloc(10);
var buff2 = Buffer.alloc(20);

var totalLength = buff1.length + buff2.length;

console.log(totalLength);  // 30

var buff3 = Buffer.concat([buff1, buff2], totalLength);

console.log(buff3.length);  // 30

En plus de l'optimisation des performances mentionnée ci-dessus, il y a deux autres points à noter concernant totalLength. Supposons que la longueur cumulée de tous les tampons de la liste est length

  • totalLength > length:返回长度为totalLength的Buffer实例,超出长度的部分填充0。
  • totalLength < length:返回长度为totalLength的Buffer实例,后面部分舍弃。
var buff4 = Buffer.from([1, 2]);
var buff5 = Buffer.from([3, 4]);

var buff6 = Buffer.concat([buff4, buff5], 5);

console.log(buff6.length);  // 
console.log(buff6);  // <Buffer 01 02 03 04 00>

var buff7 = Buffer.concat([buff4, buff5], 3);

console.log(buff7.length);  // 3
console.log(buff7);  // <Buffer 01 02 03>

拷贝:buf.copy(target[, targetStart[, sourceStart[, sourceEnd]]])

使用比较简单,如果忽略后面三个参数,那就是将buf的数据拷贝到target里去,如下所示:

var buff1 = Buffer.from([1, 2]);
var buff2 = Buffer.alloc(2);

buff1.copy(buff2);

console.log(buff2);  // <Buffer 01 02>

另外三个参数比较直观,直接看官方例子

const buf1 = Buffer.allocUnsafe(26);
const buf2 = Buffer.allocUnsafe(26).fill(&#39;!&#39;);

for (let i = 0 ; i < 26 ; i++) {
  // 97 is the decimal ASCII value for &#39;a&#39;
  buf1[i] = i + 97;
}

buf1.copy(buf2, 8, 16, 20);

// Prints: !!!!!!!!qrst!!!!!!!!!!!!!
console.log(buf2.toString(&#39;ascii&#39;, 0, 25));

查找:buf.indexOf(value[, byteOffset][, encoding])

跟数组的查找差不多,需要注意的是,value可能是String、Buffer、Integer中的任意类型。

  • String:如果是字符串,那么encoding就是其对应的编码,默认是utf8。
  • Buffer:如果是Buffer实例,那么会将value中的完整数据,跟buf进行对比。
  • Integer:如果是数字,那么value会被当做无符号的8位整数,取值范围是0到255。

另外,可以通过byteOffset来指定起始查找位置。

直接上代码,官方例子妥妥的,耐心看完它基本就理解得差不多了。

const buf = Buffer.from(&#39;this is a buffer&#39;);

// Prints: 0
console.log(buf.indexOf(&#39;this&#39;));

// Prints: 2
console.log(buf.indexOf(&#39;is&#39;));

// Prints: 8
console.log(buf.indexOf(Buffer.from(&#39;a buffer&#39;)));

// Prints: 8
// (97 is the decimal ASCII value for &#39;a&#39;)
console.log(buf.indexOf(97));

// Prints: -1
console.log(buf.indexOf(Buffer.from(&#39;a buffer example&#39;)));

// Prints: 8
console.log(buf.indexOf(Buffer.from(&#39;a buffer example&#39;).slice(0, 8)));


const utf16Buffer = Buffer.from(&#39;\u039a\u0391\u03a3\u03a3\u0395&#39;, &#39;ucs2&#39;);

// Prints: 4
console.log(utf16Buffer.indexOf(&#39;\u03a3&#39;, 0, &#39;ucs2&#39;));

// Prints: 6
console.log(utf16Buffer.indexOf(&#39;\u03a3&#39;, -4, &#39;ucs2&#39;));

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

将sring写入buf实例,同时返回写入的字节数。

参数如下:

  • string:写入的字符串。
  • offset:从buf的第几位开始写入,默认是0。
  • length:写入多少个字节,默认是 buf.length - offset。
  • encoding:字符串的编码,默认是utf8。

看个简单例子

var buff = Buffer.alloc(4);
buff.write(&#39;a&#39;);  // 返回 1
console.log(buff);  // 打印 <Buffer 61 00 00 00>

buff.write(&#39;ab&#39;);  // 返回 2
console.log(buff);  // 打印 <Buffer 61 62 00 00>

填充:buf.fill(value[, offset[, end]][, encoding])

value填充buf,常用于初始化buf。参数说明如下:

  • value:用来填充的内容,可以是Buffer、String或Integer。
  • offset:从第几位开始填充,默认是0。
  • end:停止填充的位置,默认是 buf.length。
  • encoding:如果value是String,那么为value的编码,默认是utf8。

例子:

var buff = Buffer.alloc(20).fill(&#39;a&#39;);

console.log(buff.toString());  // aaaaaaaaaaaaaaaaaaaa

转成字符串: buf.toString([encoding[, start[, end]]])

把buf解码成字符串,用法比较直观,看例子

var buff = Buffer.from(&#39;hello&#39;);

console.log( buff.toString() );  // hello

console.log( buff.toString(&#39;utf8&#39;, 0, 2) );  // he

转成JSON字符串:buf.toJSON()

var buff = Buffer.from(&#39;hello&#39;);

console.log( buff.toJSON() );  // { type: &#39;Buffer&#39;, data: [ 104, 101, 108, 108, 111 ] }

遍历:buf.values()、buf.keys()、buf.entries()

用于对buf进行for...of遍历,直接看例子。

var buff = Buffer.from(&#39;abcde&#39;);

for(const key of buff.keys()){
    console.log(&#39;key is %d&#39;, key);
}
// key is 0
// key is 1
// key is 2
// key is 3
// key is 4

for(const value of buff.values()){
    console.log(&#39;value is %d&#39;, value);
}
// value is 97
// value is 98
// value is 99
// value is 100
// value is 101

for(const pair of buff.entries()){
    console.log(&#39;buff[%d] === %d&#39;, pair[0], pair[1]);
}
// buff[0] === 97
// buff[1] === 98
// buff[2] === 99
// buff[3] === 100
// buff[4] === 101

截取:buf.slice([start[, end]])

用于截取buf,并返回一个新的Buffer实例。需要注意的是,这里返回的Buffer实例,指向的仍然是buf的内存地址,所以对新Buffer实例的修改,也会影响到buf。

var buff1 = Buffer.from(&#39;abcde&#39;);
console.log(buff1);  // <Buffer 61 62 63 64 65>

var buff2 = buff1.slice();
console.log(buff2);  // <Buffer 61 62 63 64 65>

var buff3 = buff1.slice(1, 3);
console.log(buff3);  // <Buffer 62 63>

buff3[0] = 97;  // parseInt(61, 16) ==> 97
console.log(buff1);  // <Buffer 62 63>

TODO

  • 创建、拷贝、截取、转换、查找

  • buffer、arraybuffer、dataview、typedarray

  • buffer vs 编码

  • Buffer.from()、Buffer.alloc()、Buffer.alocUnsafe()

  • Buffer vs TypedArray

文档摘要

关于buffer内存空间的动态分配

Instances of the Buffer class are similar to arrays of integers but correspond to fixed-sized, raw memory allocations outside the V8 heap. The size of the Buffer is established when it is created and cannot be resized.

相关链接

unicode对照表 https://unicode-table.com/cn/#control-character

字符编码笔记:ASCII,Unicode和UTF-8 http://www.ruanyifeng.com/blog/2007/10/ascii_unicode_and_utf-8.html

更多编程相关知识,请访问:编程视频!!

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!

Déclaration:
Cet article est reproduit dans:. en cas de violation, veuillez contacter admin@php.cn Supprimer