还记得,我们在物联网设备数据流转之实时数据从哪里来、如何转发:Node.js, MQTT, EMQX的WebHook这篇文章中,当 EMQX 的 WebHook 收到来自设备的消息时,我们当时只是简单地进行了打印输出,现在我们真正实现实时消息推送。
在前面的Spring事件及监听机制一文中我们介绍过:将 WebHook 中的消息通过 Spring 事件发送出去,然后需要定义事件监听者,本项目中有两个监听者:
- TDengine 存储;
- WebSocket 推送;
让我们看看设备消息现在到哪里了。
通过 Java 或者 SpringBoot 实现 WebSocket 的方案有很多,包括:
- 基于javax的WebSocket;
- 基于Netty实现WebSocket;
- 第三方封装好的WebSocket(本身也是基于Netty实现的);
我这里选择了第三方封装好的 org.yeauty.netty-websocket-spring-boot-starter ,这样实现起来相对简洁。
后端实现 依赖文件
org.yeauty
netty-websocket-spring-boot-starter
0.11.0
配置文件
netty-ws:
path: /ws/{arg}
port: 8888
新增类
- WebSocketConfig.java
@Configuration
public class WebSocketConfig {
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
}
- WebsocketService.java
这是实现 WebSocket 服务的核心类,主要是实现了建立连接、关闭连接、收到消息、发生错误以及其他事件的动作响应。
@ServerEndpoint(path = "${netty-ws.path}", port = "${netty-ws.port}")
@Component
@Slf4j
public class WebsocketService {
@BeforeHandshake
public void handshake(Session session, HttpHeaders headers, @RequestParam String req, @RequestParam MultiValueMap reqMap, @PathVariable String arg, @PathVariable Map pathMap) {
session.setSubprotocols("stomp");
if (!"ok".equals(req)) {
System.out.println("Authentication failed!");
session.close();
}
}
@OnOpen
public void onOpen(Session session, HttpHeaders headers, @RequestParam String req, @RequestParam MultiValueMap reqMap, @PathVariable String arg, @PathVariable Map pathMap) {
System.out.println("[new connection]: " + arg);
WebSocketSession.addClient(session, arg);
System.out.println(req);
log.info("有新连接加入!当前在线客户端数量:{}", WebSocketSession.getOnlineCount());
}
@OnClose
public void onClose(Session session) throws IOException {
String client = WebSocketSession.getClientBySession(session);
System.out.println("[one connection closed]:"+ client);
WebSocketSession.removeClient(session);
log.info("有一连接关闭!当前在线客户端数量:{}", WebSocketSession.getOnlineCount());
}
@OnError
public void onError(Session session, Throwable throwable) {
session.close();
throwable.printStackTrace();
}
@OnMessage
public void onMessage(Session session, String message) {
System.out.println("[new message]: " + message);
session.sendText("Hello Netty!欧克");
}
@OnBinary
public void onBinary(Session session, byte[] bytes) {
for (byte b : bytes) {
System.out.println(b);
}
session.sendBinary(bytes);
}
@OnEvent
public void onEvent(Session session, Object evt) {
if (evt instanceof IdleStateEvent) {
IdleStateEvent idleStateEvent = (IdleStateEvent) evt;
switch (idleStateEvent.state()) {
case READER_IDLE:
System.out.println("read idle");
break;
case WRITER_IDLE:
System.out.println("write idle");
break;
case ALL_IDLE:
System.out.println("all idle");
break;
default:
break;
}
}
}
}
- WebSocketSession.java
主要实现 WebSocket 会话管理以及消息发送功能,除了向指定用户发送消息之外,还可以进行群发。
public class WebSocketSession {
private static final Map sessionKV = new HashMap();
public static void addClient(Session session, String client) {
sessionKV.put(session, client);
}
public static Collection getOnlineClient() {
Set result = new HashSet();
Collection clients = sessionKV.values();
for (String client : clients) {
result.add(client);
}
return result;
}
public static synchronized int getOnlineCount() {
return sessionKV.size();
}
public static String getClientBySession(Session session) {
return sessionKV.get(session);
}
public static List getSessionsByGroupID(String groupID) {
List sessions = new ArrayList();
Set keys = sessionKV.keySet();
synchronized (keys) {
for (Session session : keys) {
String value = sessionKV.get(session);
if (value.equals(groupID)) {
sessions.add(session);
}
}
}
return sessions;
}
public static Session getSessionByClient(String client) {
Set keys = sessionKV.keySet();
synchronized (keys) {
for (Session session : keys) {
String c = sessionKV.get(session);
if (c.equals(client)) {
return session;
}
}
}
return null;
}
public static void sendMessage2Target(Session session, String message) {
if (null != session && null != sessionKV.get(session)) {
session.sendText(message);
}
}
public static void sendMessage2Group(String groupID, String message) {
List sessionsByGroupID = getSessionsByGroupID(groupID);
sessionsByGroupID.forEach(session -> {
if(sessionKV.get(session) != null){
session.sendText(message);
}
});
}
public static void sendMessage2All(String message) {
Set keys = sessionKV.keySet();
synchronized (keys) {
for (Session session : keys) {
String user = sessionKV.get(session);
if (user != null) {
session.sendText(message);
}
}
}
}
public static boolean removeClient(Session session) {
if (sessionKV.containsKey(session)) {
sessionKV.remove(session);
return true;
} else {
return false;
}
}
}
- MessageEventListener4Push.java
在 com.heartsuit.websocket 包下创建 MessageEventListener4Push 类,实现对 Spring 事件的监听与消费。当收到事件后,我们依次做了以下操作:获取消息负载–>反序列化–>获取传入的城市参数–>根据城市获取对应的WebSocket会话–>向指定会话发送消息。
@Component
@Slf4j
public class MessageEventListener4Push {
@EventListener
public void handleEvent(MessageEvent event) throws JsonProcessingException {
String payload = event.getMsg();
log.info("Message received in WebSocket: {}", payload);
Power power = new ObjectMapper().readValue(payload, Power.class);
String city = power.getCity();
Session session = WebSocketSession.getSessionByClient(city);
if (null != session) {
WebSocketSession.sendMessage2Target(session, payload);
}
}
}
完成以上操作后,项目结构如下:
小总结至此,我们已经实现了 WebSocket 服务端推送,将设备的最新状态信息实时地推送至前端客户端,那么接下来我们在下一篇中就来实现 WebSocket 前端接收消息的功能,待前端的接收功能实现后,我们再测试下从设备发送消息, EMQX 消息转发, WebHook 监听, Spring 事件发送, Spring 事件监听,到最后 WebSocket 推送至前端的全流程。
If you have any questions or any bugs are found, please feel free to contact me.
Your comments and suggestions are welcome!



