在一次项目开发中，使用到了 Netty 网络应用框架，以及 MQTT 进行消息数据的收发，这其中需要后台来将获取到的消息主动推送给前端，于是就使用到了 MQTT，特此记录一下。

一、什么是 websocket？

WebSocket 协议是基于 TCP 的一种新的网络协议。它实现了客户端与服务器全双工通信，学过计算机网络都知道，既然是全双工，就说明了服务器可以主动发送信息给客户端。

这与我们的推送技术或者是多人在线聊天的功能不谋而合。

为什么不使用 HTTP 协议呢？

这是因为 HTTP 是单工通信，通信只能由客户端发起，客户端请求一下，服务器处理一下，这就太麻烦了。于是 websocket 应运而生。

下面我们就直接开始使用 Springboot 开始整合。以下案例都在我自己的电脑上测试成功，你可以根据自己的功能进行修改即可。

我的项目结构如下：

二、使用步骤

1. 添加依赖

Maven 依赖：

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

2. 启用 Springboot 对 WebSocket 的支持

启用 WebSocket 的支持也是很简单，几句代码搞定：

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;
/**
 * @ Auther: 马超伟
 * @ Date: 2020/06/16/14:35
 * @ Description: 开启 WebSocket 支持
 */
@Configuration
public class WebSocketConfig {
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}

Spring Boot 最新教程推荐看这个：https://github.com/javastacks/spring-boot-best-practice

3. 核心配置：WebSocketServer

因为 WebSocket 是类似客户端服务端的形式 (采用 ws 协议)，那么这里的 WebSocketServer 其实就相当于一个 ws 协议的 Controller

• @ ServerEndpoint 注解是一个类层次的注解，它的功能主要是将目前的类定义成一个 websocket 服务器端, 注解的值将被用于监听用户连接的终端访问 URL 地址, 客户端可以通过这个 URL 来连接到 WebSocket 服务器端
• 新建一个 ConcurrentHashMap webSocketMap 用于接收当前 userId 的 WebSocket，方便传递之间对 userId 进行推送消息。

下面是具体业务代码：

package cc.mrbird.febs.external.webScoket;
import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.conditions.update.UpdateWrapper;
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.time.LocalDateTime;
import java.util.List;
import java.util.concurrent.CopyOnWriteArraySet;
/**


Created with IntelliJ IDEA.


@ Auther: 马超伟


@ Date: 2020/06/16/14:35


@ Description:


@ ServerEndpoint 注解是一个类层次的注解，它的功能主要是将目前的类定义成一个 websocket 服务器端,


注解的值将被用于监听用户连接的终端访问 URL 地址, 客户端可以通过这个 URL 来连接到 WebSocket 服务器端
*/
@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;
webSocketSet.add(this);     // 加入 set 中
this.sid = sid;
addOnlineCount();           // 在线数加 1
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);
// 群发消息
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, @PathParam("sid") String sid) throws IOException {
log.info("推送消息到窗口" + sid + "，推送内容:" + message);
for (WebSocketServer item : webSocketSet) {
try {
// 这里可以设定只推送给这个 sid 的，为 null 则全部推送
if (sid == null) {
//                    item.sendMessage(message);
} else if (item.sid.equals(sid)) {
item.sendMessage(message);
}
} catch (IOException e) {
continue;
}
}
}


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. 测试 Controller

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.servlet.ModelAndView;
import java.io.IOException;
import java.util.HashMap;
import java.util.Map;
/**


Created with IntelliJ IDEA.



@ Auther: 马超伟


@ Date: 2020/06/16/14:38


@ Description:
*/
@Controller("web_Scoket_system")
@RequestMapping("/api/socket")
public class SystemController {
// 页面请求
@GetMapping("/index/{userId}")
public ModelAndView socket(@PathVariable String userId) {
ModelAndView mav = new ModelAndView("/socket1");
mav.addObject("userId", userId);
return mav;
}
// 推送数据接口
@ResponseBody
@RequestMapping("/socket/push/{cid}")
public Map pushToWeb(@PathVariable String cid, String message) {
Map<String,Object> result = new HashMap<>();
try {
WebSocketServer.sendInfo(message, cid);
result.put("code", cid);
result.put("msg", message);
} catch (IOException e) {
e.printStackTrace();
}
return result;
}
}

5. 测试页面 index.html

<!DOCTYPE html>
<html>
<span class="hljs-tag">&lt;<span class="hljs-name">head</span>&gt;</span>
	<span class="hljs-tag">&lt;<span class="hljs-name">meta</span> <span class="hljs-attr">charset</span>=<span class="hljs-string">"utf-8"</span>&gt;</span>
	<span class="hljs-tag">&lt;<span class="hljs-name">title</span>&gt;</span>Java后端WebSocket的Tomcat实现<span class="hljs-tag">&lt;/<span class="hljs-name">title</span>&gt;</span>
	<span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"text/javascript"</span> <span class="hljs-attr">src</span>=<span class="hljs-string">"js/jquery.min.js"</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">head</span>&gt;</span>

<span class="hljs-tag">&lt;<span class="hljs-name">body</span>&gt;</span>
	<span class="hljs-tag">&lt;<span class="hljs-name">div</span> <span class="hljs-attr">id</span>=<span class="hljs-string">"main"</span> <span class="hljs-attr">style</span>=<span class="hljs-string">"width: 1200px;height:800px;"</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">div</span>&gt;</span>
	Welcome<span class="hljs-tag">&lt;<span class="hljs-name">br</span>/&gt;</span><span class="hljs-tag">&lt;<span class="hljs-name">input</span> <span class="hljs-attr">id</span>=<span class="hljs-string">"text"</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"text"</span> /&gt;</span>
	<span class="hljs-tag">&lt;<span class="hljs-name">button</span> <span class="hljs-attr">onclick</span>=<span class="hljs-string">"send()"</span>&gt;</span>发送消息<span class="hljs-tag">&lt;/<span class="hljs-name">button</span>&gt;</span>
	<span class="hljs-tag">&lt;<span class="hljs-name">hr</span>/&gt;</span>
	<span class="hljs-tag">&lt;<span class="hljs-name">button</span> <span class="hljs-attr">onclick</span>=<span class="hljs-string">"closeWebSocket()"</span>&gt;</span>关闭WebSocket连接<span class="hljs-tag">&lt;/<span class="hljs-name">button</span>&gt;</span>
	<span class="hljs-tag">&lt;<span class="hljs-name">hr</span>/&gt;</span>
	<span class="hljs-tag">&lt;<span class="hljs-name">div</span> <span class="hljs-attr">id</span>=<span class="hljs-string">"message"</span>&gt;</span><span class="hljs-tag">&lt;/<span class="hljs-name">div</span>&gt;</span>
<span class="hljs-tag">&lt;/<span class="hljs-name">body</span>&gt;</span>
<span class="hljs-tag">&lt;<span class="hljs-name">script</span> <span class="hljs-attr">type</span>=<span class="hljs-string">"text/javascript"</span>&gt;</span><span class="language-javascript">
	<span class="hljs-keyword">var</span> websocket = <span class="hljs-literal">null</span>;
	<span class="hljs-comment">//判断当前浏览器是否支持WebSocket</span>
	<span class="hljs-keyword">if</span>(<span class="hljs-string">'WebSocket'</span> <span class="hljs-keyword">in</span> <span class="hljs-variable language_">window</span>) {
		<span class="hljs-comment">//改成你的地址</span>
		websocket = <span class="hljs-keyword">new</span> <span class="hljs-title class_">WebSocket</span>(<span class="hljs-string">"ws://192.168.100.196:8082/api/websocket/100"</span>);
	} <span class="hljs-keyword">else</span> {
		<span class="hljs-title function_">alert</span>(<span class="hljs-string">'当前浏览器 Not support websocket'</span>)
	}

	<span class="hljs-comment">//连接发生错误的回调方法</span>
	websocket.<span class="hljs-property">onerror</span> = <span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) {
		<span class="hljs-title function_">setMessageInnerHTML</span>(<span class="hljs-string">"WebSocket连接发生错误"</span>);
	};

	<span class="hljs-comment">//连接成功建立的回调方法</span>
	websocket.<span class="hljs-property">onopen</span> = <span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) {
		<span class="hljs-title function_">setMessageInnerHTML</span>(<span class="hljs-string">"WebSocket连接成功"</span>);
	}
	<span class="hljs-keyword">var</span> U01data, <span class="hljs-title class_">Uidata</span>, <span class="hljs-title class_">Usdata</span>
	<span class="hljs-comment">//接收到消息的回调方法</span>
	websocket.<span class="hljs-property">onmessage</span> = <span class="hljs-keyword">function</span>(<span class="hljs-params">event</span>) {
		<span class="hljs-variable language_">console</span>.<span class="hljs-title function_">log</span>(event);
		<span class="hljs-title function_">setMessageInnerHTML</span>(event);
		<span class="hljs-title function_">setechart</span>()
	}

	<span class="hljs-comment">//连接关闭的回调方法</span>
	websocket.<span class="hljs-property">onclose</span> = <span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) {
		<span class="hljs-title function_">setMessageInnerHTML</span>(<span class="hljs-string">"WebSocket连接关闭"</span>);
	}

	<span class="hljs-comment">//监听窗口关闭事件，当窗口关闭时，主动去关闭websocket连接，防止连接还没断开就关闭窗口，server端会抛异常。</span>
	<span class="hljs-variable language_">window</span>.<span class="hljs-property">onbeforeunload</span> = <span class="hljs-keyword">function</span>(<span class="hljs-params"></span>) {
		<span class="hljs-title function_">closeWebSocket</span>();
	}

	<span class="hljs-comment">//将消息显示在网页上</span>
	<span class="hljs-keyword">function</span> <span class="hljs-title function_">setMessageInnerHTML</span>(<span class="hljs-params">innerHTML</span>) {
		<span class="hljs-variable language_">document</span>.<span class="hljs-title function_">getElementById</span>(<span class="hljs-string">'message'</span>).<span class="hljs-property">innerHTML</span> += innerHTML + <span class="hljs-string">'&lt;br/&gt;'</span>;
	}

	<span class="hljs-comment">//关闭WebSocket连接</span>
	<span class="hljs-keyword">function</span> <span class="hljs-title function_">closeWebSocket</span>(<span class="hljs-params"></span>) {
		websocket.<span class="hljs-title function_">close</span>();
	}

	<span class="hljs-comment">//发送消息</span>
	<span class="hljs-keyword">function</span> <span class="hljs-title function_">send</span>(<span class="hljs-params"></span>) {
		<span class="hljs-keyword">var</span> message = <span class="hljs-variable language_">document</span>.<span class="hljs-title function_">getElementById</span>(<span class="hljs-string">'text'</span>).<span class="hljs-property">value</span>;
		websocket.<span class="hljs-title function_">send</span>(<span class="hljs-string">'{"msg":"'</span> + message + <span class="hljs-string">'"}'</span>);
		<span class="hljs-title function_">setMessageInnerHTML</span>(message + <span class="hljs-string">"&amp;#13;"</span>);
	}
</span><span class="hljs-tag">&lt;/<span class="hljs-name">script</span>&gt;</span>

</html>

6. 结果展示

后台：

如果有连接请求

前台显示：

总结

这中间我遇到一个问题，就是说 WebSocket 启动的时候优先于 spring 容器，从而导致在 WebSocketServer 中调用业务 Service 会报空指针异常

所以需要在 WebSocketServer 中将所需要用到的 service 给静态初始化一下：

如图所示：

还需要做如下配置：

原文链接：https://blog.csdn.net/MacWx/article/details/111319558

版权声明：本文为 CSDN 博主「大树先生.」的原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接及本声明。

近期热文推荐：

1.600+ 道 Java 面试题及答案整理 (2021 最新版)

2.终于靠开源项目弄到 IntelliJ IDEA 激活码了，真香！

3.阿里 Mock 工具正式开源，干掉市面上所有 Mock 工具！

4.Spring Cloud 2020.0.0 正式发布，全新颠覆性版本！

5.《Java 开发手册（嵩山版）》最新发布，速速下载！

觉得不错，别忘了随手点赞 + 转发哦！