SpringBoot 2.0 интегрирует WebSocket для реализации передачи серверных данных в режиме реального времени!

Spring Boot

Для реализации push-технологии в определенной системе компании используется технология Ajax-опроса. Таким образом, браузеру необходимо непрерывно отправлять запросы на сервер. Очевидно, что это будет тратить много пропускной способности и других ресурсов, поэтому я изучил WebSocket.Эта статья будет подробно представлена.

1. Что такое веб-сокет?

WebSocket — это протокол, предоставляемый HTML5 для полнодуплексной связи по одному TCP-соединению, который может лучше экономить ресурсы сервера и пропускную способность, а также обеспечивать более тесную связь в реальном времени.

WebSocket упрощает обмен данными между клиентом и сервером, позволяя серверу активно передавать данные клиенту.В API WebSocket браузеру и серверу нужно только выполнить рукопожатие, а постоянное соединение может быть создано непосредственно между 2. соединение и двунаправленная передача данных.

2. SpringBoot интегрирует WebSocket

Создайте новый проект весенней загрузки spring-boot-websocket и выполните следующие действия.

  1. pom.xml представляет пакет jar
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-websocket</artifactId>
</dependency>

  1. Новый класс конфигурации для WebSocket

Этот класс конфигурации обнаруживает bean-компоненты, аннотированные @ServerEndpoint, и регистрирует их Код класса конфигурации выглядит следующим образом:

@Configuration
public class WebSocketConfig {
    /**
     * 给spring容器注入这个ServerEndpointExporter对象
     * 相当于xml：
     * <beans>
     * <bean id="serverEndpointExporter" class="org.springframework.web.socket.server.standard.ServerEndpointExporter"/>
     * </beans>
     * <p>
     * 检测所有带有@serverEndpoint注解的bean并注册他们。
     *
     * @return
     */
    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        System.out.println("我被注入了");
        return new ServerEndpointExporter();
    }
}

  1. Создайте новый класс обработки WebSocket

Этот класс обработки должен использовать @ServerEndpoint, который отслеживает установление и закрытие соединений, получение сообщений и т. д. Конкретный код выглядит следующим образом:


@ServerEndpoint(value = "/ws/asset")
@Component
public class WebSocketServer {

    @PostConstruct
    public void init() {
        System.out.println("websocket 加载");
    }
    private static Logger log = LoggerFactory.getLogger(WebSocketServer.class);
    private static final AtomicInteger OnlineCount = new AtomicInteger(0);
    // concurrent包的线程安全Set，用来存放每个客户端对应的Session对象。
    private static CopyOnWriteArraySet<Session> SessionSet = new CopyOnWriteArraySet<Session>();


    /**
     * 连接建立成功调用的方法
     */
    @OnOpen
    public void onOpen(Session session) {
        SessionSet.add(session);
        int cnt = OnlineCount.incrementAndGet(); // 在线数加1
        log.info("有连接加入，当前连接数为：{}", cnt);
        SendMessage(session, "连接成功");
    }

    /**
     * 连接关闭调用的方法
     */
    @OnClose
    public void onClose(Session session) {
        SessionSet.remove(session);
        int cnt = OnlineCount.decrementAndGet();
        log.info("有连接关闭，当前连接数为：{}", cnt);
    }

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

    }

    /**
     * 出现错误
     * @param session
     * @param error
     */
    @OnError
    public void onError(Session session, Throwable error) {
        log.error("发生错误：{}，Session ID： {}",error.getMessage(),session.getId());
        error.printStackTrace();
    }

    /**
     * 发送消息，实践表明，每次浏览器刷新，session会发生变化。
     * @param session
     * @param message
     */
    public static void SendMessage(Session session, String message) {
        try {
//            session.getBasicRemote().sendText(String.format("%s (From Server，Session ID=%s)",message,session.getId()));
            session.getBasicRemote().sendText(message);
        } catch (IOException e) {
            log.error("发送消息出错：{}", e.getMessage());
            e.printStackTrace();
        }
    }

    /**
     * 群发消息
     * @param message
     * @throws IOException
     */
    public static void BroadCastInfo(String message) throws IOException {
        for (Session session : SessionSet) {
            if(session.isOpen()){
                SendMessage(session, message);
            }
        }
    }

    /**
     * 指定Session发送消息
     * @param sessionId
     * @param message
     * @throws IOException
     */
    public static void SendMessage(String message,String sessionId) throws IOException {
        Session session = null;
        for (Session s : SessionSet) {
            if(s.getId().equals(sessionId)){
                session = s;
                break;
            }
        }
        if(session!=null){
            SendMessage(session, message);
        }
        else{
            log.warn("没有找到你指定ID的会话：{}",sessionId);
        }
    }
}

  1. создать новый html

В настоящее время большинство браузеров поддерживают WebSocket, например Chrome, Mozilla, Opera и Safari, для установления соединения через веб-сокет и отслеживания сообщения, полученного на html-странице.Код страницы выглядит следующим образом:

<html>
<head>
    <meta charset="UTF-8">
    <title>websocket测试</title>
    <script src="http://libs.baidu.com/jquery/2.0.0/jquery.min.js"></script>
    <style type="text/css">
        h3,h4{
            text-align:center;
        }
    </style>
</head>
<body>

<h3>WebSocket测试，客户端接收到的消息如下：</h3>

<textarea id = "messageId" readonly="readonly" cols="150" rows="30" >

</textarea>


<script type="text/javascript">
    var socket;
    if (typeof (WebSocket) == "undefined") {
        console.log("遗憾：您的浏览器不支持WebSocket");
    } else {
        console.log("恭喜：您的浏览器支持WebSocket");
        //实现化WebSocket对象
        //指定要连接的服务器地址与端口建立连接
        //注意ws、wss使用不同的端口。我使用自签名的证书测试，
        //无法使用wss，浏览器打开WebSocket时报错
        //ws对应http、wss对应https。
        socket = new WebSocket("ws://localhost:8080/ws/asset");
        //连接打开事件
        socket.onopen = function() {
            console.log("Socket 已打开");
            socket.send("消息发送测试(From Client)");
        };
        //收到消息事件
        socket.onmessage = function(msg) {
            $("#messageId").append(msg.data+ "\n");
            console.log(msg.data  );
        };
        //连接关闭事件
        socket.onclose = function() {
            console.log("Socket已关闭");
        };
        //发生了错误事件
        socket.onerror = function() {
            alert("Socket发生了错误");
        }
        //窗口关闭时，关闭连接
        window.unload=function() {
            socket.close();
        };
    }
</script>

</body>
</html>

3. Проверьте беговой эффект

Запустите проект SpringBoot

  1. Открыть дом

Локальный браузер открывает домашнюю страницу http://localhost:8080/, появляется тестовая страница WebSocket и в фоновом режиме печатается журнал подключения.

有连接加入，当前连接数为：1,sessionId=0

  1. Отправить сообщение клиенту

В приведенном выше журнале вы можете увидеть идентификатор сеанса подключения клиента. Во время тестирования идентификатор сеанса равен 0, а затем браузер может отправлять сообщения клиенту, получая доступ к следующему интерфейсу.

//参数说明： id：sessionID 
//参数说明： message：消息内容
http://localhost:8080/api/ws/sendOne?id=0&message=你好Java碎碎念

发送消息动图

На данный момент встроенные в SpringBoot функции WebSocket полностью реализованы.Если у вас есть какие-либо вопросы, оставьте сообщение для связи!

Полный исходный адрес:GitHub.com/Smash2019/…

Рекомендуемое чтение

1. Позвольте вам понять динамический SQL MyBatis за одну минуту!

2. Позвольте вам понять Spring Security за одну минуту!

3. Научитесь использовать mybatis-generator для автоматической генерации кода за одну минуту!

4. Рука об руку с вами в семи способах распространения транзакций Spring

5. Серия SpringBoot — интеграция Mybatis (метод аннотации)

***

Если вы считаете, что статья хорошая, я надеюсь, что вы можете переслать ее или «посмотреть», большое спасибо!

Подпишитесь на официальный аккаунт ниже и ответьте «1024», вас ждут сюрпризы!


Эта статья опубликована в блогеOpenWriteвыпуск!

Категории