socket.io的使用

字数 1236阅读 5956

简单介绍一下如何在nodejs上使用socket.io,以下栗子来自官网,细节上有点小修改。

scoket基本知识

首先介绍一下socket的基本知识:网络上的两个程序通过一个双向的通信实现数据的交换,这个连接的一端称为一个socket(端口号),socket的本质是编程接口(API),对TCP/IP的封装TCP/IP提供程序员做网络开发时可用的接口。HTTP是轿车,提供了封装或者显示数据的具体形式;Socket是发动机,提供了网络通信的能力。

socket用于描述ip地址和端口。不同的端口对应不同的服务,每个socket都会绑定一个端口。就像插座有110伏也有220伏,插头(socket)插入(绑定)不同的编号的插座(端口),就可以得到不同的服务

socket.io

socket.io是一个实现实时web通信的JavaScript库。它包含两部分,在浏览器上运行的客户端库和在nodejs上运行的服务器端库。

ps:以下用到的fn均是Function

安装socket.io

$ npm install socket.io

在Node http server上使用,官方小栗子

服务器端
var http = require('http');
var fs = require('fs');
function onRequest(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);
  })
}

var app = http.createServer(onRequest);
var io = require('socket.io')(app);
io.on('connection', function(socket) {
  socket.emit('news', 'Hello world');
  socket.on('my other event', function(data) {
    console.log(data);
  })
})

app.listen(8001, function() {
  console.log('listen on 8001')
})
客户端
<head>
  <title>using with node http server</title>
  <script src="/socket.io/socket.io.js"></script>
  <script src="http://code.jquery.com/jquery-1.11.1.js"></script>
</head>
<body>
  <p id="msg">this is a block</p>
  <script>
    var socket = io();
    socket.on('news', function(data) {
      console.log(data);
      $('#msg').text(data)
      socket.emit('my other event', {my: 'data'})
    })
  </script>
</body>

在express框架中使用,官方小栗子

服务器端
var app = require('express')();
var http = require('http').Server(app);
var io = require('socket.io')(http);

app.get('/', function(req, res) {
  res.sendFile(__dirname + '/index.html')
})

io.on('connection', function(socket) {
  socket.emit('news', 'Hello world');
  socket.on('my other event', function(data) {
    console.log(data);
  })
})

http.listen(8001, function() {
  console.log('listen on 8001')
})
客户端

同nodeJs的客户端。

Server API

创建server

通过·require('socket.io')暴露出Server, Server创建的几种方式有以下三种,其中第一参数和第二参数都是可选项

  1. Server(): require('socket.io')();
  2. Server(opts:Object): 通过opts创建,opts包含的选项有:
    serverClient、path以及创建engine.io Server的options
  3. Server(server, opts:Object): 通过已有的http server创建新的Server
  4. Server(port, opts:Object): 通过监听的端口号创建

server的方法和属性

ps: 未注明返回值的,返回值为Server
serveClient(v:Boolean): 如果v的值是true,服务器将会对客户端文件提供服务, socket.io的客户端文件会压缩至vendor.js中,所以一般生产环境里,serveClient设置成false。

var io = require('socket.io')(httpServer, {
 serveClient: (config.env === 'production') ? false : true 
});

path(v:String): 静态文件的路径,默认/socket.io

adapter(v:Adapter):设置 rooms的适配器,默认socket.io-adapter

origin(v:String):设置默认的origins,默认所有的origins都允许

attach(server, opts:Object): 通过提供的opts,将server与提供的http server合并,返回一个新的server

attach(port:Number, opts:Object):将port和opts附着至Server上,返回新的server

sockets:返回值Namespace, 默认/

listen: 与创建该server的http server的listen方法一致

bind(srv: engine#Server): 将server绑定值一个指定的engine server上,返回新的Server

onconnection(socket: engine#socket)

of(nsp:String): 返回Namespace

use: 同Namespace的use方法

emit: 对所有连接的客户端发送一个事件

var io = require('socket.io')();
io.sockets.emit('an event sent to all connected clients');
// 等同于
io.emit('an event sent to all connected clients');

of(namespace):Namespace: 通过路径标识的nsp,初始化Namespace

Namespace

socket.io允许定义socket的namespace(命名空间),namespace意味着给socket分配不同的路径,如var socket = io('/example1');默认情况下是'/'

index.js

var ep1 = io.of('/example1');
ep1.on('connection', function(socket) {
  console.log('example1 connection')
  socket.emit('news', 'example1 connection');
})

io.on('connection', function(socket) {
  console.log('io connection')
  socket.emit('news', 'io connection');
})

index.html

 var socket = io();
 socket.on('news', function(data) {
   console.log(data);
   $('#msg').text(data)
   socket.emit('my other event', {my: 'data'})
 })

example1.html

 var socket = io('/example1');
 socket.on('news', function(data) {
   console.log(data);
   $('#msg').text(data)
   socket.emit('my other event', {my: 'data'})
 })

观察结果,
进入example1页面,会打印出example1 connection,
进入任何页面,都会打印出io connection

事件

connection/connect:连接时触发
socket:客户端返回的socket

属性

name:String:命名空间标识属性
connected:连接至这个命名空间的socket的hash值,通过id进行索引
use(fn):注册中间件fn,客户端返回socket时执行,socket和next作为这个中间件fn的参数,next的参数也是fn。

var io = require('socket.io')();
io.use(function(socket, next){
  if (socket.request.headers.cookie) return next();
  next(new Error('Authentication error'));
});

Socket

socket是通信的基础类,一个socket属于一个特定的Namespace,并且在隐藏的Client下进行通信。

rooms:Array: socket所在的rooms列表。

client:Client: 隐藏的Client。

conn:Socket: Client下正在传送连接的socket对象

request: 返回Request对象

id: socket会话的唯一标识

emit: 向特定socket发送事件

var io = require('socket.io')();
io.on('connection', function(socket){
  socket.emit('an event', { some: 'data' });
});

broadcast:向除了正在连接的socket以外的其他已经连接的socket发送事件

服务器端:

io.on('connection', function(socket) {
  client++;
  socket.broadcast.emit('newClientConnect', client + ' clients connects')
  socket.emit('newClientConnect', 'Hey, welcome');
  socket.on('disconnect', function() {
    client--;
  })
})

客户端:

 var socket = io();
 socket.on('newClientConnect', function(data) {
   console.log(data);
 })

join(name: String, fn):Socket:socket加入room时候触发,fn是callback

leave(name: String, fn:Socket:socket离开room时候触发fn是callback

to/in(room:String):Socket:为后续的emit事件做准备,只限定于加入该room的sockets

var io = require('socket.io')();
in.on('connection', function(socket) {
  socket.to('others').emit('an event', {some: 'data'});
});

Client API

Manager

一个manager代表一个给定socket.io服务器的一次连接,除非multiplex设置为false(即:强制创建新的连接),在一次连接中,可能会有多个socket,所以一个manager可能对应多个socket。

参考文献:
https://www.tutorialspoint.com/socket.io/index.htm

推荐阅读更多精彩内容