请选择 进入手机版 | 继续访问电脑版
创作

核心模块net入门与实例讲解

node.js  / 只看大图  / 倒序浏览   © 著作权归作者本人所有

#楼主# 2020-6-22

跳转到指定楼层

node.js

node.js


模块概览
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服务端程序如下:
  1. var net = require('net');var PORT = 3000;var HOST = '127.0.0.1';// tcp服务端var server = net.createServer(function(socket){

  2. console.log('服务端:收到来自客户端的请求');

  3. socket.on('data', function(data){

  4. console.log('服务端:收到客户端数据,内容为{'+ data +'}');

  5. // 给客户端返回数据

  6. socket.write('你好,我是服务端');

  7. });

  8. socket.on('close', function(){

  9. console.log('服务端:客户端连接断开');

  10. });});server.listen(PORT, HOST, function(){

  11. console.log('服务端:开始监听来自客户端的请求');});
复制代码

tcp客户端如下:
  1. var net = require('net');var PORT = 3000;var HOST = '127.0.0.1';// tcp客户端var client = net.createConnection(PORT, HOST);client.on('connect', function(){

  2. console.log('客户端:已经与服务端建立连接');});client.on('data', function(data){

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

  4. console.log('客户端:连接断开');});client.end('你好,我是客户端');
复制代码

运行服务端、客户端代码,控制台分别输出如下:
服务端:
服务端:开始监听来自客户端的请求
服务端:收到来自客户端的请求
服务端:收到客户端数据,内容为{你好,我是客户端}服务端:客户端连接断开
客户端:
客户端:已经与服务端建立连接
客户端:收到服务端数据,内容为{你好,我是服务端}客户端:连接断开
服务端 net.Server
server.address()
返回服务端的地址信息,比如绑定的ip地址、端口等。
  1. console.log( server.address() );// 输出如下 { port: 3000, family: 'IPv4', address: '127.0.0.1' }

  2. 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:服务端正常关闭
  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(){

  2. server.close(function(error){

  3. if(error){

  4. console.log( 'close回调:服务端异常:' + error.message );

  5. }else{

  6. console.log( 'close回调:服务端正常关闭' );

  7. }

  8. }); });server.on('close', function(){

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

  10. console.log( 'error事件:服务端异常:' + error.message );});

  11. 输出为:

  12. close事件:服务端关闭close回调:服务端正常关闭
复制代码

例子2:服务端异常关闭
代码如下
  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);server.on('close', function(){

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

  3. console.log( 'error事件:服务端异常:' + error.message );});server.close(function(error){

  4. if(error){

  5. console.log( 'close回调:服务端异常:' + error.message );

  6. }else{

  7. console.log( 'close回调:服务端正常关闭' );

  8. } });

  9. 输出为:

  10. close事件:服务端关闭close回调:服务端异常:Not running

  11. 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的源码。
  1. var net = require('net');var PORT = 3000;var HOST = '127.0.0.1';var noop = function(){};// tcp服务端var server = net.createServer(function(socket){

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

  3. socket.end('2. connection 触发\n');});server.listen(PORT, HOST);
复制代码

通过下面命令测试下效果
输出:
1. connection 触发2. connection 触发
客户端 net.Socket
在文章开头已经举过客户端的例子,这里再把例子贴一下。(备注:严格来说不应该把 net.Socket 叫做客户端,这里方便讲解而已)
单从node官方文档来看的话,感觉 net.Socket 比 net.Server 要复杂很多,有更多的API、事件、属性。但实际上,把 net.Socket 相关的API、事件、属性 进行归类下,会发现,其实也不是特别复杂。
具体请看下一小节内容。
  1. var net = require('net');var PORT = 3000;var HOST = '127.0.0.1';// tcp客户端var client = net.createConnection(PORT, HOST);client.on('connect', function(){

  2. console.log('客户端:已经与服务端建立连接');});client.on('data', function(data){

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

  4. 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:域名解析完成时触发。

更多关于前端进阶内容干货,尽在WEB明教光明顶(https://web.xingruanedu.com

转播转播 分享分享 分享淘帖 反对反对
回复

使用道具

Zjt

主题

帖子

0

积分

新手上路

Rank: 1

积分
0
Zjt 发表于 2020-7-2 10:52:29
不错
回复

使用道具 举报

B Color Link Quote Code Smilies
站点地图|手机版|WEB明教光明顶 |湘ICP备19021820号-1
Powered by WEB明教  © 2017-2020 Starsoft.
返回顶部