文地址：https://dwz.cn/87Mq3Br1

作者：yizhiwazi

推荐WebSocket的三大理由：

• 1、采用全双工通信，摆脱传统HTTP轮询的窘境。
• 2、采用W3C国际标准，完美支持HTML5。
• 3、简单高效，容易上手。

学习目标

快速学会通过WebSocket编写简单聊天功能。

温馨提示：

1、WebSocket是HTML5开始提供的一种在单个 TCP 连接上进行全双工通讯的协议。在WebSocket API中，浏览器和服务器只需要做一个握手的动作，然后，浏览器和服务器之间就形成了一条快速通道。两者之间就直接可以数据互相传送。

2、浏览器通过 JavaScript 向服务器发出建立 WebSocket 连接的请求，连接建立以后，客户端和服务器端就可以通过 TCP 连接直接交换数据。

3、当你获取 Web Socket 连接后，你可以通过 send() 方法来向服务器发送数据，并通过 onmessage 事件来接收服务器返回的数据。

使用教程

一、打造 WebSocket 聊天客户端

温馨提示：得益于W3C国际标准的实现，我们在浏览器JS就能直接创建WebSocket对象，再通过简单的回调函数就能完成WebSocket客户端的编写，非常简单！接下来让我们一探究竟。

使用说明：

使用步骤：1、获取WebSocket客户端对象。

例如： var webSocket = new WebSocket(url);

使用步骤：2、获取WebSocket回调函数。

例如：webSocket.onmessage = function (event) {console.log('WebSocket收到消息：' + event.data);

使用步骤：3、发送消息给服务端

例如：webSokcet.send(jsonStr) 结合实际场景 本案例采用JSON字符串进行消息通信。

具体实现：

下面是本案例在线聊天的客户端实现的JS代码，附带详细注释。

<script>
 /**
 * WebSocket客户端
 *
 * 使用说明：
 * 1、WebSocket客户端通过回调函数来接收服务端消息。例如：webSocket.onmessage
 * 2、WebSocket客户端通过send方法来发送消息给服务端。例如：webSocket.send();
 */
 function getWebSocket() {
 /**
 * WebSocket客户端 PS：URL开头表示WebSocket协议 中间是域名端口 结尾是服务端映射地址
 */
 var webSocket = new WebSocket('ws://localhost:8080/chat');
 /**
 * 当服务端打开连接
 */
 webSocket.onopen = function (event) {
 console.log('WebSocket打开连接');
 };
 /**
 * 当服务端发来消息：1.广播消息 2.更新在线人数
 */
 webSocket.onmessage = function (event) {
 console.log('WebSocket收到消息：%c' + event.data, 'color:green');
 //获取服务端消息
 var message = JSON.parse(event.data) || {};
 var $messageContainer = $('.message-container');
 //喉咙发炎
 if (message.type === 'SPEAK') {
 $messageContainer.append(
 '<div class="mdui-card" style="margin: 10px 0;">' +
 '<div class="mdui-card-primary">' +
 '<div class="mdui-card-content message-content">' + message.username + "：" + message.msg + '</div>' +
 '</div></div>');
 }
 $('.chat-num').text(message.onlineCount);
 //防止刷屏
 var $cards = $messageContainer.children('.mdui-card:visible').toArray();
 if ($cards.length > 5) {
 $cards.forEach(function (item, index) {
 index < $cards.length - 5 && $(item).slideUp('fast');
 });
 }
 };
 /**
 * 关闭连接
 */
 webSocket.onclose = function (event) {
 console.log('WebSocket关闭连接');
 };
 /**
 * 通信失败
 */
 webSocket.onerror = function (event) {
 console.log('WebSocket发生异常');
 };
 return webSocket;
 }
 var webSocket = getWebSocket();
 /**
 * 通过WebSocket对象发送消息给服务端
 */
 function sendMsgToServer() {
 var $message = $('#msg');
 if ($message.val()) {
 webSocket.send(JSON.stringify({username: $('#username').text(), msg: $message.val()}));
 $message.val(null);
 }
 }
 /**
 * 清屏
 */
 function clearMsg(){
 $(".message-container").empty();
 }
 /**
 * 使用ENTER发送消息
 */
 document.onkeydown = function (event) {
 var e = event || window.event || arguments.callee.caller.arguments[0];
 e.keyCode === 13 && sendMsgToServer();
 };
</script>

========================================================================

二、打造 WebSocket 聊天服务端

温馨提示：得益于SpringBoot提供的自动配置，我们只需要通过简单注解@ServerEndpoint就就能创建WebSocket服务端，再通过简单的回调函数就能完成WebSocket服务端的编写，比起客户端的使用同样非常简单！

使用说明：

首先在POM文件引入spring-boot-starter-websocket 、thymeleaf 、FastJson等依赖。

使用步骤：1、开启WebSocket服务端的自动注册。

【这里需要特别提醒：ServerEndpointExporter 是由Spring官方提供的标准实现，用于扫描ServerEndpointConfig配置类和@ServerEndpoint注解实例。使用规则也很简单：1.如果使用默认的嵌入式容器 比如Tomcat 则必须手工在上下文提供ServerEndpointExporter。2. 如果使用外部容器部署war包，则不要提供提供ServerEndpointExporter，因为此时SpringBoot默认将扫描服务端的行为交给外部容器处理。】

@Configuration
public class WebSocketConfig {
 @Bean
 public ServerEndpointExporter serverEndpointExporter() {
 return new ServerEndpointExporter();
 }
}

使用步骤：2、创建WebSocket服务端。

核心思路：

• ① 通过注解@ServerEndpoint来声明实例化WebSocket服务端。
• ② 通过注解@OnOpen、@OnMessage、@OnClose、@OnError 来声明回调函数。

• ③ 通过ConcurrentHashMap保存全部在线会话对象。

@Component
@ServerEndpoint("/chat")//标记此类为服务端
public class WebSocketChatServer {
 /**
 * 全部在线会话 PS: 基于场景考虑 这里使用线程安全的Map存储会话对象。
 */
 private static Map<String, Session> onlineSessions = new ConcurrentHashMap<>();
 /**
 * 当客户端打开连接：1.添加会话对象 2.更新在线人数
 */
 @OnOpen
 public void onOpen(Session session) {
 onlineSessions.put(session.getId(), session);
 sendMessageToAll(Message.jsonStr(Message.ENTER, "", "", onlineSessions.size()));
 }
 /**
 * 当客户端发送消息：1.获取它的用户名和消息 2.发送消息给所有人
 * <p>
 * PS: 这里约定传递的消息为JSON字符串 方便传递更多参数！
 */
 @OnMessage
 public void onMessage(Session session, String jsonStr) {
 Message message = JSON.parseObject(jsonStr, Message.class);
 sendMessageToAll(Message.jsonStr(Message.SPEAK, message.getUsername(), message.getMsg(), onlineSessions.size()));
 }
 /**
 * 当关闭连接：1.移除会话对象 2.更新在线人数
 */
 @OnClose
 public void onClose(Session session) {
 onlineSessions.remove(session.getId());
 sendMessageToAll(Message.jsonStr(Message.QUIT, "", "下线了！", onlineSessions.size()));
 }
 /**
 * 当通信发生异常：打印错误日志
 */
 @OnError
 public void onError(Session session, Throwable error) {
 error.printStackTrace();
 }
 /**
 * 公共方法：发送信息给所有人
 */
 private static void sendMessageToAll(String msg) {
 onlineSessions.forEach((id, session) -> {
 try {
 session.getBasicRemote().sendText(msg);
 } catch (IOException e) {
 e.printStackTrace();
 }
 });
 }
}

• ④ 通过会话对象 javax.websocket.Session 来发消息给客户端。

/**
 * WebSocket 聊天消息类
 */
package com.hehe.chat;
import com.alibaba.fastjson.JSON;
/**
 * WebSocket 聊天消息类
 */
public class Message {
 public static final String ENTER = "ENTER";
 public static final String SPEAK = "SPEAK";
 public static final String QUIT = "QUIT";
 private String type;//消息类型
 private String username; //发送人
 private String msg; //发送消息
 private int onlineCount; //在线用户数
 public static String jsonStr(String type, String username, String msg, int onlineTotal) {
 return JSON.toJSONString(new Message(type, username, msg, onlineTotal));
 }
 public Message(String type, String username, String msg, int onlineCount) {
 this.type = type;
 this.username = username;
 this.msg = msg;
 this.onlineCount = onlineCount;
 }
 //这里省略get/set方法 请自行补充
}

三、WebSocket在线聊天案例的视频演示

1、源码下载

至此，我们完成了客户端和服务端的编码，由于篇幅有限，本教程的页面代码并未完整贴上，想要完整的体验效果请在Github下载源码。

2、视频演示

上面一顿操作猛如虎，实际到底是啥样子呢，接下来由哈士奇童鞋为我们演示最终版的在线聊天案例：

四、全文总结

1、使用WebSocket用于实时双向通讯的场景，常见的如聊天室、跨系统消息推送等。

2、创建WebSocket客户端使用JS内置对象+回调函数+send方法发送消息。

3、创建WebSocket服务端使用注解声明实例+使用注解声明回调方法+使用Session发送消息。

们使用springboot和webSocket结合来编写聊天室。

首先先了解下什么是WebSocket

WebSocket 是什么？

WebSocket 是一种网络通信协议。RFC6455 定义了它的通信标准。WebSocket 是 HTML5 开始提供的一种在单个 TCP 连接上进行全双工通讯的协议。

为什么需要 WebSocket ？

了解计算机网络协议的人，应该都知道：HTTP 协议是一种无状态的、无连接的、单向的应用层协议。它采用了请求/响应模型。通信请求只能由客户端发起，服务端对请求做出应答处理。这种通信模型有一个弊端：HTTP 协议无法实现服务器主动向客户端发起消息。这种单向请求的特点，注定了如果服务器有连续的状态变化，客户端要获知就非常麻烦。大多数 Web 应用程序将通过频繁的异步JavaScript和XML（AJAX）请求实现长轮询。轮询的效率低，非常浪费资源（因为必须不停连接，或者 HTTP 连接始终打开）。因此，工程师们一直在思考，有没有更好的方法。WebSocket 就是这样发明的。WebSocket 连接允许客户端和服务器之间进行全双工通信，以便任一方都可以通过建立的连接将数据推送到另一端。WebSocket 只需要建立一次连接，就可以一直保持连接状态。这相比于轮询方式的不停建立连接显然效率要大大提高。

WebSocket 如何工作？

Web浏览器和服务器都必须实现 WebSockets 协议来建立和维护连接。由于 WebSockets 连接长期存在，与典型的HTTP连接不同，对服务器有重要的影响。基于多线程或多进程的服务器无法适用于 WebSockets，因为它旨在打开连接，尽可能快地处理请求，然后关闭连接。任何实际的 WebSockets 服务器端实现都需要一个异步服务器。

一.使用idea创建springboot项目

如果不使用上述方法导入maven的 请使用

<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
 <groupId>org.springframework.boot</groupId>
 <artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

二.spring注入bean

package com.example.websocket.demo;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
@Configuration
public class WebSocketConfig {
 @Bean
 public ServerEndpointExporter serverEndpointExporter() {
 return new ServerEndpointExporter();
 }
}

三.编写websocket服务类

package com.cloudkd.websocket;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;
import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.ServerEndpoint;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
//@ServerEndpoint("/websocket/{user}")
@ServerEndpoint("/websocket")
@Component
public class WebSocketServer {
 private static final Logger log = LoggerFactory.getLogger(WebSocketServer.class);
 //静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
 private static int onlineCount = 0;
 //concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。
 private static CopyOnWriteArraySet<WebSocketServer> webSocketSet = new CopyOnWriteArraySet<WebSocketServer>();
 //与某个客户端的连接会话，需要通过它来给客户端发送数据
 private Session session;
 /**
 * 连接建立成功调用的方法
 */
 @OnOpen
 public void onOpen(Session session) {
 this.session = session;
 //加入set中
 webSocketSet.add(this);
 //在线数加1
 addOnlineCount();
 log.info("有新连接加入！当前在线人数为" + getOnlineCount());
 try {
 sendMessage("连接成功");
 } catch (IOException e) {
 log.error("websocket IO异常");
 }
 }
 // //连接打开时执行
 // @OnOpen
 // public void onOpen(@PathParam("user") String user, Session session) {
 // currentUser = user;
 // System.out.println("Connected ... " + session.getId());
 // }
 /**
 * 连接关闭调用的方法
 */
 @OnClose
 public void onClose() {
 webSocketSet.remove(this); //从set中删除
 subOnlineCount(); //在线数减1
 log.info("有一连接关闭！当前在线人数为" + getOnlineCount());
 }
 /**
 * 收到客户端消息后调用的方法
 *
 * @param message 客户端发送过来的消息
 */
 @OnMessage
 public void onMessage(String message, Session session) {
 log.info("来自客户端的消息:" + message);
 //群发消息
 for (WebSocketServer item : webSocketSet) {
 try {
 item.sendMessage(message);
 } catch (IOException e) {
 e.printStackTrace();
 }
 }
 }
 /**
 * @param session
 * @param error
 */
 @OnError
 public void onError(Session session, Throwable error) {
 log.error("发生错误");
 error.printStackTrace();
 }
 public void sendMessage(String message) throws IOException {
 this.session.getBasicRemote().sendText(message);
 }
 /**
 * 群发自定义消息
 */
 public static void sendInfo(String message) {
 log.info(message);
 for (WebSocketServer item : webSocketSet) {
 try {
 item.sendMessage(message);
 } catch (IOException ignored) {
 }
 }
 }
 private static synchronized int getOnlineCount() {
 return onlineCount;
 }
 private static synchronized void addOnlineCount() {
 WebSocketServer.onlineCount++;
 }
 private static synchronized void subOnlineCount() {
 WebSocketServer.onlineCount--;
 }
}

四.编写一个前端客户端

图中位置创建一个简单的index.html页面

<!DOCTYPE html>
<html lang="en">
<head>
 <meta charset="UTF-8">
 <title>Title</title>
 <script>
 var websocket = null;
 //判断当前浏览器是否支持WebSocket
 if ('WebSocket' in window) {
//这里ws://192.168.1.111:8080/websocket 写自己的ip和端口号
 websocket = new WebSocket("ws://192.168.1.111:8080/websocket");
 }
 else {
 alert('Not support websocket')
 }
 //连接发生错误的回调方法
 websocket.onerror = function () {
 setMessageInnerHTML("error");
 };
 //连接成功建立的回调方法
 websocket.onopen = function (event) {
 setMessageInnerHTML("open");
 }
 //接收到消息的回调方法
 websocket.onmessage = function (event) {
 setMessageInnerHTML(event.data);
 }
 //连接关闭的回调方法
 websocket.onclose = function () {
 setMessageInnerHTML("close");
 }
 //监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
 window.onbeforeunload = function () {
 websocket.close();
 }
 //将消息显示在网页上
 function setMessageInnerHTML(innerHTML) {
 document.getElementById('message').innerHTML += innerHTML + '<br/>';
 }
 //关闭连接
 function closeWebSocket() {
 websocket.close();
 }
 //发送消息
 function send() {
 var message = document.getElementById('text').value;
 websocket.send(message);
 }
 </script>
</head>
<body>
 <h3>Welcome</h3><br/>
 <input id="text" type="text"/>
 <button onclick="send()">Send</button>
 <button onclick="closeWebSocket()">Close</button>
 <div id="message"></div>
</body>
</html>

五.启动项目,做个测试.

点击启动项目

Ok启动完成

访问index.html测试一下

Ok成功启动

后台日志也有记录

说个话试试

也可以多开几个页面测试下.

Ok可以了. 下面完来完成服务端向客户端推消息

六.服务端向客户端推消息(后台主动)

产生一个消息：产生消息场景有多种，http（s），定时任务，mq等，这里我用一个http请求的controller代码完成

编写一个pushWebController类

package com.example.websocket.demo;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import java.util.HashMap;
import java.util.Map;
@RestController
public class PushWebController {
 private final Logger logger = LoggerFactory.getLogger(this.getClass());
 @GetMapping(value = "/pushWeb")
 public Map<String, Object> pushVideoListToWeb(String message) {
 Map<String, Object> result = new HashMap<String, Object>();
 try {
 WebSocketServer.sendInfo("有新客户呼入,message:" + message);
 result.put("operationResult", true);
 } catch (Exception e) {
 result.put("operationResult", true);
 }
 return result;
 }
}

重新启动项目.测试下

成功了

到此位置. demo已经成功实现了. 自己感受下乐趣把.

如果你恰好也有可以用WebSocket实现的类似场景，希望对你有帮助。

Github地址:https://github.com/liangyisen/springboot_websocket