spring+springmvc实现websoket2

水深无声 2022-06-08 04:57 53阅读 0赞

## 用注解@ServerEndpoint(“/websocket”) ##

1.  两种方法实现代码地址(包含相关jar包) :[http://pan.baidu.com/s/1dF2ElVV][http_pan.baidu.com_s_1dF2ElVV] 密码：8x6x  
    方法1：用注解@ServerEndpoint(“/websocket”)  
    方法2：spring-websocket-4.3.6.RELEASE.jar实现
2.  spring-websocket-4.3.6.RELEASE.jar实现websoket(登录式)  
    配置文件applicationContext-java.xml
3.  步骤  
    3.1添加Spring WebSocket的依赖jar包  
    spring-websocket-4.3.6.RELEASE.jar  
    spring-messaging-4.1.3.RELEASE.jar  
    3.2建立一个类实现WebSocketConfigurer接口

package com.spring.websoket;
    
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.servlet.config.annotation.EnableWebMvc;
    import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
    import org.springframework.web.socket.config.annotation.EnableWebSocket;
    import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
    import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
    import org.springframework.web.socket.handler.TextWebSocketHandler;
    
    
    @Configuration
    @EnableWebMvc
    @EnableWebSocket
    public class SpringWebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer {
        public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
            registry.addHandler(webSocketHandler(),"/websocket/socketServer.action").addInterceptors(new SpringWebSocketHandlerInterceptor());
            registry.addHandler(webSocketHandler(), "/sockjs/socketServer.action").addInterceptors(new SpringWebSocketHandlerInterceptor()).withSockJS();
        }
    
        @Bean
        public TextWebSocketHandler webSocketHandler(){
            return new SpringWebSocketHandler();
        }
    
    }

3.3继承WebSocketHandler对象：  
该对象提供了客户端连接,关闭,错误,发送等方法,重写这几个方法即可实现自定义业务逻辑

package com.spring.websoket;
    
    import java.io.IOException;
    import java.util.ArrayList;
    
    import org.apache.log4j.Logger;
    import org.springframework.stereotype.Component;
    import org.springframework.web.socket.CloseStatus;
    import org.springframework.web.socket.TextMessage;
    import org.springframework.web.socket.WebSocketSession;
    import org.springframework.web.socket.handler.TextWebSocketHandler;
    
    @Component
    public class SpringWebSocketHandler extends TextWebSocketHandler { 
        private static final ArrayList<WebSocketSession> users;
        //这个会出现性能问题，最好用Map来存储，key用userid
        private static Logger logger = Logger.getLogger(SpringWebSocketHandler.class);
        static {
            users = new ArrayList<WebSocketSession>();
        }
    
        public SpringWebSocketHandler() {
            // TODO Auto-generated constructor stub
            System.out.println("SpringWebSocketHandler");
        }
    
        /** * 连接成功时候，会触发页面上onopen方法 */
        public void afterConnectionEstablished(WebSocketSession session) throws Exception {
            // TODO Auto-generated method stub
            users.add(session);
            System.out.println("connect to the websocket success......当前数量:"+users.size());
    
            //这块会实现自己业务，比如，当用户登录后，会把离线消息推送给用户
            TextMessage returnMessage = new TextMessage("你将收到的离线");
            session.sendMessage(returnMessage);
        }
    
        /** * 关闭连接时触发 */
        public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
            logger.debug("websocket connection closed......");
            String username= (String) session.getAttributes().get("WEBSOCKET_USERNAME");
            System.out.println("用户"+username+"已退出！");
            users.remove(session);
            System.out.println("剩余在线用户"+users.size());
        }
    
        /** * js调用websocket.send时候，会调用该方法 */
        @Override    
        protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
            super.handleTextMessage(session, message);
            sendMessageToUser((String) session.getAttributes().get("WEBSOCKET_USERNAME"), message);
        }
    
        public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
            if(session.isOpen()){session.close();}
            logger.debug("websocket connection closed......");
            users.remove(session);
        }
    
        public boolean supportsPartialMessages() {
            return false;
        }
    
    
        /** * 给某个用户发送消息 * * @param userName * @param message */
        public void sendMessageToUser(String userName, TextMessage message) {
            for (WebSocketSession user : users) {
                if (user.getAttributes().get("WEBSOCKET_USERNAME").equals(userName)) {
                    try {
                        if (user.isOpen()) {
                            user.sendMessage(message);
                        }
                    } catch (IOException e) {
                        e.printStackTrace();
                    }
                    break;
                }
            }
        }
    
        /** * 给所有在线用户发送消息 * * @param message */
        public void sendMessageToUsers(TextMessage message) {
            for (WebSocketSession user : users) {
                try {
                    if (user.isOpen()) {
                        user.sendMessage(message);
                    }
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
    
    }

3.4继承HttpSessionHandshakeInterceptor对象：  
该对象作为页面连接websocket服务的拦截器

package com.spring.websoket;
    
    import java.util.Map;
    
    import javax.servlet.http.HttpSession;
    
    import org.springframework.http.server.ServerHttpRequest;
    import org.springframework.http.server.ServerHttpResponse;
    import org.springframework.http.server.ServletServerHttpRequest;
    import org.springframework.web.socket.WebSocketHandler;
    import org.springframework.web.socket.server.support.HttpSessionHandshakeInterceptor;
    
    /** * WebSocket拦截器 * @author WANG * */
    public class SpringWebSocketHandlerInterceptor extends HttpSessionHandshakeInterceptor { 
        @Override
        public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,
                Map<String, Object> attributes) throws Exception {
            // TODO Auto-generated method stub
            System.out.println("Before Handshake");
            if (request instanceof ServletServerHttpRequest) {
                ServletServerHttpRequest servletRequest = (ServletServerHttpRequest) request;
                HttpSession session = servletRequest.getServletRequest().getSession(false);
                if (session != null) {
                    //使用userName区分WebSocketHandler，以便定向发送消息
                    String userName = (String) session.getAttribute("SESSION_USERNAME");
                    if (userName==null) {
                        userName="default-system";
                    }
                    attributes.put("WEBSOCKET_USERNAME",userName);
                }
            }
            return super.beforeHandshake(request, response, wsHandler, attributes);
    
        }
    
        @Override
        public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,
                Exception ex) {
            // TODO Auto-generated method stub
            super.afterHandshake(request, response, wsHandler, ex);
        }
    }

3.5让SpringWebSocketConfig配置类随spring容器启动 spring文件：applicationContext-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
    <beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.1.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.1.xsd">
    
    
        
        <context:component-scan base-package="com.spring.websoket"/>
    
    </beans>

3.6准备测试类  
WebsocketController类

package com.spring.websoket;
    
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    import javax.servlet.http.HttpSession;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.context.annotation.Bean;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.ResponseBody;
    import org.springframework.web.servlet.ModelAndView;
    import org.springframework.web.socket.TextMessage;
    
    
    @Controller
    public class WebsocketController {
        //这个注解会从Spring容器拿出Bean
    //  @Bean
    //    public SpringWebSocketHandler infoHandler() {
    //        return new SpringWebSocketHandler();
    //    }
    
        @Autowired
        private SpringWebSocketHandler springWebSocketHandler;
    
        @RequestMapping("/websocket/login1")
        public ModelAndView login1(HttpServletRequest request, HttpServletResponse response) throws Exception {
    
            return new ModelAndView("spring-websoket/login");
        }
    
        @RequestMapping("/websocket/login")
        public ModelAndView login(HttpServletRequest request, HttpServletResponse response) throws Exception {
            String username = request.getParameter("username");
            System.out.println(username+"登录");
            HttpSession session = request.getSession(false);
            session.setAttribute("SESSION_USERNAME", username);
            //response.sendRedirect("/quicksand/jsp/websocket.jsp");
            return new ModelAndView("spring-websoket/index");
        }
    
        @RequestMapping(value = "/websocket/send", produces="text/html;charset=UTF-8")
        @ResponseBody
        public String send(HttpServletRequest request) {
            String username = request.getParameter("username");
            // 用注解发送内容
            //infoHandler().sendMessageToUser(username, new TextMessage("你好，测试！！！！"));
    
            TextMessage returnMessage = new TextMessage("你好，测试！！！！");
            //TextMessage t = new TextMessage("你好，测试！！！！");
            springWebSocketHandler.sendMessageToUser(username, returnMessage);
            return returnMessage.getPayload();
        }
    }

index.jsp

<%@ page language="java" contentType="text/html; charset=utf-8" pageEncoding="utf-8"%>
    <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    <html>
    <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    <title>spring-websoket</title>
    </head>
    <body>
    <script type="text/javascript" src="http://cdn.bootcss.com/jquery/3.1.0/jquery.min.js"></script>
    <script type="text/javascript" src="http://cdn.bootcss.com/sockjs-client/1.1.1/sockjs.js"></script>
    <script type="text/javascript"> var websocket = null; if ('WebSocket' in window) { websocket = new WebSocket("ws://localhost:8082/websoket_test/websocket/socketServer.action"); } else if ('MozWebSocket' in window) { websocket = new MozWebSocket("ws://localhost:8082/websoket_test/websocket/socketServer.action"); } else { websocket = new SockJS("http://localhost:8082/websoket_test/sockjs/socketServer.action"); } websocket.onopen = onOpen; websocket.onmessage = onMessage; websocket.onerror = onError; websocket.onclose = onClose; function onOpen(openEvt) { alert(openEvt.data); } function onMessage(evt) { console.log(evt) alert(evt.data); } function onError() { } function onClose() { } function doSend() { if (websocket.readyState == websocket.OPEN) { var msg = document.getElementById("inputMsg").value; websocket.send(msg);//调用后台handleTextMessage方法 alert("发送成功!"); } else { alert("连接失败!"); } } 　　window.close = function(){ 　　　　websocket.onclose(); 　　} $.ajax({url:"/websoket_test/websocket/send.action",success:function(result){ //console.log(result) /* var ws = null; if ('WebSocket' in window) { ws = new WebSocket("ws://localhost:8082/websoket_test/websocket/socketServer.action"); } ws.onopen = function () { console.log("onpen"); ws.send("{}"); } ws.onclose = function () { console.log("onclose"); } ws.onmessage=function(evt){ console.log(evt) alert(evt.data); }; */ // 靠回传参数显示soket信息 var data = {}; data.data = result; websocket.onmessage(data) }}); </script>
    请输入：<textarea rows="5" cols="10" id="inputMsg" name="inputMsg"></textarea>
    <button onclick="doSend();">发送</button>
    </body>
    </html>

web.xml

<?xml version="1.0" encoding="UTF-8"?>
    <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" version="2.5">
    
        <context-param>
            <param-name>contextConfigLocation</param-name>
            
            
             
             <param-value>classpath:applicationContext-spring.xml</param-value>
        </context-param>
        <listener>
            <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
        </listener>
        <listener>
            <listener-class>org.springframework.web.util.IntrospectorCleanupListener</listener-class>
        </listener>
        <servlet>
        <servlet-name>springmvc</servlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
        <init-param>
          <param-name>contextConfigLocation</param-name>
          <param-value>classpath:springmvc.xml</param-value>
        </init-param>
      </servlet>
      <servlet-mapping>
        <servlet-name>springmvc</servlet-name>
        <url-pattern>*.action</url-pattern>
      </servlet-mapping>
        <filter>
        <filter-name>CharacterEncodingFilter</filter-name>
        <filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
        <init-param>
          <param-name>encoding</param-name>
          <param-value>utf-8</param-value>
        </init-param>
      </filter>
      <filter-mapping>
        <filter-name>CharacterEncodingFilter</filter-name>
        <url-pattern>*.action</url-pattern>
      </filter-mapping>
    </web-app>

4.访问地址：[http://localhost:8082/websoket\_test/websocket/login1.action][http_localhost_8082_websoket_test_websocket_login1.action]  
![这里写图片描述][SouthEast]  
![这里写图片描述][SouthEast 1]

[http_pan.baidu.com_s_1dF2ElVV]: http://pan.baidu.com/s/1dF2ElVV
[http_localhost_8082_websoket_test_websocket_login1.action]: http://localhost:8082/websoket_test/websocket/login1.action
[SouthEast]: /images/20220608/1ac3bf3af792456b8893645fe41cce2e.png
[SouthEast 1]: /images/20220608/dc97d427fa284f51a09cfc6cc73f0972.png