最近要把一个即时通信部署到web端,原本要用WebSocket,之后在查找WebSocket的时候看到了Socket.IO这个东东,要比WebSocket的难度小了很多,还支持多种连接方式,于是果断换成了Socket.IO。
以下内容为个人理解,如有错误,欢迎指正。
Socket.IO封装了前端和后端的全部内容,能够很方便的开发出前后端一体的长链接的网站。这里我们主要实现的是Socket.IO的客户端部分,我们的服务端使用Java语言进行开发。
使用Socket.IO需要安装node和npm,在命令行中输入:
npm install socket.io
因为是在客户端使用Socket.IO所以我们需要在使用Scokect.IO的页面添加文件引用,引用socket.io.js
文件,这个文件我们可以选择官方提供的文件:
<script src="https://cdn.socket.io/socket.io-1.2.1.js"></script>
但是我们建议使用自己服务器上部署的版本,如果是服务端使用node.js编写使用Socket.IO实现服务端长链接功能的话,这样做能够和服务端的版本保持一致。使用自己服务端生成的文件应该这样引用文件:(socket.io.js
文件由服务端自动编译生成)
<script src="/socket.io/socket.io.js"></script>
这里由于我们的服务器是由Java编写的,所以我们引用官方提供的socket.io.js
文件。
socket.io.js
文件提供了一个全局的变量io
,通过io
我们可以对socket进行操作。
创建一个socket
创建一个socket链接,我们使用io
中的connect
方法:
var socket = io.connect('/');
socket.on('connect',function(){
//连接成功
});
socket.on('disconnect',function(data){
//连接断开
});
connect
函数可以接受一个url参数,即要建立链接的url,url可以是完整的网络路径,也可以是相对路径,也可以不传,如果是相对路径则是相对于当前页面主机的相对路径,如果未传url则是与当前页面的路径建立socket链接。
还可以使用一个更简单的方法建立链接:
var socket = io('/');
socket.on('connect',function(){
//连接成功
});
socket.on('disconnect',function(data){
//连接断开
});
使用io
直接创建的这种方式后面参数还可以传入对socket的设置:
设置参数名 | 设置参数类型 | 默认值 | 设置说明 |
---|---|---|---|
reconnection | bool | true | 是否重连 |
reconnectionDelay | int | 1000 | 多长时间后重新连接(ms) |
reconnectionDelayMax | int | 5000 | 重新连接的最大等待时间(ms) |
timeout | int | 20000 | 连接超时的时间(ms) |
设置参数采用键值对的方式进行设置。
设置中我们还可以个传递参数,比如初始化设置,个人信息等:
var socket = io.connect('/',{ _query:'sid=123456' });
监听socket
上面的创建socket连接的例子中我们已经使用了socket的监听。
socket的监听采用on
方法来实现。
on
方法有两个参数,第一个参数是要监听的事件,第二个参数是监听到事件后要执行的回调方法。
能够监听的事件有:
事件名称 | 事件说明 | 事件回调参数说明 |
---|---|---|
connect | 连接成功的事件 | 无参数 |
connect_failed | 连接失败的事件 | 参数Object,里面包含错误信息 |
disconnect | 断开连接的事件 | 无参数 |
connecting | 正在链接的事件 | 无参数 |
error | 连接错误事件处理 | |
connect_timeout | 连接超时的事件 | 无参数 |
reconnect | 成功重新连接的事件 | 参数Number,重连的次数 |
reconnecting | 正在重新连接 | 参数Number,重连的次数 |
reconnect_failed | 重新连接失败 | 无参数 |
socket发送和接受消息
socket提供TCP的消息发送和接收。
消息发送使用send
接口:
socket.send('hello world!');
消息接收需要监听message
接口
socket.on('message',function(data){
//收到消息
console.log(data);
});
消息的接收和发送建议写在connect
的事件监听器中。
socket命名空间(房间/分组)
建立链接时我们可以指定将这个socket放置在某一个路径下,这个路径下的socket将和其他路径下的socket互相不干扰。
var socket = io.connect('/chat');
这将会极大的方便服务端的广播(推送),服务端可以在特定的房间内发送广播(推送),而在其他房间内的socket则不会接收到该广播(推送)。
socket中间件
这个中间件部分将在之后进行详细讲解,现在只放置一个身份验证,如果没有cookies则抛出错误。
io.use(function(socket, next){
if (socket.request.headers.cookie) return next();
next(new Error('Authentication error'));
});
参考资料:
网友评论