SpringBoot 使用WebSocket实现多人聊天
1.了解一下WebSocket是什么
? WebSocket 是 HTML5 开始提供的一种在单个 TCP 连接上进行全双工通讯的协议。而且只要建立一次连接即可。
简单来说 他缩减了TCP协议的步骤 我们都知道 TCP要通过三次握手四次挥手，但ws只要建立一次 即可通信。
然后我们这次使用的是SpirngBoot搭建ws服务 实现多人之间的通信。
2.导入依赖
<!--ws发送的是json字符串 所以用来解析-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.2.48</version>
</dependency>
<!-- 我是直接在resouce下的templates下测试 所以用到thymeleaf-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<!-- web包 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- ws -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
3.注册ws服务
首先要开启WebSocket支持 创建一个WebSocketConfig
@Configuration
public class WebSocketConfig {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}
注册ws服务
package com.wjb.websocket.service;
import com.alibaba.fastjson.JSONObject;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.stereotype.Service;
import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;
@Component
@Slf4j
@Service
@ServerEndpoint("/api/websocket/{sid}")
public class WebSocketServer {
//静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
private static int onlineCount = 0;
//concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。
private static CopyOnWriteArraySet<WebSocketServer> webSocketSet = new CopyOnWriteArraySet<WebSocketServer>();
//与某个客户端的连接会话，需要通过它来给客户端发送数据
private Session session;
//接收sid
private String sid = "";
/**
* 连接建立成功调用的方法
*/
@OnOpen
public void onOpen(Session session, @PathParam("sid") String sid) {
this.session = session;
//加入set容器中
webSocketSet.add(this);
this.sid = sid;
addOnlineCount();
try {
sendMessage("conn_success");
log.info("有新窗口开始监听:" + sid + ",当前在线人数为:" + getOnlineCount());
} catch (IOException e) {
log.error("websocket IO Exception");
}
}
/**
* 连接关闭调用的方法
*/
@OnClose
public void onClose() {
webSocketSet.remove(this); //从set中删除
subOnlineCount(); //在线数减1
//断开连接情况下，更新容器占用情况为释放
log.info("释放的sid为："+sid);
//这里写你 释放的时候，要处理的业务
log.info("有一连接关闭！当前在线人数为" + getOnlineCount());
}
/**
* 收到客户端消息后调用的方法
* @ Param message 客户端发送过来的消息
*/
@OnMessage
public void onMessage(String message, Session session) {
log.info("收到来自窗口" + sid + "的信息:" + message);
try {
//把消息发送当前对话的人
session.sendMessage(message);
} catch (IOException e) {
e.printStackTrace();
}
}
/**
* @ Param session
* @ Param error
*/
@OnError
public void onError(Session session, Throwable error) {
log.error("发生错误");
error.printStackTrace();
}
public static synchronized int getOnlineCount() {
return onlineCount;
}
public static synchronized void addOnlineCount() {
WebSocketServer.onlineCount++;
}
public static synchronized void subOnlineCount() {
WebSocketServer.onlineCount--;
}
public static CopyOnWriteArraySet<WebSocketServer> getWebSocketSet() {
return webSocketSet;
}
}
4.前段JS测试ws是否连通
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Java后端测试WebSocket</title>
<script type="text/javascript" src="js/jquery.js"></script>
</head>
<body>
<div id="main" style="width: 400px;height:50px;"></div>
Welcome<br/>
<input id="text" type="text"/>
<button onclick="send()">发送消息</button>
<hr/>
<button onclick="closeWebSocket()">关闭WebSocket连接</button>
<hr/>
<div id="message"></div>
</body>
<script type="text/javascript">
var websocket = null;
//判断当前浏览器是否支持WebSocket
if ('WebSocket' in window) {
//这是随机生成的id
var random = Math.ceil(Math.random()*100);
//这个ip地址改成你的地址
websocket = new WebSocket("ws://localhost:8080/api/websocket/"+random);
} else {
alert('当前浏览器 Not support websocket')
}
//连接发生错误的回调方法
websocket.onerror = function () {
setMessageInnerHTML("WebSocket连接发生错误");
};
//连接成功建立的回调方法
websocket.onopen = function () {
setMessageInnerHTML("WebSocket连接成功");
}
var U01data, Uidata, Usdata;
//接收到消息的回调方法
websocket.onmessage = function (event) {
console.log(event);
setMessageInnerHTML(event.data);
}
//连接关闭的回调方法
websocket.onclose = function () {
setMessageInnerHTML("WebSocket连接关闭");
}
//监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
window.onbeforeunload = function () {
closeWebSocket();
}
//将消息显示在网页上
function setMessageInnerHTML(innerHTML) {
document.getElementById('message').innerHTML += innerHTML + '<br/>';
}
//关闭WebSocket连接
function closeWebSocket() {
websocket.close();
}
//发送消息
function send() {
var message = document.getElementById('text').value;
websocket.send(message);
// setMessageInnerHTML(message + " ");
}
</script>
</html>
如果连接成功的话会出现：
5.编写A,B,C之间对话的逻辑
实现多人之间的对话 ，需要理解 ws中的Session ，因为每个对话都是一个Session。然后每个连接都是一个WebSocketServer服务 这里用到的是CopyOnWriteArraySet这个对象存储，这个是concurrent包下安全的Set。
所以用来存放每个客户端对应的ws对象。
理解完之后 我们需要改一下onMessage方法的逻辑。这个方法是每次有客户端发送信息都会调用这个方法。
@OnMessage
public void onMessage(String message, Session session) {
JSONObject parse = (JSONObject) JSONObject.parse(message);
System.out.println(parse);
//{"msg":"你好","id":45}
for (WebSocketServer item : webSocketSet) {
try {
System.out.println(item.sid);
//指定发送人
if (parse.getString("id").equals(item.sid))
item.sendMessage(parse.getString("msg"));
} catch (IOException e) {
e.printStackTrace();
}
}
}
根据每个人的id 找到对应的ws对象 然后通过Session发送信息。
6.最后效果
根据后台我们知道每个客户端的id号
通过id号 我们可以直接发送信息：
还可以实现更多人之间聊天，群聊，群发等 自己可以去测试。然后ws 其实还可以做很多东西 可以自己去大胆的尝试。