Node.js zlib.bytesWritten 属性

2025年5月8日 | 阅读 4 分钟

Node.js 中的 zlib.bytesWritten 属性是 zlib 模块的一部分，用于查找压缩或解压缩过程中 zlib 流写入输出的总字节数。这个只读特性可以在 zlib 流（如 zlib.Gzip 或 zlib.Deflate）中使用。当流处理数据时，它会自动进行解压缩。其最显著的用途包括调试、测量数据转换进度和流性能监控。例如，在压缩过程中，bytesWritten 反映了压缩输出的大小。此功能为开发人员提供了一种易于使用但功能强大的方法来实时衡量数据处理的性能。

什么是 zlib.bytesWritten？

目的： 其主要目的是显示 zlib 流（无论是解压缩还是压缩）输出写入的字节数。
范围：此特性的实例包括 zlib 流类，如 zlib.Gzip、zlib.Deflate 和 zlib.Inflate，以及它们对应的转换流。
可访问性：写入的字节数会在流处理数据时自动更新，无法主动设置或修改。

语法

它具有以下语法：

关键方面

Node.js zlib.bytesWritten 属性的几个关键方面如下：

用于调试和监控：由于它指示了流已处理的数据量，因此 zlib.bytesWritten 对于监控和调试非常有用，有助于识别问题。
实时跟踪：为了实时观察数据处理的进展，请使用 zlib.bytesWritten。

示例 1

让我们举一个例子来说明 Node.js 的 zlib.byteswritten 属性。

 
const zlib = require('zlib');
const fs = require('fs');

// Create a Brotli compression stream
const brotli = zlib.createBrotliCompress();

// Input and output file paths
const inputFilePath = 'sample.txt';
const outputFilePath = 'sample.txt.br';

// Create read and write streams
const inputStream = fs.createReadStream(inputFilePath);
const outputStream = fs.createWriteStream(outputFilePath);

// Monitor bytesWritten on the output stream
outputStream.on('pipe', () => {
  console.log('Piping started...');
});
outputStream.on('close', () => {
  console.log(`Compression complete. Total bytes written: ${outputStream.bytesWritten}`);
});

// Pipe data through the Brotli compression stream
inputStream
  .pipe(brotli)
  .pipe(outputStream)
  .on('finish', () => {
    console.log('Stream finished success   

涉及的特性

异步特性：由于 Node.js 流通常是异步的，因此 zlib.bytesWritten 的值在整个数据处理过程中是逐步变化的。
准确性：此值不代表原始输入数据的量，而是代表转换后（压缩或解压缩）的字节数。

示例 2

让我们再举一个例子来说明 Node.js 的 zlib.byteswritten 属性。

 
// Import Required Modules
const zlib = require('zlib');
const fs = require('fs');

// Step 1: Create a Brotli Compression Stream
const brotliCompress = zlib.createBrotliCompress();

// Step 2: Define Input and Output Files
const inputFile = fs.createReadStream('document.txt'); // New input file
const outputFile = fs.createWriteStream('document.txt.br'); // New compressed output file

// Step 3: Monitor the Bytes Processed During Compression
brotliCompress.on('data', () => {
  console.log(`Bytes processed so far: ${brotliCompress.bytesWritten}`);
});

// Step 4: Pipe Data Through the Brotli Compression Stream
inputFile
  .pipe(brotliCompress)
  .pipe(outputFile)
  .on('finish', () => {
    console.log(`Compression complete. Total bytes processed: ${brotliCompress.bytesWritten}`);
  });   

说明

流
fs.createReadStream() 函数读取输入文件 example.txt。
使用 fs.createWriteStream()，将压缩数据写入 example.txt.gz。
Gzip 流
zlib.createGzip() 函数生成一个 gzip 压缩流。
gzip.bytesWritten 属性跟踪写入输出的总字节数。
事件参与者
data 事件包含处理过程中当前写入的字节数。
end 事件确认压缩已完成，并记录写入的总字节数。

示例 3

让我们再举一个例子来说明 Node.js 的 zlib.byteswritten 属性。

 
// Importing the zlib and assert modules
const zlib = require('zlib');
const assert = require('assert');

// Input data to be compressed
const input = Buffer.from('Hello, Node.js! Learn zlib.bytesWritten');

// Compressing the input using the deflate method
zlib.deflate(input, (err, deflatedBuffer) => {
  assert(!err); // It ensure that no errors occurred during deflation

  // Variables to track data
  let totalBytes = 0; // Tracks the total bytes processed
  let chunks = [];    // Stores the chunks of compressed data

  // Creating a gzip compression stream
  const gzipStream = zlib.createGzip()

    // 'data' event to capture each chunk
    .on('data', (chunk) => {
      chunks.push(chunk);             // Add the chunk 
      totalBytes += chunk.length;     // Increment total bytes
    })

    // 'end' event triggered after all data is processed
    .on('end', () => {
      // Display the total bytes written to the output
      console.log(`Total bytes written: ${gzipStream.bytesWritten}`);
    });

  // Write the deflated buffer to the gzip stream
  gzipStream.end(deflatedBuffer);
});   

输出

 
Total bytes written: 47

说明

上面的代码说明了如何使用 Node.js 的 zlib.bytesWritten 属性来跟踪压缩过程中写入的总字节数。首先，导入 zlib 和 assert 模块，并定义包含要压缩的输入数据的缓冲区对象。使用 zlib.deflate 方法将输入数据压缩为 deflated 缓冲区。

之后，会生成一个 zlib.createGzip 流以进行进一步压缩。data 事件用于在压缩过程中记录压缩数据块。然后将这些块聚合到一个数组中，并将每个块的大小记录在 totalBytes 中。使用 bytesWritten 属性，end 事件在压缩完成后记录写入输出的总字节数。此示例演示了流处理过程中输出数据大小的动态监控和测量。

结论

总之，Node.js 中的 zlib.bytesWritten 属性提供了一种简单的方法来跟踪使用 zlib 流进行压缩或解压缩操作时写入的总字节数。此功能使开发人员能够获取数据转换的实时信息，这对于调试、性能监控以及确保应用程序有效处理数据特别有用。示例代码演示了如何通过将其与 data 和 finish 等事件结合来有效地使用此属性，从而允许用户观察压缩数据输出的进度。此功能凸显了 zlib 模块在 Node.js 应用程序中可靠且开放地管理压缩过程的有用性。

下一主题Npm-firebase-in-nodejs

← prev next →

Node.js zlib.bytesWritten 属性

什么是 zlib.bytesWritten？

语法

关键方面

示例 1

涉及的特性

示例 2

说明

示例 3

说明

结论

联系信息

关注我们

教程

面试题

在线编译器

Python

Java

.Net Framework

AI, ML and Data Science

Cloud Technology

B.Tech and MCA

Web Technology

PHP

Software Testing

Technical Interview

Java Interview

Python

Web Interview

Database Interview

B.Tech / MCA

Important Interview

Software Testing Interview

Company Interviews

Online Compilers

Multiple Choice Questions

Node.js 教程

Node.js MySQL

Node.js MongoDB

区别

其他

Node.js 选择题

Node.js Express

面试题

Node.js zlib.bytesWritten 属性

什么是 zlib.bytesWritten？

语法

关键方面

示例 1

涉及的特性

示例 2

说明

示例 3

说明

结论

相关帖子

Node.js 和 .Net core 的区别

Node.js 中的 tracker.reset([fn]) 函数

Node.js 中 New Relic 和 Dynatrace 的区别

Node.js fs.fdatasyncSync() 方法

Node.js 中的 ReadableStreamBYOBReader 函数

Node.js 中的 streamConsumers.buffer(stream)

Node.js Stream writable.setDefaultEncoding() 方法

Node.js 中的微服务是什么？

Node.js querystring.unescape() 方法

Node.js Buffer.readInt32LE() 方法

订阅 Tpoint Tech

联系信息

关注我们

教程

面试题

在线编译器