玩转springboot2.x之整合webSocket篇

版权声明:本文为博主原创文章,遵循 CC 4.0 by-sa 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/ljk126wy/article/details/82814086

关于webSocket是什么我在这里不做过多的阐述 请参看文档:https://www.cnblogs.com/fuqiang88/p/5956363.html进行了解

我们直接进入实在代码让你来感受他是个什么东东。

首先第一步需要我们引入websocket的依赖

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

如果使用外置的tomcat 需要引入javaee-api 我们这里不引入是因为我们使用的是内置的tomcat,spring-boot 内置tomcat 包含拉javaee-api 。

第二步配置webSocket 配置信息 也就是配置webSocket 服务端点

    package cn.lijunkui.springbootlearn.socket.config;
     
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.stereotype.Component;
    import org.springframework.web.socket.server.standard.ServerEndpointExporter;
     
    import javax.websocket.server.ServerEndpoint;
     
    @Configuration
    public class WebSocketConfig {
        @Bean
        public ServerEndpointExporter serverEndpointExporter(){
            return new ServerEndpointExporter();
        }
    }

第三步 开发接受和处理消息的处理类

    package cn.lijunkui.springbootlearn.socket;
     
    import org.springframework.stereotype.Controller;
     
    import javax.websocket.*;
    import javax.websocket.server.ServerEndpoint;
    import java.io.IOException;
    import java.util.concurrent.CopyOnWriteArraySet;
     
    @Controller
    @ServerEndpoint("/websocket")
    public class Socket {
        /*websocket 客户端会话 通过Session 向客户端发送数据*/
        private Session session;
        /*线程安全set 存放每个客户端处理消息的对象*/
        private static CopyOnWriteArraySet<Socket> webSocketSet = new CopyOnWriteArraySet();
        /*websocket 连接建立成功后进行调用*/
        @OnOpen
        public void onOpen(Session session) {
            this.session = session;
            webSocketSet.add(this);
            System.out.println("websocket 有新的链接"+webSocketSet.size());
        }
        /*websocket 链接关闭调用的方法*/
        @OnClose
        public void onClose() {
            webSocketSet.remove(this);
        }
        /*收到客户端消息后调用的方法*/
        @OnMessage
        public void onMessage(String message) throws IOException {
            for (Socket socket : webSocketSet) {
                socket.session.getBasicRemote().sendText("自己嘎给自己嘎发的消息:"+message);
            }
        }
        /*websocket 发生错误时进行调用*/
        @OnError
        public void onError(Session session,Throwable error){
            error.printStackTrace();
        }
        public void sendMessage(String message) throws IOException {
            for (Socket socket : webSocketSet) {
                socket.session.getBasicRemote().sendText(message);
            }
        }
        public Session getSession() {
            return session;
        }
        public void setSession(Session session) {
            this.session = session;
        }
    }

第四部编写客户端访问页面 socket.html

    <!DOCTYPE html>
    <html lang="en">
    <head>
        <meta charset="UTF-8">
        <title>socket demo</title>
    </head>
    <body>
        <h2>学说话的tom 猫</h2>
        <div><label>消息内容:</label><p id="serverMessage"></p></div>
        <div><label>我对自己说:</label><input id="sendMessage" type="text" />&nbsp;&nbsp;&nbsp;&nbsp;<button οnclick="send()">发送</button></div>
     
    <script type="text/javascript">
     
        var websocket = null;
        if('WebSocket' in window){
            websocket = new WebSocket('ws://localhost:8080/bootlearn/websocket');
        }else{
            alert("该游览器不知此WebSocket");
        }
        //websocket 链接成功后进行触发
        websocket.onopen = function (event){
            console.log("建立链接。。。。");
        }
        //websocket 链接关闭的进行触发
        websocket.onclose = function (event){
            console.log("关闭链接。。。。");
        }
        //接收到消息的进行触发
        websocket.onmessage = function(event){
            var serverMessage = document.getElementById("serverMessage");
            serverMessage.innerHTML= event.data;
            console.log("收到消息");
        }
     
        //连接发生错误的进行触发
        websocket.onerror = function(evt)
        {
            console.log("WebSocketError!");
        }
        //当窗口关闭时,主动去关闭websocket连接,防止连接还没断开就关闭窗口,server端会抛异常。
        window.onbeforeunload = function (){
            websocket.close();
        }
        //关闭websocket连接
        function closeWebSocket(){
            websocket.close();
        }
        //发送消息
        function send(){
            var sendIput = document.getElementById("sendMessage");
            var sendMessage = sendIput.value;
            if(sendMessage.trim() == ""){
                alert("请输入发送消息!")
                return;
            }
            websocket.send(sendMessage);
        }
     
    </script>
    </body>
    </html>

第五步编写通过后台发送消息的Controller

    package cn.lijunkui.springbootlearn.socket;
     
    import org.springframework.beans.factory.annotation.Autowired;
    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.RestController;
     
    import java.io.IOException;
     
    @RestController
    @RequestMapping("socket")
    public class SocketTestController {
        @Autowired
        private Socket socket;
        @GetMapping("/{message}")
        public void sendMessage(@PathVariable("message") String message) throws IOException {
            socket.sendMessage("这个是controller 发送的消息:"+message);
        }
    }

第六步 编写通过后台进行消息的发送controllerTest.html

    <!DOCTYPE html>
    <html lang="en">
    <head>
        <meta charset="UTF-8">
        <title>Title</title>
    </head>
    <body>
    <h2>通过controller 进行发送消息</h2>
    <input type="text" id="sendMessage"><button οnclick="controllerSend()">发送</button>
    </body>
    <script language="JavaScript">
        function controllerSend(){
            var sendIput = document.getElementById("sendMessage");
            var sendMessage = sendIput.value;
            if(sendMessage.trim() == ""){
                alert("请输入发送消息!")
                return;
            }
            //创建异步对象
            var xhr = new XMLHttpRequest();
            //设置请求的类型及url
            xhr.open('get', 'http://localhost:8080/bootlearn/socket/'+sendMessage );
            //发送请求
            xhr.send();
            xhr.onreadystatechange = function () {
                // 这步为判断服务器是否正确响应
                if (xhr.readyState == 4 && xhr.status == 200) {
                    console.log(xhr.responseText);
                }
            };
        }
    </script>
    </html>

好啦代码部分编写完毕 接下来我们开始进行测试

启动springBoot

第二步打开游览器 访问socket.html

发送消息:

访问controller 发送测试页面

发送消息


---------------------
版权声明:本文为CSDN博主「IT乌托邦-桌前明月」的原创文章,遵循CC 4.0 by-sa版权协议,转载请附上原文出处链接及本声明。
原文链接:https://blog.csdn.net/ljk126wy/article/details/82814086

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
好的,我可以帮你解答这个问题。首先,你需要在 pom.xml 文件中引入 Spring Boot 的 websocket 依赖: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> ``` 然后,你需要创建一个 WebSocket 配置类,例如: ```java @Configuration @EnableWebSocket public class WebSocketConfig implements WebSocketConfigurer { @Override public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) { registry.addHandler(myHandler(), "/myHandler").setAllowedOrigins("*"); } @Bean public WebSocketHandler myHandler() { return new MyHandler(); } } ``` 在上面的代码中,我们创建了一个 WebSocket 配置类,并实现了 WebSocketConfigurer 接口。在 registerWebSocketHandlers 方法中,我们注册了一个名为 myHandler 的 WebSocket 处理器。在 setAllowedOrigins 方法中,我们设置了允许跨域访问。 接下来,你需要创建一个 WebSocket 处理器类,例如: ```java public class MyHandler implements WebSocketHandler { @Override public void afterConnectionEstablished(WebSocketSession session) throws Exception { System.out.println("WebSocket 连接成功"); } @Override public void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception { System.out.println("WebSocket 收到消息:" + message.getPayload()); session.sendMessage(new TextMessage("Hello, " + message.getPayload())); } @Override public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception { System.out.println("WebSocket 连接出错"); } @Override public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception { System.out.println("WebSocket 连接关闭"); } @Override public boolean supportsPartialMessages() { return false; } } ``` 在上面的代码中,我们创建了一个名为 MyHandler 的 WebSocket 处理器类,并实现了 WebSocketHandler 接口。在 afterConnectionEstablished 方法中,我们处理 WebSocket 连接成功的逻辑。在 handleMessage 方法中,我们处理 WebSocket 收到消息的逻辑,并向客户端发送一条消息。在 handleTransportError 方法中,我们处理 WebSocket 连接出错的逻辑。在 afterConnectionClosed 方法中,我们处理 WebSocket 连接关闭的逻辑。在 supportsPartialMessages 方法中,我们返回 false,表示不支持分段消息。 最后,你需要在你的 Spring Boot 应用中启动 WebSocket,例如: ```java @SpringBootApplication public class MyApplication { public static void main(String[] args) { SpringApplication.run(MyApplication.class, args); } } ``` 现在,你已经成功地基于 Spring Boot 2.3.12.RELEASE 使用了 WebSocket。你可以通过访问 ws://localhost:8080/myHandler 来测试你的 WebSocket 应用。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值