Node.js v14.14.0 文档


string_decoder(字符串解码器)#

中英对照

稳定性: 2 - 稳定

源代码: lib/string_decoder.js

string_decoder 模块提供了一个 API,用一种能保护已编码的多字节 UTF-8 和 UTF-16 字符的方式将 Buffer 对象解码为字符串。 可以使用以下方式访问它:

const { StringDecoder } = require('string_decoder');

以下示例展示了 StringDecoder 类的基本用法:

const { StringDecoder } = require('string_decoder');
const decoder = new StringDecoder('utf8');

const cent = Buffer.from([0xC2, 0xA2]);
console.log(decoder.write(cent));

const euro = Buffer.from([0xE2, 0x82, 0xAC]);
console.log(decoder.write(euro));

Buffer 实例写入 StringDecoder 实例时,会使用一个内部 buffer 来确保解码的字符串不包含任何不完整的多字节字符。 不完整的字符会被保存在该 buffer 中,直到下次调用 stringDecoder.write() 或调用 stringDecoder.end()

在以下示例中,欧洲的欧元符号()的三个 UTF-8 编码字节通过三次单独的操作写入:

const { StringDecoder } = require('string_decoder');
const decoder = new StringDecoder('utf8');

decoder.write(Buffer.from([0xE2]));
decoder.write(Buffer.from([0x82]));
console.log(decoder.end(Buffer.from([0xAC])));

StringDecoder 类#

new StringDecoder([encoding])#

中英对照

  • encoding <string> StringDecoder 将会使用的字符编码默认值: 'utf8'

创建一个新的 StringDecoder 实例。

stringDecoder.end([buffer])#

中英对照

以字符串的形式返回保存在内部 buffer 中的所有的剩余的输入。 不完整的 UTF-8 和 UTF-16 字符的字节将会被替换为适合字符编码的替代字符。

如果提供了 buffer 参数,则在返回剩余的输入之前会再最后一次调用 stringDecoder.write()

stringDecoder.write(buffer)#

中英对照

返回解码的字符串,会确保返回的字符串不会包含 BufferTypedArrayDataView 末尾中的任何不完整的多字节字符,并且会将不完整的字符保存在内部的 buffer 中用于下次调用 stringDecoder.write()stringDecoder.end()