三言两语说透process.stdout.write和console.log的区别

Node.js中的process.stdout.write和console.log都是用于向标准输出流(stdout)打印输出的方法，但二者在使用场景和实现方式上有些区别。本文将详细介绍process.stdout.write和console.log的区别。

process.stdout.write介绍

process.stdout.write是Node.js中的一个核心API,用于向标准输出流(stdout)写入数据。

它的主要特点包括:

• 用于向终端打印输出。node中的console.log方法内部就是使用process.stdout.write实现的。
• 可以写入Buffer对象或字符串。
• 写入是异步的，需要通过注册’drain’事件来知道流是否为空并等待写入完成。
• 如果stdout传给了管道(pipe)，写入会阻塞直到输出消费者读取数据。
• 默认情况下stdout是块缓冲的，调用process.stdout.write()并不会总是立即打印到终端，需要设置{ stdio: 'ignore' }来禁用缓冲。

它的函数签名是:

process.stdout.write(chunk[, encoding][, callback])

参数说明:

• chunk：要写入的数据，可以是Buffer对象或字符串
• encoding：如果写入的是字符串，该参数指定字符编码，默认为’utf8’
• callback：回调函数，在数据写入完成后被调用

使用示例：

process.stdout.write('Hello '); 
process.stdout.write('World!' + '\n');

// 注册'drain'事件以知道流是否为空
process.stdout.on('drain', () => {
  console.log('write completed, stdout drained');
});

process.stdout.write直接写入的都是原始数据流，支持写入Buffer对象和字符串。它通过系统级的文件描述符来实现对标准输出流的操作。

console.log介绍

console.log也是用于向标准输出打印数据，是Node.js CONSOLE模块提供的方法。

它的函数签名是:

console.log([data][, ...args])

参数说明:

• data：要输出的内容，可以是多个，会依次打印
• args：其它要替换输出的内容

console.log接受的参数非常灵活，可以输出多个内容，并且支持字符串替换和格式化。

区别比较

1. 使用场景不同

process.stdout.write是底层的API，允许对stdout流进行更底层的控制。适用于需要自己控制写入timing的场景，比如绘制终端进度条、动画等。

console.log是更高级的打印方法,默认情况下会添加换行，输出内容比较人性化，适用于日常的debug打印。

2. 实现机制不同

process.stdout.write是直接系统调用，通过文件描述符对标准流进行写操作。

console.log需要输出的内容会先被Console类处理格式化后，再通过系统的process.stdout.write进行底层写操作。

3. 输出内容不同

process.stdout.write直接写入的是Buffer对象或字符串的数据。

console.log支持多参数输入，可以输出复杂的嵌套数据，并且会自动申请内存空间，不需要自己创建Buffer。

4. 缓冲机制不同

process.stdout.write的写入是同步的，调用一次就会立即执行写入。

console.log默认是行缓冲的,即输出内容不会立即打印到终端，会进行缓冲，在遇到换行或主动flush的时候才输出。

5. 编码处理不同

process.stdout.write支持手动指定编码，如’utf8’等。

console.log会自动判断编码，在处理多字节字符集时更友好。

6. 补充换行不同

process.stdout.write不会添加任何换行或空格。

console.log默认打印内容后会补充一个换行符’\n’。

7. 异步机制不同

process.stdout.write支持回调函数通知写入完成。

console.log没有回调，写入同步进行。

何时使用process.stdout.write

由于process.stdout.write更底层，所以什么时候会需要用到它呢?

主要的使用场景包括:

• 需要按特定频率输出内容，比如打印下载进度
• 需要对终端进行更细粒度控制，例如清除行、光标位置等
• 生成输出图表或动画效果
• 实现日志记录系统，需要精确写入时间而不是缓冲输出
• 需要与管道或其他类型的流集成时，用更底层的写操作会更方便

总结

process.stdout.write和console.log作为Node.js中打印输出的两种主要方式，各有优势:

process.stdout.write提供底层的写操作控制，支持流动态写入，但需要自己管理缓冲和编码处理。

console.log提供了更方便的格式化输出，自动管理缓冲，支持复杂数据打印，非常适合日常debug使用。

明确两者的区别和适用场景，可以根据具体需求选择更合适的打印输出方式。

一川说

觉得文章不错的读者，不妨点个关注，收藏起来上班摸鱼的时候品尝。

欢迎关注笔者公众号「宇宙一码平川」，助你技术路上一码平川。