stream模块.md

关于作者

一个工作八年的草根程序员。

内容

• 流接口简介
• Stream分类

一、流接口简介

流（stream）是Node.js中处理流式数据的抽象接口。Node.js中很多对象都实现了流，流是EventEmitter对象的一个实例。

访问stream模块：

const stream = require('stream');

二、Stream分类

在nodejs中，有四种stream类型：

• Readable： 用来读取数据，比如fs.createReadStrem()。
• Writable： 用来写数据，比如fs.createWriteStream()。
• Duplex： 可读+可写，比如net.Socket()。
• Transform： 在读写的过程中，可以对数据进行修改，比如zlib.createDeflat()（数据压缩/解压）。

2.1 Readable

可读流是对提供数据的来源的一种抽象。

Readable的例子包括：

• 客户端的HTTP响应
• 服务端的HTTP请求
• fs的读取流

例一

var fs = require('fs');

fs.readFile('./sample.txt', 'utf8', function(err, content){
	// 文件读取完成，文件内容是 [你好，我是程序猿小卡]
	console.log('文件读取完成，文件内容是 [%s]', content);
});

例二

这里使用了.pipe(dest)，好处在于，如果源文件较大，对于降低内存占用有好处。

var fs = require('fs');

fs.createReadStream('./sample.txt').pipe(process.stdout);

2.2 Writable

Writable的例子包括：

• 客户端的HTTP响应
• 服务端的HTTP请求
• fs的写入流

var fs = require('fs');
var content = 'hello world';
var filepath = './sample.txt';

fs.writeFile(filepath, content);

2.3 Duplex

双工流（Duplex）是同时实现了Readable和Writable接口的流。

最常见的Duplex stream应该就是net.Socket实例了

Duplex流的例子包括：

• TCP socket

服务端代码：

var net = require('net');
var opt = {
	host: '127.0.0.1',
	port: '3000'
};

var server = net.createServer((socket) => {
    socket.on('data', (data) => {
        console.log('client send message: ', data.toString());
    });
    socket.write('hello client');
});
server.listen(opt.port, opt.host, ()=>{
    console.log(server.address());
});

客户端代码：

var net = require('net');
var opt = {
	host: '127.0.0.1',
	port: '3000'
};

var client = net.connect(opt, function(){
	client.write('msg from client');  // 可写
});

// 可读
client.on('data', function(data){
    // lient: got reply from server [reply from server]
	console.log('client: got reply from server [%s]', data);
	client.end();
});

2.4 Transform

Transform 是Duplex的特殊，也就是说，Transform也同时可读可写。

Transform 流的例子包括：

• zlib流
• crypto流

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

var gzip = zlib.createGzip();

var inFile = fs.createReadStream('./extra/fileForCompress.txt');
var out = fs.createWriteStream('./extra/fileForCompress.txt.gz');

inFile.pipe(gzip).pipe(out);

参考资料

• 《node.js高级编程》
• Stream 模块
• 理解Stream模块
• 想学Node.js，stream先有必要搞清楚

联系作者

平凡世界，贵在坚持。