Node.js实现WebSocket聊天室的例子

对于聊天室，大家应该都不陌生，笔者也写过很多关于聊天室的例子。

本节，我们将演示如何通过Node.js来实现一个WebSocket聊天服务器的例子。

使用ws创建WebSokcet服务器

Node.js原生API并未提供WebSocket的支持，因此，需要安装第三方包才能使用WebSocket功能。对于WebSocket的支持，在开源社区有非常多的选择，本例子采用的是“ws”框架（项目主页为https://github.com/websockets/ws）。

“ws”顾名思义是一个用于支持WebSocket客户端和服务器的框架。它易于使用，功能强大，且不依赖于其他环境。

想其他Node.js应用一样，使用ws的首选方式是使用npm来管理。以下命令行用于安装ws在应用里面：

npm install ws

具备了ws包之后，就可以创建WebSocket服务器了。以下是创建服务器的j简单示例：

1const WebSocket = require('ws');
2
3const server = new WebSocket.Server({ port: 8080 });

上述例子服务器启动在8080端口。

聊天服务器的需求

聊天服务器的业务需求比较简单，是一个群聊聊天室。换言之，所有人发送的消息大家都可以见到。

当有新用户连接到服务器时，会以该用户的“IP+端口”作为用户的名称。

服务器的实现

根据前面知识的学习，实现一个聊天服务器比较简单，完整代码如下：

1const WebSocket = require('ws');
2
3const server = new WebSocket.Server({ port: 8080 });
4
5server.on('open', function open() {
6  console.log('connected');
7});
8
9server.on('close', function close() {
10  console.log('disconnected');
11});
12
13server.on('connection', function connection(ws, req) {
14  const ip = req.connection.remoteAddress;
15  const port = req.connection.remotePort;
16  const clientName = ip + port;
17
18  console.log('%s is connected', clientName)
19
20  // 发送欢迎信息给客户端
21  ws.send("Welcome " + clientName);
22
23  ws.on('message', function incoming(message) {
24    console.log('received: %s from %s', message, clientName);
25    
26    // 广播消息给所有客户端
27    server.clients.forEach(function each(client) {
28      if (client.readyState === WebSocket.OPEN) {
29        client.send( clientName + " -> " + message);
30      }
31    });
32
33  });
34
35});

当客户端给服务器发送消息时，服务器会将该客户端的消息转发给所有客户端。

客户端的实现

客户端是通HTML+JavaScript的方式实现的。由于浏览器原生提供了WebSocket的API，所以并不需要ws框架的支持。

客户端client.html文件代码如下：

1<!DOCTYPE html>
2<html>
3
4<head>
5	<meta charset="UTF-8">
6	<title>WebSocket Chat</title>
7</head>
8
9<body>
10	<script type="text/javascript">
11		var socket;
12		if (!window.WebSocket) {
13			window.WebSocket = window.MozWebSocket;
14		}
15		if (window.WebSocket) {
16			socket = new WebSocket("ws://localhost:8080/ws");
17			socket.onmessage = function (event) {
18				var ta = document.getElementById('responseText');
19				ta.value = ta.value + '\n' + event.data
20			};
21			socket.onopen = function (event) {
22				var ta = document.getElementById('responseText');
23				ta.value = "连接开启!";
24			};
25			socket.onclose = function (event) {
26				var ta = document.getElementById('responseText');
27				ta.value = ta.value + "连接被关闭";
28			};
29		} else {
30			alert("你的浏览器不支持 WebSocket！");
31		}
32
33		function send(message) {
34			if (!window.WebSocket) {
35				return;
36			}
37			if (socket.readyState == WebSocket.OPEN) {
38				socket.send(message);
39			} else {
40				alert("连接没有开启.");
41			}
42		}
43	</script>
44	<form onsubmit="return false;">
45		<h3>WebSocket 聊天室：</h3>
46		<textarea id="responseText" style="width: 500px; height: 300px;"></textarea>
47		<br>
48		<input type="text" name="message" style="width: 300px" value="Welcome to waylau.com">
49		<input type="button" value="发送消息" onclick="send(this.form.message.value)">
50		<input type="button" onclick="javascript:document.getElementById('responseText').value=''" 
51			value="清空聊天记录">
52	</form>
53	<br>
54	<br>
55	<a href="https://waylau.com/">更多例子请访问 waylau.com</a>
56</body>
57
58</html>

运行应用

首先启动服务器。执行下面的命令：

node index.js

接着用浏览器直接打开client.html文件，可以看到如下的聊天界面。

聊天界面

打开多个聊天窗口，就能模拟多个用户之间的群聊了。

群聊界面

源码

本节例子可以在https://github.com/waylau/nodejs-book-samples的“ws-demo”应用中找到。

本节例子可以在“ws-demo”应用中找到。

参考引用

本文同步至: https://waylau.com/node.js-websocket-chat/
MINA 实现聊天功能: https://waylau.com/mina-chat/
Netty 实现 WebSocket 聊天功能: https://waylau.com/netty-websocket-chat/
Netty 实现聊天功能: https://waylau.com/netty-chat/
WebSocket 和 Golang 实现聊天功能: https://waylau.com/go-websocket-chat/