WebRTC实时通信系列教程7 使用Socket.IO搭建信令服务器交换信息

àì夳堔傛蜴生んèń 2022-05-17 11:57 204阅读 0赞

转载地址：[https://blog.csdn.net/leytton/article/details/76831005][https_blog.csdn.net_leytton_article_details_76831005]

## 1、你将学到 ##

*  使用 npm 安装 package.json文件里的项目依赖
 *  运行Node服务器并使用node-static模块支持静态资源文件访问.
 *  使用 socket.io 在Node上提供消息传输服务.
 *  创建房间并传输消息.

完整示例代码在 step-04 目录下.

## 2、概念 ##

为了建立并维持WebRTC通话, WebRTC 客户端 (peers)之间需要交换元数据:

*  Candidate (network) 信息.
 *  Offer 和 answer 消息提供媒体的信息,如分辨率和编解码器。

也就是说, 在点对点之间传输音视频和数据之前需要交换元数据. 这一过程叫做信令交换(signaling).

在前面的小节中, RTCPeerConnection 对象之间发送和接收数据是在同一页面, 所以信令交换只需要对象之间赋值就实现了元数据传递.

但在实际应用当中, RTCPeerConnections的发送端和接收端是不同的设备, 所以我们需要一种方法在其之间交换元数据.

在这里,我们使用了信令服务器(signaling server): 一个能使WebRTC客户端(peers)之间交换信息的服务器.这些消息是纯文本信息: 序列化的 JavaScript对象.

## 3、关于应用 ##

在这节中我们将建立一个简单的 Node.js 信令服务器, 使用 Socket.IO 模块和 JavaScript 库进行通信.学会 Node.js 和 Socket.IO 的使用是很有用的, 但在这里不是主要的; 这个消息组件很简单.

选择合适的信令服务器

这里使用 [Socket.IO][] 创建信令服务器.

使用Socket.io能够非常简单地创建消息通信服务, 并且Socket.io 非常适合 WebRTC 信令交换因为它内置了房间('rooms')概念.

生产使用时可能有更好地选择. 另阅 [How to Select a Signaling Protocol for Your Next WebRTC Project][].

在代码中, Node应用服务端代码在index.js文件中实现, Web客户端代码在 index.html 文件中实现.

Node应用需要实现两个功能.

首先, 它能够进行消息传递:

1.  `socket.on('message', function (message) {`
2.  `log('Got message: ', message);`
3.  `socket.broadcast.emit('message', message);`
4.  `});`

其次, 它能管理WebRTC视频聊天房间:

1.  `if (numClients === 1) {`
2.  `socket.join(room);`
3.  `socket.emit('created', room, socket.id);`
4.  `} else if (numClients === 2) {`
5.  `socket.join(room);`
6.  `socket.emit('joined', room, socket.id);`
7.  `io.sockets.in(room).emit('ready');`
8.  `} else { // max two clients`
9.  `socket.emit('full', room);`
10. `}`

我们这个简单的WebRTC应用中最多允许两个客户端在同一房间中.

## 4、HTML和JavaScript代码 ##

index.html文件代码:

1.  `<!DOCTYPE html>`
2.  `<html>`
3.  
4.  `<head>`
5.  
6.  `<title>Realtime communication with WebRTC</title>`
7.  
8.  `<link rel="stylesheet" href="css/main.css" />`
9.  
10. `</head>`
11. 
12. `<body>`
13. 
14. `<h1>Realtime communication with WebRTC</h1>`
15. 
16. `<script src="/socket.io/socket.io.js"></script>`
17. `<script src="js/main.js"></script>`
18. 
19. `</body>`
20. 
21. `</html>`
22.

你在页面上看不到任何信息: 浏览器控制台会有日志输出.

js/main.js 文件代码:

1.  `'use strict';`
2.  
3.  `var isInitiator;`
4.  
5.  `window.room = prompt("Enter room name:");`
6.  
7.  `var socket = io.connect();`
8.  
9.  `if (room !== "") {`
10. `console.log('Message from client: Asking to join room ' + room);`
11. `socket.emit('create or join', room);`
12. `}`
13. 
14. `socket.on('created', function(room, clientId) {`
15. `isInitiator = true;`
16. `});`
17. 
18. `socket.on('full', function(room) {`
19. `console.log('Message from client: Room ' + room + ' is full :^(');`
20. `});`
21. 
22. `socket.on('ipaddr', function(ipaddr) {`
23. `console.log('Message from client: Server IP address is ' + ipaddr);`
24. `});`
25. 
26. `socket.on('joined', function(room, clientId) {`
27. `isInitiator = false;`
28. `});`
29. 
30. `socket.on('log', function(array) {`
31. `console.log.apply(console, array);`
32. `});`

##    5、在Node服务器运行Socket.IO ##

在 work 根目录下创建文件 package.json :

{
      "name": "webrtc-codelab",
      "version": "0.0.1",
      "description": "WebRTC codelab",
      "dependencies": {
        "node-static": "0.7.7",
        "socket.io": "1.2.0"
      }
    }

这是一个应用程序清单,告诉Node包管理器(npm)要安装的项目依赖。

在 work 目录下使用以下命令行即可安装项目依赖:

npm install

安装结束后你将看到一下日志:

![SouthEast][]

正如你所看到的, `npm` 已经把 package.json 文件里定义的项目依赖安装好了.

可能会有警告信息, 但如果有红色的错误信息,可以寻求帮助!

在 work 根目录下创建文件 index.js :(注意不是在js目录中)

1.  `'use strict';`
2.  
3.  `var os = require('os');`
4.  `var nodeStatic = require('node-static');`
5.  `var http = require('http');`
6.  `var socketIO = require('socket.io');`
7.  
8.  `var fileServer = new(nodeStatic.Server)();`
9.  `var app = http.createServer(function(req, res) {`
10. `fileServer.serve(req, res);`
11. `}).listen(8080);`
12. 
13. `var io = socketIO.listen(app);`
14. `io.sockets.on('connection', function(socket) {`
15. 
16. `// convenience function to log server messages on the client`
17. `function log() {`
18. `var array = ['Message from server:'];`
19. `array.push.apply(array, arguments);`
20. `socket.emit('log', array);`
21. `}`
22. 
23. `socket.on('message', function(message) {`
24. `log('Client said: ', message);`
25. `// for a real app, would be room-only (not broadcast)`
26. `socket.broadcast.emit('message', message);`
27. `});`
28. 
29. `socket.on('create or join', function(room) {`
30. `log('Received request to create or join room ' + room);`
31. 
32. `var numClients = io.sockets.sockets.length;`
33. `log('Room ' + room + ' now has ' + numClients + ' client(s)');`
34. 
35. `if (numClients === 1) {`
36. `socket.join(room);`
37. `log('Client ID ' + socket.id + ' created room ' + room);`
38. `socket.emit('created', room, socket.id);`
39. 
40. `} else if (numClients === 2) {`
41. `log('Client ID ' + socket.id + ' joined room ' + room);`
42. `io.sockets.in(room).emit('join', room);`
43. `socket.join(room);`
44. `socket.emit('joined', room, socket.id);`
45. `io.sockets.in(room).emit('ready');`
46. `} else { // max two clients`
47. `socket.emit('full', room);`
48. `}`
49. `});`
50. 
51. `socket.on('ipaddr', function() {`
52. `var ifaces = os.networkInterfaces();`
53. `for (var dev in ifaces) {`
54. `ifaces[dev].forEach(function(details) {`
55. `if (details.family === 'IPv4' && details.address !== '127.0.0.1') {`
56. `socket.emit('ipaddr', details.address);`
57. `}`
58. `});`
59. `}`
60. `});`
61. 
62. `});`

在 work 目录下使用以下命令行:

node index.js

在浏览器打开 localhost:8080.

每次你打开这个URL地址, 将被提示输入一个房间名称. 要加入同一个房间,每次选择同一个房间名称,如“foo”.

打开新标签, 再次访问 localhost:8080 . 选择相同的房间名.

在第三个标签中打开 localhost:8080 . 再次选择相同的房间名.

检查每个标签的控制台: 你将会看到上述 JavaScript 代码打印的日志.

## 6、拓展 ##

1.  我们可以选择哪些消息传递机制? 使用纯WebSocket会遇到哪些问题?
2.  如果要扩展这个应用会遇到哪些问题? 你能开发一种方法来测试数以千计甚至数以百万计的同时房间请求吗?
3.  这个应用使用JavaScript提示输入房间名. 找到一种方法从URL地址来获取房间名. 例如从 *localhost:8080/foo* 获取房间名`foo`.

## 7、你学习了 ##

完整示例代码在 step-04 目录下.

## 8、更多资料 ##

*  [Socket.io chat-example repo][]
 *  [WebRTC in the real world: STUN, TURN and signaling][WebRTC in the real world_ STUN_ TURN and signaling]
 *  [The term 'signaling' in WebRTC][The term _signaling_ in WebRTC]

## 9、下一节 ##

使用信令传输让两个用户建立P2P连接.

[https_blog.csdn.net_leytton_article_details_76831005]: https://blog.csdn.net/leytton/article/details/76831005
[Socket.IO]: http://socket.io/
[How to Select a Signaling Protocol for Your Next WebRTC Project]: https://bloggeek.me/siganling-protocol-webrtc/
[SouthEast]: /images/20220517/eaaf659b5d7d419c8c4305c2a5bbc2fa.png
[Socket.io chat-example repo]: https://github.com/rauchg/chat-example
[WebRTC in the real world_ STUN_ TURN and signaling]: http://www.html5rocks.com/en/tutorials/webrtc/infrastructure/
[The term _signaling_ in WebRTC]: https://www.webrtc-experiment.com/docs/WebRTC-Signaling-Concepts.html