这里有新鲜出炉的 Node.js 教程,程序狗速度看过来!
Node.js 是一个基于 Chrome JavaScript 运行时建立的一个平台, 用来方便地搭建快速的 易于扩展的网络应用 · Node.js 借助事件驱动, 非阻塞 I/O 模型变得轻量和高效, 非常适合 运行在分布式设备 的 数据密集型 的实时应用
本篇文章主要是介绍了 Nodejs 之 NET 模块,net 模块是同样是 nodejs 的核心模块,具有一定的参考价值,感兴趣的小伙伴们可以参考一下。
模块概览
net 模块是同样是 nodejs 的核心模块。在 http 模块概览里提到,http.Server 继承了 net.Server,此外,http 客户端与 http 服务端的通信均依赖于 socket(net.Socket)。也就是说,做 node 服务端编程,net 基本是绕不开的一个模块。
从组成来看,net 模块主要包含两部分,了解 socket 编程的同学应该比较熟悉了:
本文从一个简单的 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])
关闭服务器,停止接收新的客户端请求。有几点注意事项:
下面会通过两个具体的例子进行对比,先把结论列出来
例子 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
几个事件都比较简单,这里仅举个 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.write()、socket.end()、socket.pause()、socket.resume()、socket.setEncoding()、socket.setNoDelay()
数据属性相关
socket.bufferSize、socket.bytesRead、socket.bytesWritten
事件循环相关
socket.ref()、socket.unref()
地址相关
事件简介
相关链接
官方文档:https://nodejs.org/api/net.html#net_socket_destroy_exception
来源: http://www.phperz.com/article/17/0429/330348.html