SpringBoot整合webSocket
小伙伴们，周一快乐。悄悄告诉大家一个好消息，还有四天就放假了。。惊不惊喜 意不意外
今天大Boss找我，小优呀，给你一个需求：用户在app填写完信息然后推送给管理员Pc端。 我问Boss就这么简单？Boos说就是这么简单，你要考虑程序性能，推送的数据准确性。
突然脑子复现了两个思路方式：
A：app和Pc公用一个数据库，前段设置一个定时，每一秒轮循查询。
B：在pc加一个刷新按钮，一直人工刷新。。洗刷洗刷~
我就去和大Boss沟通方案，他说两个都不行。回去重新想方案。
太难了，想破脑子也想不到啊，算了对于我这种面向百度开发的高级程序员来说。先问问度娘吧。
度娘告诉我好多种方式：
1.Ajax轮循
优点：客户端很容易实现良好的错误处理系统和超时管理，实现成本与Ajax轮询的方式类似。
缺点:需要服务器端有特殊的功能来临时挂起连接。当客户端发起的连接较多时，服务器端会长期保持多个连接，具有一定的风险。
- 基于 Iframe 及 htmlfile 的流（streaming）方式 俗称长连接。
优点： 实时性好（消息延时小）；性能好（能支持大量用户）
缺点： 长期占用连接，丧失了无状态高并发的特点。
- websocket方式
优点：
1、 较少的控制开销。在连接创建后，服务器和客户端之间交换数据时，用于协议控制的数据包头部相对较小。在不包含扩展的情况下，对于服务器到客户端的内容，此头部大小只有2至10字节（和数据包长度有关）；对于客户端到服务器的内容，此头部还需要加上额外的4字节的掩码。相对于HTTP请求每次都要携带完整的头部，此项开销显著减少了。
2、更强的实时性。由于协议是全双工的，所以服务器可以随时主动给客户端下发数据。相对于HTTP请求需要等待客户端发起请求服务端才能响应，延迟明显更少；即使是和Comet等类似的长轮询比较，其也能在短时间内更多次地传递数据。
3、保持连接状态。与HTTP不同的是，Websocket需要先创建连接，这就使得其成为一种有状态的协议，之后通信时可以省略部分状态信息。而HTTP请求可能需要在每个请求都携带状态信息（如身份认证等）。
4、更好的二进制支持。Websocket定义了二进制帧，相对HTTP，可以更轻松地处理二进制内容。
5、可以支持扩展。Websocket定义了扩展，用户可以扩展协议、实现部分自定义的子协议。如部分浏览器支持压缩等。
6、更好的压缩效果。相对于HTTP压缩，Websocket在适当的扩展支持下，可以沿用之前内容的上下文，在传递类似的数据时，可以显著地提高压缩率。
缺点：不支持低版本的IE浏览器
经老夫掐指一算，小优肯定会选择webSocket
今天就和大家一起学习SpringBoot整合webSocket 一对一发送消息，一对多发送消息，服务器主动推送消息。
什么是webSocket？
对于上面的小优的业务，我给大家画一个牛成图。hiahia~~ 可以参考看看哈。
不知道大家能不能看懂。再给大家写一个word版本的流程图：
好了，废话少说现在SpringBoot和WebSocket集成 上代码：
①、工程目录：
②、pom文件：
pom.xml文件：
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.6.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>cn.cnbuilder</groupId>
<artifactId>websocket</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>websocket</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<!--SpringBootWeb包-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<!--webSocketjar-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
<!--访问接口跳转templates目录下的html 必须加-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
</dependencies>
<!--打包-->
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
③、webSocket配置文件：
WebSocketConfig：
package cn.cnbuilder.websocket.config;
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连接信息配置：
ProductWebSocket：
package cn.cnbuilder.websocket;
import org.springframework.stereotype.Component;
import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.concurrent.ConcurrentHashMap;
/**
* @ServerEndpoint 注解是一个类层次的注解，它的功能主要是将目前的类定义成一个websocket服务器端,
* 注解的值将被用于监听用户连接的终端访问URL地址,客户端可以通过这个URL来连接到WebSocket服务器端
* @ServerEndpoint 可以把当前类变成websocket服务类
*/
@ServerEndpoint("/websocket/{userId}")
@Component
public class ProductWebSocket {
//静态变量，用来记录当前在线连接数。应该把它设计成线程安全的。
private static int onlineCount = 0;
//concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。若要实现服务端与单一客户端通信的话，可以使用Map来存放，其中Key可以为用户id
private static ConcurrentHashMap<String, ProductWebSocket> webSocketSet = new ConcurrentHashMap<String, ProductWebSocket>();
//与某个客户端的连接会话，需要通过它来给客户端发送数据
private Session session;
//当前发消息的人员编号
private String userId = "";
/**
* 线程安全的统计在线人数
*
* @return
*/
public static synchronized int getOnlineCount() {
return onlineCount;
}
public static synchronized void addOnlineCount() {
ProductWebSocket.onlineCount++;
}
public static synchronized void subOnlineCount() {
ProductWebSocket.onlineCount--;
}
/**
* 连接建立成功调用的方法
*
* @param param 用户唯一标示
* @param session 可选的参数。session为与某个客户端的连接会话，需要通过它来给客户端发送数据
*/
@OnOpen
public void onOpen(@PathParam(value = "userId") String param, Session session) {
userId = param;//接收到发送消息的人员编号
this.session = session;
webSocketSet.put(param, this);//加入线程安全map中
addOnlineCount(); //在线数加1
System.out.println("用户id：" + param + "加入连接！当前在线人数为" + getOnlineCount());
}
/**
* 连接关闭调用的方法
*/
@OnClose
public void onClose() {
if (!userId.equals("")) {
webSocketSet.remove(userId); //根据用户id从ma中删除
subOnlineCount(); //在线数减1
System.out.println("用户id：" + userId + "关闭连接！当前在线人数为" + getOnlineCount());
}
}
/**
* 收到客户端消息后调用的方法
*
* @param message 客户端发送过来的消息
* @param session 可选的参数
*/
@OnMessage
public void onMessage(String message, Session session) {
System.out.println("来自客户端的消息:" + message);
//要发送人的用户uuid
String sendUserId = message.split(",")[1];
//发送的信息
String sendMessage = message.split(",")[0];
//给指定的人发消息
sendToUser(sendUserId, sendMessage);
}
/**
* 给指定的人发送消息
*
* @param message
*/
public void sendToUser(String sendUserId, String message) {
try {
if (webSocketSet.get(sendUserId) != null) {
webSocketSet.get(sendUserId).sendMessage(userId + "给我发来消息，消息内容为--->>" + message);
} else {
if (webSocketSet.get(userId) != null) {
webSocketSet.get(userId).sendMessage("用户id：" + sendUserId + "以离线，未收到您的信息！");
}
System.out.println("消息接受人:" + sendUserId + "已经离线！");
}
} catch (IOException e) {
e.printStackTrace();
}
}
/**
* 管理员发送消息
*
* @param message
*/
public void systemSendToUser(String sendUserId, String message) {
try {
if (webSocketSet.get(sendUserId) != null) {
webSocketSet.get(sendUserId).sendMessage("系统给我发来消息，消息内容为--->>" + message);
} else {
System.out.println("消息接受人:" + sendUserId + "已经离线！");
}
} catch (IOException e) {
e.printStackTrace();
}
}
/**
* 给所有人发消息
*
* @param message
*/
private void sendAll(String message) {
String sendMessage = message.split(",")[0];
//遍历HashMap
for (String key : webSocketSet.keySet()) {
try {
//判断接收用户是否是当前发消息的用户
if (!userId.equals(key)) {
webSocketSet.get(key).sendMessage("用户:" + userId + "发来消息：" + " <br/> " + sendMessage);
System.out.println("key = " + key);
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
/**
* 发生错误时调用
*
* @param session
* @param error
*/
@OnError
public void onError(Session session, Throwable error) {
System.out.println("发生错误");
error.printStackTrace();
}
/**
* 发送消息
*
* @param message
* @throws IOException
*/
public void sendMessage(String message) throws IOException {
//同步发送
this.session.getBasicRemote().sendText(message);
//异步发送
//this.session.getAsyncRemote().sendText(message);
}
}
⑤、服务器推送接口：
IndexController：
package cn.cnbuilder.websocket.controller;
import cn.cnbuilder.websocket.ProductWebSocket;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import java.util.Map;
import java.util.concurrent.TimeUnit;
@Controller
public class IndexController {
@GetMapping(value = "/")
@ResponseBody
public Object index() {
return "Hello,ALl。This is yuanmayouchuang webSocket demo！";
}
@ResponseBody
@GetMapping("test")
public String test(String userId, String message) throws Exception {
if (userId == "" || userId == null) {
return "发送用户id不能为空";
}
if (message == "" || message == null) {
return "发送信息不能为空";
}
new ProductWebSocket().systemSendToUser(userId, message);
return "发送成功！";
}
@RequestMapping(value = "/ws")
public String ws() {
return "ws";
}
@RequestMapping(value = "/ws1")
public String ws1() {
return "ws1";
}
}
⑥：SpringBoot配置文件
application.yml:
#端口号
server:
port: 12006
⑦：动态banner：
banner.txt:
__ ____ ____ _______
\ \ / / \/ \ \ / / ____|
\ \_/ /| \ / |\ \_/ / |
\ / | |\/| | \ /| |
| | | | | | | | | |____
|_| |_| |_| |_| \_____|::猿码优创：websocket SpringBoot Demo 博客地址：www.cnbuilder.cn
⑧：前段代码：
ws.html:
<!DOCTYPE html>
<html>
<head>
<title>WebSocket SpringBootDemo</title>
</head>
<body>
<!--userId:发送消息人的编号-->
<div>默认用户id：xiaoyou001（后期可以根据业务逻辑替换）</div>
<br/><input id="text" type="text"/>
<input placeholder="请输入接收人的用户id" id="sendUserId"></input>
<button onclick="send()">发送消息</button>
<br/>
<button onclick="closeWebSocket()">关闭WebSocket连接</button>
<br/>
<div>公众号：猿码优创</div>
<br/>
<div id="message"></div>
</body>
<script type="text/javascript">
var websocket = null;
var userId = "xiaoyou001"
//判断当前浏览器是否支持WebSocket
if ('WebSocket' in window) {
websocket = new WebSocket("ws://127.0.0.1:12006/websocket/" + userId);
}
else {
alert('当前浏览器不支持websocket哦！')
}
//连接发生错误的回调方法
websocket.onerror = function () {
setMessageInnerHTML("WebSocket连接发生错误");
};
//连接成功建立的回调方法
websocket.onopen = function () {
setMessageInnerHTML("WebSocket连接成功");
}
//接收到消息的回调方法
websocket.onmessage = function (event) {
setMessageInnerHTML(event.data);
}
//连接关闭的回调方法
websocket.onclose = function () {
setMessageInnerHTML("WebSocket连接关闭");
}
//监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
window.onbeforeunload = function () {
closeWebSocket();
}
//将消息显示在网页上
function setMessageInnerHTML(sendMessage) {
document.getElementById('message').innerHTML += sendMessage + '<br/>';
}
//关闭WebSocket连接
function closeWebSocket() {
websocket.close();
}
//发送消息
function send() {
var message = document.getElementById('text').value;//要发送的消息内容
if (message == "") {
alert("发送信息不能为空！")
return;
} //获取发送人用户id
var sendUserId = document.getElementById('sendUserId').value;
if (sendUserId == "") {
alert("发送人用户id不能为空！")
return;
}
document.getElementById('message').innerHTML += (userId + "给" + sendUserId + "发送消息,消息内容为---->>" + message + '<br/>');
message = message + "," + sendUserId//将要发送的信息和内容拼起来，以便于服务端知道消息要发给谁
websocket.send(message);
}
</script>
</html>
ws1.html
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/html">
<head>
<title>WebSocket SpringBootDemo</title>
</head>
<body>
<!--userId:发送消息人的编号-->
<div>默认用户id：xiaoyou002（后期可以根据业务逻辑替换）</div>
<br/><input id="text" placeholder="请输入要发送的信息" type="text"/>
<input placeholder="请输入接收人的用户id" id="sendUserId"></input>
<button onclick="send()">发送消息</button>
<br/>
<button onclick="closeWebSocket()">关闭WebSocket连接</button>
<br/>
<div>公众号：猿码优创</div>
</br>
<div id="message"></div>
</body>
<script type="text/javascript">
var websocket = null;
var userId = "xiaoyou002"
//判断当前浏览器是否支持WebSocket
if ('WebSocket' in window) {
websocket = new WebSocket("ws://127.0.0.1:12006/websocket/" + userId);
}
else {
alert('当前浏览器不支持websocket哦！')
}
//连接发生错误的回调方法
websocket.onerror = function () {
setMessageInnerHTML("WebSocket连接发生错误");
};
//连接成功建立的回调方法
websocket.onopen = function () {
setMessageInnerHTML("WebSocket连接成功");
}
//接收到消息的回调方法
websocket.onmessage = function (event) {
setMessageInnerHTML(event.data);
}
//连接关闭的回调方法
websocket.onclose = function () {
setMessageInnerHTML("WebSocket连接关闭");
}
//监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。
window.onbeforeunload = function () {
closeWebSocket();
}
//将消息显示在网页上
function setMessageInnerHTML(sendMessage) {
document.getElementById('message').innerHTML += sendMessage + '<br/>';
}
//关闭WebSocket连接
function closeWebSocket() {
websocket.close();
}
//发送消息
function send() {
var message = document.getElementById('text').value;//要发送的消息内容
if (message == "") {
alert("发送信息不能为空！")
return;
} //获取发送人用户id
var sendUserId = document.getElementById('sendUserId').value;
if (sendUserId == "") {
alert("发送人用户id不能为空！")
return;
}
document.getElementById('message').innerHTML += ("我给" + sendUserId + "发送消息,消息内容为---->>" + message + '<br/>');
message = message + "," + sendUserId//将要发送的信息和内容拼起来，以便于服务端知道消息要发给谁
websocket.send(message);
}
</script>
</html>
测试：启动项目
首页访问地址：http://127.0.0.1:12006/
访问WebSocket测试页面1：http://127.0.0.1:12006/ws
访问流程图：
测试一对一发送消息：给另一个用户发送信息
换一个浏览器，测试两个 不要用同一浏览器，要不会出问题。
访问WebSocket测试页面2：http://127.0.0.1:12006/ws1
一对一发送消息牛成图：
测试服务器主动向浏览器推送消息：http://127.0.0.1:12006/test?userId=xiaoyou002&message=我是小优，听到请回答。
接口地址：http://127.0.0.1:12006/test
参数：userId：推送人用户id ws.html :xiaoyou001 ws1.html：xiaoyou002 写死的，可根据业务动态写活。
一对多推送的话：流程和一对一相似。大家自行研究哈。
/**
* 给所有人发消息
*
* @param message
*/
private void sendAll(String message) {
String sendMessage = message.split(",")[0];
//遍历HashMap
for (String key : webSocketSet.keySet()) {
try {
//判断接收用户是否是当前发消息的用户
if (!userId.equals(key)) {
webSocketSet.get(key).sendMessage("用户:" + userId + "发来消息：" + " <br/> " + sendMessage);
System.out.println("key = " + key);
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
终、、
以上就是websocket一对一发送消息，一对多发送消息，服务器主动推送消息 感觉是不是超简单！ 有什么问题可以联系我哈。
鼓励作者写出更好的技术文档，就请我喝一瓶哇哈哈哈哈哈哈哈。。
微信：
支付宝：
感谢一路支持我的人。。。。。
Love me and hold me
QQ:69673804（16年老号）
EMAIL:69673804@qq.com
友链交换
如果有兴趣和本博客交换友链的话，请按照下面的格式在评论区进行评论，我会尽快添加上你的链接。
网站名称：KingYiFan’S Blog
网站地址：http://blog.cnbuilder.cn
网站描述：年少是你未醒的梦话，风华是燃烬的彼岸花。
网站Logo/头像：http://blog.cnbuilder.cn/upload/2018/7/avatar20180720144536200.jpg
