NodeJS 学习资料
1. npm
除Node本身提供的API外,现在有不少第三方模块可极大的提高开发效率,npm就是Node的软件包管理器,可以用它安装所需软件包并发布自己为nodejs写的软件包。
npm安装node扩展包同样是一行代码:
npm install <包名> //例:npm install express
注:如果安装模块的过程中报域名错误的话,请清空缓存 >npm cache clean 或重启计算机即可。
2.模块
在Node中,不同的功能组件被划分成不同的模块。应用可以根据自己的需要来选择使用合适的模块。每个模块都会暴露一些公共的方法或属性。模块的使用者直 接使用这些方法或属性即可,对于内部的实现细节就可以不用了解。除了Node本身提供的API外,开发人员也可以利用这个机制来将应用拆分成多个模块,以 提高代码的可复用性。
在Node中使用模块是非常方便的,在 JavaScript 代码中可以直接使用全局函数 require() 来加载一个模块。
私有和共有 介绍
先创建一个myModule.js,代码如下
var name = "Darren"; this.location = "Beijing"; this.showLog = function(){ console.log('Hi Darren.') };
代码中出现了三种类型,分别是: 私用属性,共有属性和共有方法,再创建一个test.js,执行Node
结果高亮的地方很清楚的告诉我们,私有方法我们在模块以外是取不到的,所以是undefined。共有属性和共有方法的声明需要在前面加上 this 关键字。
事件流
因为Node 采用的是事件驱动的模式,其中的很多模块都会产生各种不同的事件,可由模块来添加事件处理方法,所有能够产生事件的对象都是事件模块中的 EventEmitter 类的实例。代码是全世界通用的语言,所以我们还是用代码说话:
var events = require("events"); var emitter = new events.EventEmitter(); emitter.on("myEvent", function(msg) { console.log(msg); }); emitter.emit("myEvent", "Hello World.");
简单的分析这段:
1. 使用require()方法添加了events模块并把返回值赋给了一个变量
2. new events.EventEmitter()这句创建了一个事件触发器,也就是所谓的事件模块中的 EventEmitter 类的实例
3. on(event, listener)用来为某个事件 event 添加事件处理方法监听器
4. emit(event, [arg1], [arg2], [...]) 方法用来产生事件。以提供的参数作为监听器函数的参数,顺序执行监听器列表中的每个监听器函数。
EventEmitter 类中的方法都与事件的产生和处理相关:
1. addListener(event, listener) 和 on(event, listener) 这两个方法都是将一个监听器添加到指定事件的监听器数组的末尾
2. once(event, listener) 这个方法为事件为添加一次性的监听器。该监听器在事件第一次触发时执行,过后将被移除
3. removeListener(event, listener) 该方法用来将监听器从指定事件的监听器数组中移除出去
4. emit(event, [arg1], [arg2], [...]) 刚刚提到过了。
在Node中,存在各式各样不同的数据流,Stream(流)是一个由不同对象实现的抽象接口。例如请求HTTP服务器的request是一个 流,类似于stdout(标准输出);包括文件系统、HTTP 请求和响应、以及 TCP/UDP 连接等。流可以是可读的,可写的,或者既可读又可写。所有流都是EventEmitter的实例,因此可以产生各种不同的事件。
可读流主要会产生以下事件:
- data 当读取到流中的数据时,此事件被触发
- end 当流中没有数据可读时,此事件被触发
- error 当读取数据出现错误时,此事件被触发
- close 当流被关闭时,,此事件被触发,可是并不是所有流都会触发这个事件。(例如,一个连接进入的HTTP request流就不会触发'close'事件。)
还有一种比较特殊的 fd 事件,当在流中接收到一个文件描述符时触发此事件。只有UNIX流支持这个功能,其他类型的流均不会触发此事件。
3. socket.io(https://cnodejs.org/topic/50a1fcc7637ffa4155b5a264)
安装:npm install socket.io
利用Node的搭建Http服务,分为两个文件,服务端文件app.js和客户端index.html
app.js 01 var app = require('http').createServer(handler) 02 , io = require('socket.io').listen(app) 03 , fs = require('fs') 04 05 app.listen(80); 06 07 function handler (req, res) { 08 fs.readFile(__dirname + '/index.html', 09 function (err, data) { 10 if (err) { 11 res.writeHead(500); 12 return res.end('Error loading index.html'); 13 } 14 15 res.writeHead(200); 16 res.end(data); 17 }); 18 } 19 20 io.sockets.on('connection', function (socket) { 21 socket.emit('news', { hello: 'world' }); 22 socket.on('my other event', function (data) { 23 console.log(data); 24 }); 25 });
这里需要注意的是:
require(’socket.io').listen(app) 实际上这句就是讲socket的监听加入的app设置的http模块了
io.sockets.on(‘connection’,function()…)这里设置了在连接后进行的处理,代码示例中,主要包含两件事,一个是向前段发送news的事件,一个是监听my other event事件。
index.html 1 <script src="/socket.io/socket.io.js"></script> 2 <script> 3 var socket = io.connect('http://localhost'); 4 socket.on('news', function (data) { 5 console.log(data); 6 socket.emit('my other event', { my: 'data' }); 7 }); 8 </script>
客户端一个引用了socket.io.js的javscript库 还有就是连接服务器(通过io.connect(’http://localhost')) 之后在监听收到news的事件后,发送my other event事件
利用Express3框架 上面的例子只是使用nodejs建立了一个交互,也可以使用express2的web框架, 具体app.js代码如下:
var app = require('express')() , server = require('http').createServer(app) , io = require('socket.io').listen(server); server.listen(80); app.get('/', function (req, res) { res.sendfile(__dirname + '/index.html'); }); io.sockets.on('connection', function (socket) { socket.emit('news', { hello: 'world' }); socket.on('my other event', function (data) { console.log(data); }); });
接收发送事件
socket.io允许用户自定义发送接收的事件。除了connect,message,disconnect三个事件外,用户可以自定义自己的事件
// note, io.listen(<port>) will create a http server for you var io = require('socket.io').listen(80); io.sockets.on('connection', function (socket) { io.sockets.emit('this', { will: 'be received by everyone'}); socket.on('private message', function (from, msg) { console.log('I received a private message by ', from, ' saying ', msg); }); socket.on('disconnect', function () { io.sockets.emit('user disconnected'); }); });
存储数据
有的时候需要存储一些和客户端关联的数据在会话里,socket.io也是支持的,代码如下:
var io = require('socket.io').listen(80); io.sockets.on('connection', function (socket) { socket.on('set nickname', function (name) { socket.set('nickname', name, function () { socket.emit('ready'); }); }); socket.on('msg', function () { socket.get('nickname', function (err, name) { console.log('Chat message by ', name); }); }); });
socket.set和socket.get方法分为用于设置和获取变量。
设置命名空间
有的时候要一个程序支持多个应用,如果使用默认的 “/” 命名空间可能会比较混乱。如果想让一个连接可以支持多个连接,可以使用如下的命名空间的方法:
app.js var io = require('socket.io').listen(80); var chat = io .of('/chat') .on('connection', function (socket) { socket.emit('a message', { that: 'only' , '/chat': 'will get' }); chat.emit('a message', { everyone: 'in' , '/chat': 'will get' }); }); var news = io .of(’/news’) .on(‘connection’, function (socket) { socket.emit(‘item’, { news: ‘item’ }); });
client.js <script> var chat = io.connect('http://localhost/chat') , news = io.connect('http://localhost/news'); chat.on('connect', function () { chat.emit('hi!'); }); news.on('news', function () { news.emit('woot'); }); </script>
发送获取数据
有的时候,你需要在发送数据后,等待服务器的消息确认。当然简单的发,可以通过两次消息发送,来完成。这里介绍一种使用回调函数的方法:
app.js var io = require('socket.io').listen(80); io.sockets.on('connection', function (socket) { socket.on('ferret', function (name, fn) { fn('woot'); }); }); client.html <script> var socket = io.connect(); // TIP: .connect with no args does auto-discovery socket.on('connect', function () { // TIP: you can avoid listening on `connect` and listen on events directly too! socket.emit('ferret', 'tobi', function (data) { console.log(data); // data will be 'woot' }); }); </script>
广播
向所有的连接触发事件,这里注意:不包括本身连接的事件。
var io = require('socket.io').listen(80); io.sockets.on('connection', function (socket) { socket.broadcast.emit('user connected'); });
聊天程序(https://cnodejs.org/topic/50a1fcc7637ffa4155b5a264):
index.html <script src="/socket.io/socket.io.js"></script> <script> var socket = io.connect('http://localhost'); socket.on("notice", function(data){ var msg = document.getElementById('all').value; document.getElementById('all').innerText = msg + "\n" + data.message; }); var chat_fn = function(){ var msg = document.getElementById("message").value; socket.emit("chat", {message: msg}); }; socket.on("nickname ready", function(data){ alert("nickname changed."); }); var change_nickname = function(){ var nickname = document.getElementById("nickname").value; socket.emit('set nickname', nickname); }; </script> <textarea id="all" cols=40 rows=20></textarea> <br /> <label>Message:</label> <input id="message" type="text" name="message" cols=120/> <input id="chat_btn" type="button" value="chat" onclick="javascript:chat_fn()" /> <label>NickName:</label> <input id="nickname" typee="text" name="nickname" /> <input id="chang_name" type="button" value="nickname" onclick="javascript:change_nickname()" /> app.js var app = require('http').createServer(handler) , io = require('socket.io').listen(app) , fs = require('fs'); app.listen(80); function handler (req, res) { fs.readFile(__dirname + '/index.html', function (err, data) { if (err) { res.writeHead(500); return res.end('Error loading index.html'); } res.writeHead(200); res.end(data); }); } io.sockets.on('connection', function (socket) { // socket.emit('news', { hello: 'world' }); // socket.on('my other event', function (data) { // console.log(data); // }); socket.set('nickname', 'nickname', function(){ }); socket.on('set nickname', function(name){ socket.set('nickname', name, function(){ console.log("change nickname=>" + name); socket.emit('nickname ready'); }); }); socket.on('chat', function(data){ socket.get('nickname', function(err, name){ socket.emit("notice", {message: name + ":" + data.message}); socket.broadcast.emit("notice", {message: name + ":" + data.message}); console.log("chat: " + data.message); }); }); });