Node.js Buffer

Сам язык JavaScript имеет только строковый тип данных и не имеет двоичного типа данных.

Класс Buffer в Node.js — это основной инструмент для работы с бинарными данными, обеспечивающий эффективные операции с бинарными данными.

Класс Buffer особенно полезен в таких сценариях, как файловые операции, сетевое взаимодействие и обработка изображений.

Возможности:

• Бинарные данные：BufferОбъект представляет собой массив фиксированного размера, содержащий необработанные бинарные данные. Каждый элемент занимает один байт (8 бит), поэтомуBufferон подходит для обработки бинарных данных, таких как содержимое файлов, сетевые пакеты и т.д.
• Неизменяемость: ХотяBufferсодержимое объекта может быть изменено после создания, его длина фиксирована и не может быть изменена динамически.

Buffer и кодировки символов

Экземпляры Buffer обычно используются для представления последовательностей закодированных символов, таких как UTF-8, UCS2, Base64 или данные в шестнадцатеричной кодировке. Используя явные кодировки символов, можно выполнять преобразование между экземплярами Buffer и обычными строками JavaScript.

В настоящее время Node.js поддерживает следующие кодировки символов:

• ascii- Поддерживаются только 7-битные данные ASCII. Эта кодировка очень быстрая, если старший бит удалён.

• utf8- Unicode-символы, кодируемые как многобайтовые. Многие веб-страницы и другие форматы документов используют UTF-8.

• utf16le- 2 или 4 байта, Unicode-символы в little-endian кодировке. Поддерживает суррогатные пары (от U+10000 до U+10FFFF).

• ucs2 - utf16leПсевдоним .

• base64- Кодировка Base64.

• latin1- Способ дляBufferкодировать в однобайтовую строку.

• binary - latin1Псевдоним .

• hex- Кодирует каждый байт в два шестнадцатеричных символа.

Создание класса Buffer

Buffer предоставляет следующие API для создания класса Buffer:

• Buffer.alloc(size[, fill[, encoding]])：Создаёт Buffer длиной size байт, что эквивалентно выделению size байт памяти, при этом значение каждого байта равно 0.
• Buffer.allocUnsafe(size)：Создаёт Buffer длиной size байт, но Buffer может содержать старые данные, что может повлиять на результат выполнения, отсюда и название unsafe.
• Buffer.allocUnsafeSlow(size)：Используется для выделения нового экземпляра Buffer заданного размера, но без его инициализации.
• Buffer.from(array)：Возвращает новый экземпляр Buffer, инициализированный значениями array (элементы переданного массива могут быть только числами, иначе они автоматически заменяются на 0).
• Buffer.from(arrayBuffer[, byteOffset[, length]])：Возвращает только что созданный Buffer, который использует ту же память, что и заданный ArrayBuffer.
• Buffer.from(buffer)：Копирует данные переданного экземпляра Buffer и возвращает новый экземпляр Buffer.
• Buffer.from(string[, encoding])：Создаёт Buffer из строки; можно указать кодировку, по умолчанию UTF-8.

Запись в буфер

Синтаксис

Синтаксис записи в буфер Node выглядит следующим образом:

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

Parameters

Параметры описываются следующим образом:

• string- Строка, которую нужно записать в буфер.

• offset- Значение индекса, с которого начинается запись в буфер, по умолчанию 0.

• length— количество байтов для записи, по умолчанию — buffer.length.

• encoding— используемая кодировка. По умолчанию 'utf8'.

Записывает строку в buf в позицию offset в соответствии с кодировкой символов encoding. Параметр length — это количество байтов для записи. Если в buf недостаточно места для размещения всей строки, будет записана только часть строки. Частично декодированные символы не будут записаны.

Возвращаемое значение

Возвращает фактически записанный размер. Если места в буфере недостаточно, будет записана только часть строки.

Пример

buf = Buffer.alloc(256);
len = buf.write("www.example.com");

console.log("写入字节数 : "+  len);

Выполните приведённый выше код, и результат вывода будет:

$node main.js
写入字节数 : 14

Чтение данных из Buffer

Синтаксис

Синтаксис чтения данных буфера Node выглядит следующим образом:

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

Parameters

Параметры описываются следующим образом:

• 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;
});

// 输出: <Buffer 01 02 03 04 05>
console.log(copy);

Выполните приведённый выше код, и результат вывода будет:

{"type":"Buffer","data":[1,2,3,4,5]}
<Buffer 01 02 03 04 05>

Конкатенация Buffer

Синтаксис

Синтаксис конкатенации буферов Node выглядит следующим образом:

Buffer.concat(list[, totalLength])

Parameters

Параметры описываются следующим образом:

• list- Список-массив объектов Buffer, которые нужно объединить.

• totalLength- Задает общую длину объединенного объекта Buffer.

Возвращаемое значение

Возвращает новый объект Buffer, сформированный путем конкатенации нескольких элементов.

Пример

var buffer1 = Buffer.from(('Example'));
var buffer2 = Buffer.from(('www.example.com'));
var buffer3 = Buffer.concat([buffer1,buffer2]);
console.log("buffer3 内容: " + buffer3.toString());

Выполните приведённый выше код, и результат вывода будет:

buffer3 内容: Examplewww.example.com

Сравнение Buffer

Синтаксис

Синтаксис функции для сравнения Buffer в Node выглядит следующим образом. Этот метод был представлен в Node.js v0.12.2:

buf.compare(otherBuffer);

Parameters

Параметры описываются следующим образом:

• 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之前

Копирование Buffer

Синтаксис

Синтаксис копирования буфера Node выглядит так:

buf.copy(targetBuffer[, targetStart[, sourceStart[, sourceEnd]]])

Parameters

Параметры описаны ниже:

• targetBuffer- объект Buffer, который нужно скопировать.

• targetStart- число, необязательный, по умолчанию: 0

• sourceStart- число, необязательный, по умолчанию: 0

• sourceEnd- число, необязательный, по умолчанию: buffer.length

Возвращаемое значение

Нет возвращаемого значения.

Пример

var buf1 = Buffer.from('abcdefghijkl');
var buf2 = Buffer.from('EXAMPLE');

//将 buf2 插入到 buf1 指定位置上
buf2.copy(buf1, 2);

console.log(buf1.toString());

Выполнение приведённого выше кода даёт следующий результат:

abEXAMPLEijkl

Срез буфера

Синтаксис среза буфера Node выглядит так:

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

Parameters

Параметры описаны ниже:

• start- число, необязательный, по умолчанию: 0

• end- число, необязательный, по умолчанию: buffer.length

Возвращаемое значение

Возвращает новый буфер, который указывает на ту же память, что и старый буфер, но представляет собой срез от индекса start до end.

Пример

var buffer1 = Buffer.from('example');
// 剪切缓冲区
var buffer2 = buffer1.slice(0,2);
console.log("buffer2 content: " + buffer2.toString());

Выполнение приведённого выше кода даёт следующий результат:

buffer2 content: ru

Длина Buffer

Синтаксис

Синтаксис вычисления длины буфера Node следующий:

buf.length;

Возвращаемое значение

Возвращает длину памяти, занимаемой объектом Buffer.

Пример

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

Выполнение приведённого выше кода даёт следующий результат:

buffer length: 14

Справочное руководство по методам

Ниже перечислены часто используемые методы модуля Buffer в Node.js (обратите внимание, что некоторые методы недоступны в старых версиях):

const buf = Buffer.allocUnsafe(6);

buf.writeUIntLE(0x1234567890ab, 0, 6);

// 输出: <Buffer ab 90 78 56 34 12>
console.log(buf);

const buf = Buffer.allocUnsafe(6);

buf.writeUIntBE(0x1234567890ab, 0, 6);

// 输出: <Buffer 12 34 56 78 90 ab>
console.log(buf);