Nodejs进阶：核心模块net入门与实例讲解

时间 2019-11-06

标签 nodejs 进阶核心模块入门实例讲解繁體版

原文原文链接

本文摘录自《Nodejs学习笔记》，更多章节及更新，请访问 github主页地址。欢迎加群交流，群号 197339705。html

模块概览

net模块是一样是nodejs的核心模块。在http模块概览里提到，http.Server继承了net.Server，此外，http客户端与http服务端的通讯均依赖于socket（net.Socket）。也就是说，作node服务端编程，net基本是绕不开的一个模块。node

从组成来看，net模块主要包含两部分，了解socket编程的同窗应该比较熟悉了：git

net.Server：TCP server，内部经过socket来实现与客户端的通讯。github
net.Socket：tcp/本地 socket的node版实现，它实现了全双工的stream接口。编程

本文从一个简单的 tcp服务端/客户端的例子开始讲解，好让读者有个概要的认识。接着再分别介绍 net.Server、net.Socket 比较重要的API、属性、事件。api

对于初学者，建议把文中的例子本地跑一遍加深理解。缓存

简单的 server+client 例子

tcp服务端程序以下：bash

var net = require('net');

var PORT = 3000;
var HOST = '127.0.0.1';

// tcp服务端
var server = net.createServer(function(socket){
    console.log('服务端：收到来自客户端的请求');

    socket.on('data', function(data){
        console.log('服务端：收到客户端数据，内容为{'+ data +'}');

        // 给客户端返回数据
        socket.write('你好，我是服务端');
    });

    socket.on('close', function(){
         console.log('服务端：客户端链接断开');
    });
});
server.listen(PORT, HOST, function(){
    console.log('服务端：开始监听来自客户端的请求');
});

tcp客户端以下：服务器

var net = require('net');

var PORT = 3000;
var HOST = '127.0.0.1';

// tcp客户端
var client = net.createConnection(PORT, HOST);

client.on('connect', function(){
    console.log('客户端：已经与服务端创建链接');
});

client.on('data', function(data){
    console.log('客户端：收到服务端数据，内容为{'+ data +'}');
});

client.on('close', function(data){
    console.log('客户端：链接断开');
});

client.end('你好，我是客户端');

运行服务端、客户端代码，控制台分别输出以下：curl

服务端：

服务端：开始监听来自客户端的请求
服务端：收到来自客户端的请求
服务端：收到客户端数据，内容为{你好，我是客户端}
服务端：客户端链接断开

客户端：

客户端：已经与服务端创建链接
客户端：收到服务端数据，内容为{你好，我是服务端}
客户端：链接断开

服务端 net.Server

server.address()

返回服务端的地址信息，好比绑定的ip地址、端口等。

console.log( server.address() );
// 输出以下 { port: 3000, family: 'IPv4', address: '127.0.0.1' }

server.close(callback])

关闭服务器，中止接收新的客户端请求。有几点注意事项：

对正在处理中的客户端请求，服务器会等待它们处理完（或超时），而后再正式关闭。
正常关闭的同时，callback 会被执行，同时会触发 close 事件。
异常关闭的同时，callback 也会执行，同时将对应的 error 做为参数传入。（好比还没调用 server.listen(port) 以前，就调用了server.close()）

下面会经过两个具体的例子进行对比，先把结论列出来

已调用server.listen()：正常关闭，close事件触发，而后callback执行，error参数为undefined
未调用server.listen()：异常关闭，close事件触发，而后callback执行，error为具体的错误信息。（注意，error 事件没有触发）

例子1：服务端正常关闭

var net = require('net');
var PORT = 3000;
var HOST = '127.0.0.1';
var noop = function(){};

// tcp服务端
var server = net.createServer(noop);

server.listen(PORT, HOST, function(){

    server.close(function(error){
        if(error){
            console.log( 'close回调：服务端异常：' + error.message );
        }else{
            console.log( 'close回调：服务端正常关闭' );
        }            
    }); 
});

server.on('close', function(){
    console.log( 'close事件：服务端关闭' );
});

server.on('error', function(error){
    console.log( 'error事件：服务端异常：' + error.message );
});

输出为：

close事件：服务端关闭
close回调：服务端正常关闭

例子2：服务端异常关闭

代码以下

var net = require('net');
var PORT = 3000;
var HOST = '127.0.0.1';
var noop = function(){};

// tcp服务端
var server = net.createServer(noop);

// 没有正式启动请求监听
// server.listen(PORT, HOST);

server.on('close', function(){
    console.log( 'close事件：服务端关闭' );
});

server.on('error', function(error){
    console.log( 'error事件：服务端异常：' + error.message );
});

server.close(function(error){
    if(error){
        console.log( 'close回调：服务端异常：' + error.message );
    }else{
        console.log( 'close回调：服务端正常关闭' );
    }            
});

输出为：

close事件：服务端关闭
close回调：服务端异常：Not running

server.ref()/server.unref()

了解node事件循环的同窗对这两个API应该不陌生，主要用于将server 加入事件循环/从事件循环里面剔除，影响就在于会不会影响进程的退出。

对出学习net的同窗来讲，并不须要特别关注，感兴趣的本身作下实验就好。

事件 listening/connection/close/error

listening：调用 server.listen()，正式开始监听请求的时候触发。
connection：当有新的请求进来时触发，参数为请求相关的 socket。
close：服务端关闭的时候触发。
error：服务出错的时候触发，好比监听了已经被占用的端口。

几个事件都比较简单，这里仅举个 connection 的例子。

从测试结果能够看出，有新的客户端链接产生时，net.createServer(callback) 中的callback回调会被调用，同时 connection 事件注册的回调函数也会被调用。

事实上，net.createServer(callback) 中的 callback 在node内部实现中也是加入了作为 connection事件的监听函数。感兴趣的能够看下node的源码。

var net = require('net');
var PORT = 3000;
var HOST = '127.0.0.1';
var noop = function(){};

// tcp服务端
var server = net.createServer(function(socket){
    socket.write('1. connection 触发\n');
});

server.on('connection', function(socket){
    socket.end('2. connection 触发\n');
});

server.listen(PORT, HOST);

经过下面命令测试下效果

curl http://127.0.0.1:3000

输出：

1. connection 触发
2. connection 触发

客户端 net.Socket

在文章开头已经举过客户端的例子，这里再把例子贴一下。(备注：严格来讲不该该把 net.Socket 叫作客户端，这里方便讲解而已)

单从node官方文档来看的话，感受 net.Socket 比 net.Server 要复杂不少，有更多的API、事件、属性。但实际上，把 net.Socket 相关的API、事件、属性进行归类下，会发现，其实也不是特别复杂。

具体请看下一小节内容。

var net = require('net');

var PORT = 3000;
var HOST = '127.0.0.1';

// tcp客户端
var client = net.createConnection(PORT, HOST);

client.on('connect', function(){
    console.log('客户端：已经与服务端创建链接');
});

client.on('data', function(data){
    console.log('客户端：收到服务端数据，内容为{'+ data +'}');
});

client.on('close', function(data){
    console.log('客户端：链接断开');
});

client.end('你好，我是客户端');

API、属性归类

如下对net.Socket的API跟属性，按照用途进行了大体的分类，方便读者更好的理解。大部分API跟属性都比较简单，看下文档就知道作什么的，这里就先不展开。

链接相关

socket.connect()：有3种不一样的参数，用于不一样的场景；
socket.setTimeout()：用来进行链接超时设置。
socket.setKeepAlive()：用来设置长链接。
socket.destroy(）、socket.destroyed：当错误发生时，用来销毁socket，确保这个socket上不会再有其余的IO操做。

数据读、写相关

socket.write()、socket.end()、socket.pause()、socket.resume()、socket.setEncoding()、socket.setNoDelay()

数据属性相关

socket.bufferSize、socket.bytesRead、socket.bytesWritten

事件循环相关

socket.ref()、socket.unref()

地址相关

socket.address()
socket.remoteAddress、socket.remoteFamily、socket.remotePort
socket.localAddress/socket.localPort

事件简介

data：当收到另外一侧传来的数据时触发。
connect：当链接创建时触发。
close：链接断开时触发。若是是由于传输错误致使的链接断开，则参数为error。
end：当链接另外一侧发送了 FIN 包的时候触发（读者能够回顾下HTTP如何断开链接的）。默认状况下（allowHalfOpen == false），socket会完成自我销毁操做。但你也能够把 allowHalfOpen 设置为 true，这样就能够继续往socket里写数据。固然，最后你须要手动调用 socket.end()
error：当有错误发生时，就会触发，参数为error。（官方文档基本一句话带过，不过考虑到出错的可能太多，也能够理解）
timeout：提示用户，socket 已经超时，须要手动关闭链接。
drain：当写缓存空了的时候触发。（不是很好描述，具体能够看下stream的介绍）
lookup：域名解析完成时触发。