• springboot websocket全套模板,省去搭建的烦恼


    websocket 的基本创建,前后端测试。

    在springboot的环境下创建普通的websocket 和 reactor模式的 websocket

    1、聊点技术

    1.websocket出现的原因

    Web Socket是Html5中引入的通信机制,它为浏览器与后台服务器之间提供了基于TCP的全双工的通信通道。

    是为了解决网页及时刷新页面时长轮询的问题。

    webSocket在建立之前需要先与后台服务器进行握手,然后升级为socket连接。

    2、websocket协议对比

    Http:解决长轮询的问题,减少协议头,http会在每次协议的时候携带http header

    socket:对比socket 会多一次握手

    3、websocket协议

    ws和wss分别代表明文和密文的websocket协议

    和http ,https 一样的区别

    ws://localhost:8080/websocket

    https 则是wss

    4、游戏的选择

    常规选择tcp 协议,

    对于页游,或者一些使用js开发的使用websocket

    对实时性要求较高的使用udp,kdp 等类似可靠udp协议

    2、普通的websocket服务器

    常规的springboot创建,在创建项目的时候,勾选websocket

    或者直接在pom添加依赖,同样的效果

    1. <dependency>
    2. <groupId>org.springframework.boot</groupId>
    3. <artifactId>spring-boot-starter-websocket</artifactId>
    4. </dependency>

    将需要公开的协议进行暴露

    1. @Configuration
    2. public class WebsocketConfig {
    3. @Bean
    4. public ServerEndpointExporter serverEndpointExporter(){
    5. return new ServerEndpointExporter();
    6. }
    7. }

    websocket的服务端协议,最简版,去掉了一些有的没的,这里只是一个模板,根据自己的业务填充扩展

    1. import org.slf4j.Logger;
    2. import org.slf4j.LoggerFactory;
    3. import org.springframework.stereotype.Component;
    4. import javax.websocket.*;
    5. import javax.websocket.server.ServerEndpoint;
    6. @Component
    7. @ServerEndpoint("/websocket")
    8. public class WebsocketServer {
    9. private static Logger logger = LoggerFactory.getLogger(WebsocketServer.class);
    10. /**
    11. * 连接建立成功调用的方法
    12. */
    13. @OnOpen
    14. public void onOpen(Session session) {
    15. try {
    16. logger.info("建立连接");
    17. } catch (Exception e) {
    18. logger.error("websocket IO异常");
    19. }
    20. }
    21. /**
    22. * 连接关闭调用的方法
    23. */
    24. @OnClose
    25. public void onClose() {
    26. logger.info("连接关闭!");
    27. }
    28. /**
    29. * 收到客户端消息后调用的方法
    30. *
    31. * @param message 客户端发送过来的消息
    32. */
    33. @OnMessage
    34. public void onMessage(String message, Session session) {
    35. logger.info("收到来自窗口 {} 的信息:{}" ,session.getId(), message);
    36. }
    37. /**
    38. * @param session
    39. * @param error
    40. */
    41. @OnError
    42. public void onError(Session session, Throwable error) {
    43. logger.error("发生错误");
    44. error.printStackTrace();
    45. }
    46. }

    这是个最普通的websocket的协议,可以看到在springboot是非常简单的

    3、reactor模式的websocket

    因为公司有些项目是使用的webflux,虽然一直很不习惯,也不喜欢,但是没办法,硬着头皮上,也记录一个模板。

    在创建项目的时候勾选 Spring Reactive web

    同样也可以直接在pom中增加依赖

    1. <dependency>
    2. <groupId>org.springframework.boot</groupId>
    3. <artifactId>spring-boot-starter-webflux</artifactId>
    4. </dependency>

    配置下处理器,可以看到拆分的接口很不友好,难用,需要自己拆

    1. import org.slf4j.Logger;
    2. import org.slf4j.LoggerFactory;
    3. import org.springframework.stereotype.Component;
    4. import org.springframework.web.reactive.socket.WebSocketHandler;
    5. import org.springframework.web.reactive.socket.WebSocketSession;
    6. import reactor.core.publisher.Mono;
    7. /**
    8. * 处理websocket
    9. */
    10. @Component("websocketHandler")
    11. public class TestWebsocketHandler implements WebSocketHandler {
    12. private Logger logger = LoggerFactory.getLogger(TestWebsocketHandler.class);
    13. @SuppressWarnings("unchecked")
    14. @Override
    15. public Mono<Void> handle(WebSocketSession session) {
    16. return session.receive().doOnNext(webSocketMessage -> {
    17. session.send(Mono.just(session.textMessage("hello reactor"))).subscribe();
    18. }).then();
    19. }
    20. }

    配置一下匹配的接口,也就是暴露端口。

    1. import org.springframework.beans.factory.annotation.Autowired;
    2. import org.springframework.beans.factory.annotation.Qualifier;
    3. import org.springframework.context.annotation.Bean;
    4. import org.springframework.context.annotation.Configuration;
    5. import org.springframework.web.reactive.HandlerMapping;
    6. import org.springframework.web.reactive.handler.SimpleUrlHandlerMapping;
    7. import org.springframework.web.reactive.socket.WebSocketHandler;
    8. import org.springframework.web.reactive.socket.client.ReactorNettyWebSocketClient;
    9. import reactor.netty.http.client.HttpClient;
    10. import reactor.netty.http.client.WebsocketClientSpec;
    11. import reactor.netty.http.server.WebsocketServerSpec;
    12. import java.util.HashMap;
    13. import java.util.Map;
    14. @Configuration
    15. public class WebSocketConfig {
    16. @Bean
    17. public HandlerMapping webSocketMapping(
    18. @Autowired @Qualifier("websocketHandler") WebSocketHandler websocketHandler) {
    19. Map<String, Object> map = new HashMap<>();
    20. map.put("/websocket",websocketHandler );
    21. SimpleUrlHandlerMapping simpleUrlHandlerMapping = new SimpleUrlHandlerMapping();
    22. simpleUrlHandlerMapping.setUrlMap(map);
    23. simpleUrlHandlerMapping.setOrder(10);
    24. return simpleUrlHandlerMapping;
    25. }
    26. @Bean
    27. public ReactorNettyWebSocketClient nettyWebsockerClient(){
    28. ReactorNettyWebSocketClient proxyClient = new ReactorNettyWebSocketClient(HttpClient.create(),
    29. () -> WebsocketClientSpec.builder().maxFramePayloadLength(64 * 1024 * 1024));
    30. return proxyClient;
    31. }
    32. }

    4、一个简单的websocket客户端

    只是为了测试,简单的一个客户端源码

    1. <!DOCTYPE html>
    2. <html>
    3. <head>
    4. <meta charset="UTF-8">
    5. <title>我是香菜</title>
    6. </head>
    7. <body>
    8. <textarea id="msgBoxs"></textarea><br>
    9. 待发送消息:<input type="text" id="msg"><input type="button" id="sendBtn" onclick="send()" value="发送">
    10. <script type="application/javascript">
    11. var msgBoxs = document.getElementById("msgBoxs")
    12. var msgBox = document.getElementById("msg")
    13. document.cookie="token2=John Doe";
    14. var ws = new WebSocket("ws://localhost:8080/websocket")
    15. ws.onopen = function (evt) {
    16. console.log("Connection open ...");
    17. ws.send("Hello WebSocket!");
    18. }
    19. ws.onmessage = function (evt) {
    20. console.log("Received Message: ", evt.data)
    21. var msgs = msgBoxs.value
    22. msgBoxs.innerText = msgs + "\n" + evt.data
    23. msgBoxs.scrollTop = msgBoxs.scrollHeight;
    24. }
    25. ws.onclose = function (evt) {
    26. console.log("Connect closed.");
    27. }
    28. function send() {
    29. var msg = msgBox.value
    30. ws.send(msg)
    31. msgBox.value = ""
    32. }
    33. </script>
    34. </body>
    35. </html>

    5、总结

    websocket 在web开发中比较常用,一般是为了提升效率,在游戏用的比较少,因为有socket直接用。不会在选择多一步升级,同时也不需要使用http了,减轻负担。

  • 相关阅读:
    【mindspore1.5.0】安装mindspore报libcuda.so没找到和libcudnn没找到
    Python的计算性能优化
    Java 17 VS Java 8: 新旧对决,这些Java 17新特性你不容错过
    java上传图片到FTP服务器
    呼叫中心系统信息发送功能的应用
    【自动微分原理】自动微分的具体实现
    AFFiNE文档工具
    Jetpack:013-Jetpack底部导航栏
    DRM全解析 —— ADD_FB2(5)
    微服务(二) php laravel 用户客户端
  • 原文地址:https://blog.csdn.net/l688899886/article/details/125502088