WebSocket实现前后端通讯
长安如梦里，何日是归期。
简介：我们上线了一个商城项目，移交运营团队使用之后，他们要求商城有新订单来的时候同时加上声音提示，让她们可以及时知道有单来了。我这边想了想，这个需求是在后端完成还是前端完成，但是仔细一想，无论是在前端还是后端完成都一样，需求注定甩不出去了，因为这个商城的后台管理没有前端工程师，前后端的工作都是一个后端工程师来完成的。这也导致前端界面很难看，包括前端代码风格~因为这是我第一次写这么多前端代码的项目~哈哈~敢让我写~我就敢写。
一、思路：
1、平台实现推送，之在前的项目有用过Ajax轮询的技术，这种方式浏览器需要不断的向服务器发出请求，会浪费很多的带宽等资源，技术可行但不太好。
2、完完全全在前端实现此需求，在前端监听订单列表中元素的变化，循环遍历订单列表监听或使用Vue的Watch监听，当订单列表有新增元素即可调用播放音效API，感觉不怎么靠谱，没去试过。
3、最终使用了Websocket实现的 ，WebSocket是HTML5开始提供的一种在单个TCP连接上进行全双工通讯的协议，能更好的节省服务器资源和带宽，并且能够更实时地进行通讯。WebSocket 使得客户端和服务器之间的数据交换变得更加简单，允许服务端主动向客户端推送数据，在WebSocket API中，浏览器和服务器只需要完成一次握手，两者之间就直接可以创建持久性的连接-长连接，并进行双向数据传输。我猜使用这个方案最重要的原因是后端开发是我更擅长的领域吧。
二、SpringBoot/SpringCloud整合WebSocket
1、引入WebSocket Jar包
在需要用到WebSocket 通信的SpringBoot 工程的pom.xml 文件中引入WebSocket Jar包。
1 <!-- test websocket -->
2 <dependency>
3 <groupId>org.springframework.boot</groupId>
4 <artifactId>spring-boot-starter-websocket</artifactId>
5 </dependency> 2、创建WebSocket 配置类
该配置类用于检测带注解@ServerEndpoint 的bean 并将它们注册到容器中。
1 package com.tjt.mall.config;
2
3 import lombok.extern.slf4j.Slf4j;
4 import org.springframework.context.annotation.Bean;
5 import org.springframework.context.annotation.Configuration;
6 import org.springframework.web.socket.server.standard.ServerEndpointExporter;
7
8
9 @Configuration
10 @Slf4j
11 public class WebSocketConfig {
12 /**
13 * 给spring容器注入这个ServerEndpointExporter对象
14 * 相当于xml：
15 * <beans>
16 * <bean />
17 * </beans>
18 * <p>
19 * 检测所有带有@serverEndpoint注解的bean并注册他们。
20 *
21 * @return
22 */
23 @Bean
24 public ServerEndpointExporter serverEndpointExporter() {
25 log.info("serverEndpointExporter被注入了");
26 return new ServerEndpointExporter();
27 }
28 }3、创建WebSocket 处理类
该WebSocket 处理类需要使用@ServerEndpoint 注解，在这个类里监听连接的建立、关闭和消息的接收等。
1 package com..mall.config;
2
3 import org.slf4j.Logger;
4 import org.slf4j.LoggerFactory;
5 import org.springframework.stereotype.Component;
6
7 import javax.annotation.PostConstruct;
8 import javax.websocket.*;
9 import javax.websocket.server.ServerEndpoint;
10 import java.io.IOException;
11 import java.util.concurrent.CopyOnWriteArraySet;
12 import java.util.concurrent.atomic.AtomicInteger;
13
14 @ServerEndpoint(value = "/ws/path/asset") // WebSocket 路径
15 @Component
16 public class WebSocketServer {
17
18 private static Logger log = LoggerFactory.getLogger(WebSocketServer.class);
19 private static final AtomicInteger OnlineCount = new AtomicInteger(0);
20 // concurrent包的线程安全Set，用来存放每个客户端对应的Session对象。
21 private static CopyOnWriteArraySet<Session> SessionSet = new CopyOnWriteArraySet<Session>();
22
23 @PostConstruct
24 public void init() {
25 log.info("websocket 加载");
26 }
27
28
29 /**
30 * 连接建立成功调用的方法
31 */
32 @OnOpen
33 public void onOpen(Session session) throws IOException{
34 SessionSet.add(session);
35 int cnt = OnlineCount.incrementAndGet(); // 在线数加1
36 log.info("有连接加入，当前连接数为：{}", cnt);
37 // SendMessage(session, "连接成功");
38 }
39
40 /**
41 * 连接关闭调用的方法
42 */
43 @OnClose
44 public void onClose(Session session) {
45 SessionSet.remove(session);
46 int cnt = OnlineCount.decrementAndGet();
47 log.info("有连接关闭，当前连接数为：{}", cnt);
48 }
49
50 /**
51 * 收到客户端消息后调用的方法
52 *
53 * @param message
54 * 客户端发送过来的消息
55 */
56 @OnMessage
57 public void onMessage(String message, Session session) throws IOException {
58 log.info("来自客户端的消息：{}",message);
59 SendMessage(session, "收到消息，消息内容："+message);
60
61 }
62
63 /**
64 * 出现错误
65 * @param session
66 * @param error
67 */
68 @OnError
69 public void onError(Session session, Throwable error) {
70 log.error("发生错误：{}，Session ID： {}",error.getMessage(),session.getId());
71 error.printStackTrace();
72 }
73
74 /**
75 * 发送消息，实践表明，每次浏览器刷新，session会发生变化。
76 * @param session
77 * @param message
78 */
79 public static void SendMessage(Session session, String message) throws IOException {
80 try {
81 // session.getBasicRemote().sendText(String.format("%s (From Server，Session ID=%s)",message,session.getId()));
82 session.getBasicRemote().sendText(message);
83 } catch (IOException e) {
84 log.error("发送消息出错：{}", e.getMessage());
85 e.printStackTrace();
86 }
87 }
88
89 /**
90 * 群发消息
91 * @param message
92 * @throws IOException
93 */
94 public static void BroadCastInfo(String message) throws IOException {
95 for (Session session : SessionSet) {
96 if(session.isOpen()){
97 SendMessage(session, message);
98 }
99 }
100 }
101
102 /**
103 * 指定Session发送消息
104 * @param sessionId
105 * @param message
106 * @throws IOException
107 */
108 public static void SendMessage(String message,String sessionId) throws IOException {
109 Session session = null;
110 for (Session s : SessionSet) {
111 if(s.getId().equals(sessionId)){
112 session = s;
113 break;
114 }
115 }
116 if(session!=null){
117 SendMessage(session, message);
118 }
119 else{
120 log.warn("没有找到你指定ID的会话：{}",sessionId);
121 }
122 }
123 }4、调用WebSocket 发送消息
在订单生成的代码后，根据需求调用WebSocket 处理类中的群发或者单独发送消息的方法。
1 log.info("购物车生成订单OK: {}", result);
2 // send webSocket message
3 WebSocketServer.BroadCastInfo("after service order"); 三、VUE整合WebSocket
在前端使用WebSocket 时还需要判断下，因为目前虽然大部分浏览器都支持WebSocket，比如Chrome、Mozilla、Opera 和Safari，但还有少部分是不支持的。
1、HTML中操作WebSocket
在html页面中建立websocket 连接，至于什么时候连接WebSocket，看个人需求吧。我是在登录成功后，也就是在登录页面的Html中连接WebSocket 并监听消息。
我把登录HTML页面中的部分代码删除了，只留下WebSocket 相关操作的和播放音效相关的代码。
1 <template>
2 <div class="dashboard-container">
3 <!-- 在div 中引入 音频资源-->
4 <audio ref="audio" src="@/assets/voice/tjtVoice.mp3"></audio>
5 </div>
6 </template>
7
8 <script>
9
10 export default {
11
12 created() {
13 this.playVoice()
14 },
15
16 methods: {
17 playVoice() {
18 var socket;
19 // 当找不到句柄对象即音频资源的时候使用 that
20 let that = this
21 if (typeof (WebSocket) == "undefined") {
22 console.log("遗憾：您的浏览器不支持WebSocket");
23 } else {
24 console.log("恭喜：您的浏览器支持WebSocket");
25 //实现化WebSocket对象
26 //指定要连接的服务器地址与端口建立连接
27 //注意ws、wss使用不同的端口。我使用自签名的证书测试，
28 //无法使用wss，浏览器打开WebSocket时报错
29 //ws对应http、wss对应https。
30 socket = new WebSocket("ws://localhost:11200/ws/path/asset");
31 //连接打开事件
32 socket.onopen = function() {
33 console.log("Socket 已打开");
34 // socket.send("消息发送测试(From Client)");
35
36 };
37 //收到消息事件
38 socket.onmessage = msg => {
39 // 当收到消息调用播放音频资源API
40 console.log(msg.data);
41 this.$refs.audio.play()
42 };
43 //连接关闭事件
44 socket.onclose = function() {
45 console.log("Socket已关闭");
46 };
47 //发生了错误事件
48 socket.onerror = function() {
49 alert("Socket发生了错误");
50 }
51 //窗口关闭时，关闭连接
52 window.unload=function() {
53 // socket.close();
54 };
55 }
56 }
57 }
58
59 }
60 </script>四、测试效果
1、启动装配有WebSocket 的SpringBoot 工程。
2、启动VUE 工程，点击登录，连接WebSocket。
后端工程控制台打印
[2021-07-07 08:45:47] [INFO ] -- 有连接加入，当前连接数为：1前端浏览器的WS 下分别显示WebSocket 连接状态：
3、模拟订单生成，在后台调用订单生成接口API 。
前端浏览器Console 打印，成功监听并节接收到后端发送的WebSocket 讯息。
4、音频试听
接收到后端发送的WebSocket 讯息，即刻播放音效。
四、音频资源
下载链接：https://pan.baidu.com/s/1rqa6Uift3RpWShPytgBLgQ
密码: 8arh
长安如梦里
何日是归期