springboot使用websocket进行实时传送信息实战(包含服务端和客户端)

1.背景

---

公司对接告警信息平台，需要做一个服务，作为websocket客户端去接收传过来的信息，实时返回信息并对信息进行处理入库。

2.实现方案

---

本来想用一个服务，对信息进行接收和处理。但是基于之前的经验，为了防止服务部署重启的时候丢失信息，改用两个服务：1.collcet接收服务，2.deal-send处理入库服务。collect服务作为websocket客户端，进行接收传过来的信息，并同时作为websocket服务端，传信息给deal-send服务；deal-send作为websocket客户端，接收collect传过来的信息，进行处理入库。

3.代码实例

---

• collect服务主要依赖

pom.xml

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

        <!--websocket作为客户端-->
        <dependency>
            <groupId>org.java-websocket</groupId>
            <artifactId>Java-WebSocket</artifactId>
            <version>1.4.0</version>
        </dependency>

        <!--使用Spring RetryTemplate进行重试-->
        <dependency>
            <groupId>org.springframework.retry</groupId>
            <artifactId>spring-retry</artifactId>
            <version>1.2.4.RELEASE</version>
        </dependency>

• deal-send服务主要依赖

pom.xml

        <!--websocket作为客户端-->
        <dependency>
            <groupId>org.java-websocket</groupId>
            <artifactId>Java-WebSocket</artifactId>
            <version>1.4.0</version>
        </dependency>

•  collect配置类

WebSocketConfig.java

package com.newland.auto.pilot.collect.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.server.standard.ServerEndpointExporter;

/**
 * @author:wk
 * @date:2020/6/10 开启WebSocket支持
 */

@Configuration
public class WebSocketConfig {

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

}

• collect服务websocket客户端，由于告警信息平台偶尔会断网，websocket的长连接就会被断开，所以在onClose方法里加入了spring-retry提供的重试方法，在断开websocket连接的时候会进行重连操作。onMessage方法里加了发送信息到deal-send服务的调用，在接收到告警信息平台的时候，会将信息发到deal-send服务。

MyWebSocketCient.java

package com.newland.auto.pilot.collect.config;

import com.newland.auto.pilot.collect.ApplicationRunnerImpl;
import lombok.extern.slf4j.Slf4j;
import org.java_websocket.client.WebSocketClient;
import org.java_websocket.handshake.ServerHandshake;
import org.springframework.retry.RecoveryCallback;
import org.springframework.retry.RetryCallback;
import org.springframework.retry.RetryContext;
import org.springframework.retry.policy.AlwaysRetryPolicy;
import org.springframework.retry.support.RetryTemplate;

import java.net.URI;
import java.util.Map;

/**
 * @author:wk
 * @date:2020/5/29
 */
@Slf4j
public class MyWebSocketClient extends WebSocketClient {

    public MyWebSocketClient(URI serverUri, Map<String, String> headers) {
        super(serverUri, headers);
    }

    @Override
    public void onOpen(ServerHandshake arg0) {
        log.info("------ MyWebSocket onOpen ------");
    }

    @Override
    public void onClose(int arg0, String arg1, boolean arg2) {
        log.info("------ MyWebSocket onClose ------{}", arg1);
        log.info("启用断开重连!");

        try {
            // Spring-retry提供了RetryOperations接口的实现类RetryTemplate
            RetryTemplate template = new RetryTemplate();

            // 一直重试策略
            AlwaysRetryPolicy policy = new AlwaysRetryPolicy();

            // 设置重试策略
            template.setRetryPolicy(policy);

            // 执行
            String result = template.execute(
                    new RetryCallback<String, Exception>() {

                        public String doWithRetry(RetryContext context) throws Exception {
                            log.info("------------------------执行关闭连接重试操作--------------------------");
                            // 调用连接websocket方法
                            ApplicationRunnerImpl.connectWebsocket();

                            return "------------------------重连成功--------------------------";
                        }
                    },
                    // 当重试执行完闭，操作还未成为，那么可以通过RecoveryCallback完成一些失败事后处理。
                    new RecoveryCallback<String>() {
                        public String recover(RetryContext context) throws Exception {

                            return "------------------------重试执行完闭，操作未完成！！--------------------------";
                        }
                    }
            );
            log.info(result);
        } catch (Exception ex) {
            log.error(ex.getMessage(), ex);
        }
    }

    @Override
    public void onError(Exception arg0) {
        log.info("------ MyWebSocket onError ------{}", arg0);
    }

    @Override
    public void onMessage(String arg0) {
        log.info("-------- 接收到服务端数据： " + arg0 + "--------");
        try {
            WebSocketServer.sendInfo(arg0, "deal-send");
        } catch (Exception e) {
            log.info("发送消息到deal-send客户端失败，信息:" + e.getMessage());
        }
    }
}

• collect服务的websocket服务端，提供给deal-send服务连接，sendInfo方法里加入对用户的监听，deal-send用户在线时发送信息，不在线时远程调用deal-send服务的重连接口，在deal-send服务的websocket客户端断开连接时进行主动调用，使deal-send服务的websocket重新连接上。

WebSocketServer.java

package com.newland.auto.pilot.collect.config;


import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Component;
import org.springframework.web.client.RestTemplate;

import javax.websocket.*;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.atomic.LongAdder;

/**
 * @author:wk
 * @date:2020/6/10
 */
@Slf4j
@ServerEndpoint("/server/ws/{userId}")
@Component
public class WebSocketServer {

    /**
     * LongAdder记录当前在线连接数,线程安全。
     */
    LongAdder onlineCounter = new LongAdder();
    /**
     * concurrent包的线程安全Set，用来存放每个客户端对应的MyWebSocket对象。
     */
    private static ConcurrentHashMap<String, WebSocketServer> webSocketMap = new ConcurrentHashMap<>();
    /**
     * 与某个客户端的连接会话，需要通过它来给客户端发送数据
     */
    private Session session;
    /**
     * 接收userId
     */
    private String userId = "";
    /**
     * 调用deal-send重连接口的uri
     */
    static String reConnectWebsocketUri = "http://localhost:9042/newland/reConnectWebsocket";


    /**
     * 连接建立成功调用的方法
     */
    @OnOpen
    public void onOpen(Session session, @PathParam("userId") String userId) {
        this.session = session;
        log.info("onopen,this.session:" + session);
        this.userId = userId;
        if (webSocketMap.containsKey(userId)) {
            webSocketMap.remove(userId);
            webSocketMap.put(userId, this);
            
        } else {
            webSocketMap.put(userId, this);
            
            onlineCounter.increment();
            //在线数加1
        }

        log.info("用户连接:" + userId + ",当前在线人数为:" + onlineCounter.sum());

        try {
            sendMessage("连接成功");
        } catch (IOException e) {
            log.error("用户:" + userId + ",网络异常!!!!!!");
        }
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose() {
        if (webSocketMap.containsKey(userId)) {
            webSocketMap.remove(userId);
            //从set中删除
            onlineCounter.decrement();
        }
        log.info("用户退出:" + userId + ",当前在线人数为:" + onlineCounter.sum());
    }

    /**
     * 收到客户端消息后调用的方法
     *
     * @param message 客户端发送过来的消息
     */
    @OnMessage
    public void onMessage(String message, Session session) {
        log.info("用户消息:" + userId + ",报文:" + message);
    }

    /**
     * @param session
     * @param error
     */
    @OnError
    public void onError(Session session, Throwable error) {
        log.error("用户错误:" + this.userId + ",原因:" + error.getMessage());
    }  
108 
    /**
     * 实现服务器主动推送
     */
    public void sendMessage(String message) throws IOException {
        this.session.getBasicRemote().sendText(message);
    }


    /**
     * 发送自定义消息
     */
    public static void sendInfo(String message, @PathParam("userId") String userId) throws IOException {
        log.info("发送消息到:" + userId);
        if (StringUtils.isNotBlank(userId) && webSocketMap.containsKey(userId)) {
            webSocketMap.get(userId).sendMessage(message);
        } else {
            log.error("用户：" + userId + ",不在线！");
            log.info("---------开始远程调用重连websocket接口----------");
            RestTemplate restTemplate = new RestTemplate(new HttpsClientRequestFactory());
            ResponseEntity<String> response = restTemplate.getForEntity(reConnectWebsocketUri, String.class);

            log.info("执行请求后，返回response body:" + response.getBody());
            // 判断返回状态是否为200
            if (response.getStatusCodeValue() == 200) {
                log.info("返回状态为200!");
                // 解析响应体
                String content = response.getBody();
                log.info(content);
            } else {
                log.info("返回状态为" + response.getStatusCodeValue() + "!");
            }
        }
    }


}

• deal-send服务的websocket客户端连接

WebSocketConfig.java

package com.newland.auto.pilot.deal.send.config;

import com.alibaba.fastjson.JSON;
import com.newland.auto.pilot.deal.send.alarmDeal.AlarmConvert;
import com.newland.auto.pilot.deal.send.jms.FmSendJMSMgm;
import com.newland.privatefm.alarmSend.AlarmMsg;
import com.newland.privatefm.alarmSend.SendManager;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.java_websocket.client.WebSocketClient;
import org.java_websocket.drafts.Draft_6455;
import org.java_websocket.handshake.ServerHandshake;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;

import java.net.URI;
import java.util.List;

/**
 * @author:wk
 * @date:2020/6/12
 * @Description: 配置websocket客户端
 */

@Slf4j
@Component
public class WebSocketConfig {
    @Autowired
    private AlarmConvert alarmConvert;

    @Bean
    public WebSocketClient webSocketClient() {
        try {
            WebSocketClient webSocketClient = new WebSocketClient(new URI("ws://localhost:9041" + "/server/ws/deal-send"), new Draft_6455()) {
                @Override
                public void onOpen(ServerHandshake handshakedata) {
                    log.info("------ MyWebSocket onOpen ------");
                    log.info("FmSendJMSMgm Thread Begin ...");
                    FmSendJMSMgm sendJMSMgm = new FmSendJMSMgm();
                    if (sendJMSMgm.init()) {
                        sendJMSMgm.start();
                        log.info("FmSendJMSMgm Thread End
");
                    } else {
                        log.error("FmSendJMSMgm Thread init failed, Program Exit!!!
");
                        System.exit(0);
                    }
                }

                @Override
                public void onMessage(String message) {
                    log.info("-------- 接收到服务端数据： " + message + "--------");

                    if (StringUtils.isNotBlank(message)) {
                        try {
                            //解析发送的报文
                            List<AlarmMsg> alarmMsgList = alarmConvert.alarmMsgConvert(message);
                            alarmMsgList.parallelStream().forEach(alarmMsg -> {
   
                                //Jms发送数据
                                log.info("Jms发送数据:" + JSON.toJSONString(alarmMsg));
                                SendManager.sendManager.putData(alarmMsg);
                                log.info("Jms发送数据成功！");
                            });
                        } catch (Exception e) {
                            log.error(e.getMessage());
                        }
                    }

                }

                @Override
                public void onClose(int code, String reason, boolean remote) {
                    log.info("------ MyWebSocket onClose ------{}", reason);
                }

                @Override
                public void onError(Exception ex) {
                    log.info("------ MyWebSocket onError ------{}", ex);
                }
            };
            webSocketClient.connect();
            return webSocketClient;
        } catch (Exception e) {
            log.error(e.getMessage, e);
        }
        return null;
    }

}

• deal-send服务的远程重连接口

ReConnectWsController.java

package com.newland.auto.pilot.deal.send.controller;

import com.newland.auto.pilot.deal.send.config.WebSocketConfig;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
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;

/**
 * @author:wk
 * @date:2020/9/4 调用方法进行重连websocket
 */

@Slf4j
@Controller
@ResponseBody
@RequestMapping(value = "/newland")
public class ReConnectWsController {
    @Autowired
    WebSocketConfig webSocketConfig;

    @GetMapping("/reConnectWebsocket")
    public String reConnectWebsocket() throws Exception {
        String returnMsg = "---------调用重连websocket接口成功-----------";

        log.info("---------开始调用重连websocket接口----------");
        webSocketConfig.webSocketClient().reconnect();
        log.info(returnMsg);
        return returnMsg;
    }
}

• collect服务websocket客户端重连日志

[2020-09-05 11:25:18] 126481 [WebSocketTimer] INFO -c.n.a.p.c.config.MyWebSocketClient[36] - ------ MyWebSocket onClose ------The connection was closed because the other endpoint did not respond with a pong in time. For more information check: https://github.com/TooTallNate/Java-WebSocket/wiki/Lost-connection-detection 
[2020-09-05 11:25:18] 126485 [WebSocketTimer] INFO -c.n.a.p.c.config.MyWebSocketClient[37] - 启用断开重连! 
[2020-09-05 11:25:18] 126501 [WebSocketTimer] INFO -c.n.a.p.c.config.MyWebSocketClient[54] - ------------------------执行关闭连接重试操作-------------------------- 
[2020-09-05 11:25:18] 126505 [WebSocketTimer] INFO -c.n.a.p.c.collect.TokenCollect[31] - 开始执行请求！ 
[2020-09-05 11:25:18] 126506 [WebSocketTimer] INFO -c.n.a.p.c.collect.TokenCollect[39] - 开始使用restTemplate.exchange！！ 
[2020-09-05 11:25:18] 126705 [WebSocketTimer] INFO -c.n.a.p.c.collect.TokenCollect[41] - 执行请求后，返回response body:{"accessSession":"x-xxxxxxxxxxx","roaRand":"0xxxxxxxxxx","expires":1800,"additionalInfo":null} 
[2020-09-05 11:25:18] 126706 [WebSocketTimer] INFO -c.n.a.p.c.collect.TokenCollect[44] - 返回状态为200! 
[2020-09-05 11:25:18] 126706 [WebSocketTimer] INFO -c.n.a.p.c.collect.TokenCollect[47] - {"accessSession":"x-xxxxxxxxxxx","roaRand":"0xxxxxxxxx","expires":1800,"additionalInfo":null} 
[2020-09-05 11:25:18] 126706 [WebSocketTimer] INFO -c.n.a.p.c.collect.TokenCollect[50] - accessToken:x-xxxxxuxxxxxx
[2020-09-05 11:25:18] 126711 [WebSocketTimer] INFO -c.n.a.p.c.collect.SubscribeCollect[46] - 开始执行请求！ 
[2020-09-05 11:25:18] 126917 [WebSocketTimer] INFO -c.n.a.p.c.collect.SubscribeCollect[49] - 执行请求后，返回response body:{"output":{"subscription-result":"ok","identifier":"9xxxxxxxx","url":"/restconf/streams/ws/v1/identifier/34xxxxx"}} 
[2020-09-05 11:25:18] 126917 [WebSocketTimer] INFO -c.n.a.p.c.collect.SubscribeCollect[52] - 返回状态为200! 
[2020-09-05 11:25:18] 126917 [WebSocketTimer] INFO -c.n.a.p.c.collect.SubscribeCollect[55] - {"output":{"subscription-result":"ok","identifier":"95xxxxxxx","url":"/restconf/streams/ws/v1/identifier/34xxxxxxx"}} 
[2020-09-05 11:25:18] 126918 [WebSocketTimer] INFO -c.n.a.p.c.collect.SubscribeCollect[59] - url:/restconf/streams/ws/v1/identifier/34xxxxxxx 
[2020-09-05 11:25:18] 126918 [WebSocketTimer] INFO -c.n.a.p.c.ApplicationRunnerImpl[58] - protocol:TLSv1.2 
[2020-09-05 11:25:18] 126919 [WebSocketTimer] INFO -c.n.a.p.c.config.MyWebSocketClient[69] - ------------------------重连成功-------------------------- 
[2020-09-05 11:25:19] 127069 [WebSocketConnectReadThread-41] INFO -c.n.a.p.c.config.MyWebSocketClient[30] - ------ MyWebSocket onOpen ------ 
[2020-09-05 11:25:25] 133139 [WebSocketConnectReadThread-41] INFO -c.n.a.p.c.config.MyWebSocketClient[84] - -------- 接收到服务端数据： {"csn":111111,"name":"测试name","priority":"medium","occur-time":"2020-09-05T03:23:22Z","clear-time":"2020-09-05T03:26:31Z","status":"status1","category":"Power environment","domain":"domain1","source-objects":[{"id":"","type":"type1","name":"test","extend-id":"123456","device-type":"34"}],"detail":"detail1","message-type":"1","root-event-csns":[{"csn":"111","type":"1"}]}-------- 
[2020-09-05 11:25:25] 133139 [WebSocketConnectReadThread-41] INFO -c.n.a.p.c.config.WebSocketServer[136] - 发送消息到:deal-send 

• collect远程调用重连websocket接口日志

[2020-09-05 11:23:33] 21128 [WebSocketConnectReadThread-33] INFO -c.n.a.p.c.config.WebSocketServer[136] - 发送消息到:deal-send 
[2020-09-05 11:23:33] 21137 [WebSocketConnectReadThread-33] ERROR-c.n.a.p.c.config.WebSocketServer[140] - 用户：deal-send,不在线！ 
[2020-09-05 11:23:33] 21138 [WebSocketConnectReadThread-33] INFO -c.n.a.p.c.config.WebSocketServer[141] - ---------开始远程调用重连websocket接口---------- 
[2020-09-05 11:23:33] 21573 [http-nio-9041-exec-1] INFO -o.a.c.c.C.[Tomcat].[localhost].[/][173] - Initializing Spring DispatcherServlet 'dispatcherServlet' 
[2020-09-05 11:23:33] 21574 [http-nio-9041-exec-1] INFO -o.s.web.servlet.DispatcherServlet[524] - Initializing Servlet 'dispatcherServlet' 
[2020-09-05 11:23:33] 21588 [http-nio-9041-exec-1] INFO -o.s.web.servlet.DispatcherServlet[546] - Completed initialization in 14 ms 
[2020-09-05 11:23:33] 21649 [http-nio-9041-exec-1] INFO -c.n.a.p.c.config.WebSocketServer[49] - onopen,this.session:org.apache.tomcat.websocket.WsSession@32f5b990 
[2020-09-05 11:23:33] 21650 [http-nio-9041-exec-1] INFO -c.n.a.p.c.config.WebSocketServer[62] - 用户连接:deal-send,当前在线人数为:1 

• deal-send服务被远程调用重连websocket接口日志

[2020-09-05 11:23:08] 87821 [WebSocketConnectReadThread-19] INFO -c.n.a.p.d.s.config.WebSocketConfig[74] - ------ MyWebSocket onClose ------ 
[2020-09-05 11:23:33] 112532 [http-nio-9042-exec-1] INFO -o.a.c.c.C.[Tomcat].[localhost].[/][173] - Initializing Spring DispatcherServlet 'dispatcherServlet' 
[2020-09-05 11:23:33] 112533 [http-nio-9042-exec-1] INFO -o.s.web.servlet.DispatcherServlet[524] - Initializing Servlet 'dispatcherServlet' 
[2020-09-05 11:23:33] 112556 [http-nio-9042-exec-1] INFO -o.s.web.servlet.DispatcherServlet[546] - Completed initialization in 23 ms 
[2020-09-05 11:23:33] 112630 [http-nio-9042-exec-1] INFO -c.n.a.p.d.s.c.ReConnectWsController[28] - ---------开始调用重连websocket接口---------- 
[2020-09-05 11:23:33] 112828 [WebSocketConnectReadThread-43] INFO -c.n.a.p.d.s.config.WebSocketConfig[38] - ------ MyWebSocket onOpen ------