Nodejs进阶:中心模块net入门与实例解说

本文摘录自《Nodejs进修笔记》,更多章节及更新,请接见 github主页地点。迎接加群交换,群号 197339705。

模块概览

net模块是同样是nodejs的中心模块。在http模块概览里提到,http.Server继承了net.Server,另外,http客户端与http效劳端的通讯均依赖于socket(net.Socket)。也就是说,做node效劳端编程,net基础是绕不开的一个模块。

从构成来看,net模块主要包括两部分,相识socket编程的同砚应当比较熟习了:

  • net.Server:TCP server,内部经由过程socket来完成与客户端的通讯。

  • net.Socket:tcp/当地 socket的node版完成,它完成了全双工的stream接口。

本文从一个简朴的 tcp效劳端/客户端 的例子最先解说,好让读者有个提要的熟悉。接着再离别引见 net.Server、net.Socket 比较主要的API、属性、事宜。

关于初学者,发起把文中的例子当地跑一遍加深明白。

简朴的 server+client 例子

tcp效劳端顺序以下:

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('你好,我是客户端');

运转效劳端、客户端代码,控制台离别输出以下:

效劳端:

效劳端:最先监听来自客户端的要求
效劳端:收到来自客户端的要求
效劳端:收到客户端数据,内容为{你好,我是客户端}
效劳端:客户端衔接断开

客户端:

客户端:已与效劳端竖立衔接
客户端:收到效劳端数据,内容为{你好,我是效劳端}
客户端:衔接断开

效劳端 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:域名解析完成时触发。

相干链接

官方文档:
https://nodejs.org/api/net.ht…

    原文作者:程序猿小卡_casper
    原文地址: https://segmentfault.com/a/1190000007507322
    本文转自网络文章,转载此文章仅为分享知识,如有侵权,请联系博主进行删除。
点赞