spring整合websocket+stomp(二)

一时失言乱红尘 2023-07-23 04:55 25阅读 0赞

1.pom.xml引入相关依赖

<dependency>
    	<groupId>org.springframework</groupId>
    	<artifactId>spring-websocket</artifactId>
    	<version>${spring.version}</version>
    </dependency>
    <dependency>  
    	<groupId>org.springframework</groupId>  
    	<artifactId>spring-messaging</artifactId>  
    	<version>${spring.version}</version>
    </dependency>
    <dependency>
        <groupId>javax.websocket</groupId>
        <artifactId>javax.websocket-api</artifactId>
        <version>1.1</version>
        <scope>provided</scope>
       </dependency>

2.WebSocketStompConfig .java

import org.springframework.context.annotation.Configuration;
    import org.springframework.messaging.simp.config.MessageBrokerRegistry;
    import org.springframework.web.socket.config.annotation.AbstractWebSocketMessageBrokerConfigurer;
    import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker;
    import org.springframework.web.socket.config.annotation.StompEndpointRegistry;
    
    
    @Configuration
    @EnableWebSocketMessageBroker //启用STOMP协议消息代理来传递消息
    public class WebSocketStompConfig extends AbstractWebSocketMessageBrokerConfigurer{ 
    
    	/** * * @Title: registerStompEndpoints * @Description: 注册STOMP端点 * @param registry STOMP端点注册器 */
    	public void registerStompEndpoints(StompEndpointRegistry registry) { 
    		registry.addEndpoint(Constant.WEBSOCKET_STOMP)//添加一个端点，客户端通过这个端点来连接
    		.addInterceptors(new HandleShakeInterceptors())//添加socket拦截器，用于从请求中获取客户端标识参数
    		.setAllowedOrigins("*")//允许跨域,默认只能在同域名下
    		.withSockJS();//启用socketjs
    		
    	}
    	
    	/** * * @Title: configureMessageBroker * @Description: 消息代理配置，使用基于内存的消息代理 * @param registry 消息代理注册表 */
    	@Override
    	public void configureMessageBroker(MessageBrokerRegistry registry) { 
    		// 如果消息端点是 /topic 或 /queue 开头的，则直接转发给消息代理(内存或其他MQ，如RabbitMQ等)
    		registry.enableSimpleBroker("/topic", "/queue");
    		// 端点以app开头的消息将会自动路由给@MessageMapping标注的Controller方法上
    		registry.setApplicationDestinationPrefixes("/app");
            //服务端通知客户端的前缀，可以不设置，默认为user
    		registry.setUserDestinationPrefix("/user");
    		//registry.setPathMatcher(new AntPathMatcher(".")); //可以以“.”来分割路径，看看类级别的@messageMapping和方法级别的@messageMapping
    		/* 如果是用自己的消息中间件，则按照下面的去配置，删除上面的配置 * registry.enableStompBrokerRelay("/topic", "/queue") .setRelayHost("rabbit.someotherserver") .setRelayPort(62623) .setClientLogin("marcopolo") .setClientPasscode("letmein01"); registry.setApplicationDestinationPrefixes("/app", "/foo"); * */
    	}
    }

3.HandleShakeInterceptors.java

import java.util.Map;
    
    import org.springframework.http.server.ServerHttpRequest;
    import org.springframework.http.server.ServerHttpResponse;
    import org.springframework.web.socket.WebSocketHandler;
    import org.springframework.web.socket.server.HandshakeInterceptor;
    
    
    
    /** * 检查握手请求和响应, 对WebSocketHandler传递属性 */
    public class HandleShakeInterceptors implements HandshakeInterceptor { 
    
    	/** * 在握手之前执行该方法, 继续握手返回true, 中断握手返回false. * 通过attributes参数设置WebSocketSession的属性 * * @param request * @param response * @param wsHandler * @param attributes * @return * @throws Exception */
    	
    	public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response,
                                       WebSocketHandler wsHandler, Map<String, Object> attributes) throws Exception { 
            //保存客户端标识
            String userid = UserUtils.getUser().getId();
     		if (userid == null) { 
     			userid = "default-system";
     		}
     		attributes.put(Constant.WEBSOCKET_USERID, userid);
            return true;
        }
    
        /** * 在握手之后执行该方法. 无论是否握手成功都指明了响应状态码和相应头. * * @param request * @param response * @param wsHandler * @param exception */
        public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response,
                                   WebSocketHandler wsHandler, Exception exception) { 
    
        }
        
    }

4.web.xml

<servlet>
    		<servlet-name>springServlet</servlet-name>
    		<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    		<init-param>
    			<param-name>contextConfigLocation</param-name>
    			<param-value>classpath*:/spring-mvc*.xml</param-value>
    		</init-param>
    		<load-on-startup>1</load-on-startup>
    		
    		<async-supported>true</async-supported>
    	</servlet>
    	<servlet-mapping>
    		<servlet-name>springServlet</servlet-name>
    		<url-pattern>/</url-pattern>
    	</servlet-mapping>

5.spring-mvc.xml  
use-default-filters="true"为默认配置，即允许Spring扫描配置包下的所有组件;  
use-default-filters="false"仅允许Spring控制网站的跳转逻辑，会忽略掉@Message注解。

<context:component-scan base-package="com.thinkgem.jeesite">
    		<context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
    		<context:include-filter type="annotation" expression="org.springframework.messaging.handler.annotation.MessageMapping"/>
    	</context:component-scan>

6.StompController.java

import java.io.UnsupportedEncodingException;
    
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.messaging.MessagingException;
    import org.springframework.messaging.handler.annotation.MessageMapping;
    import org.springframework.messaging.simp.SimpMessagingTemplate;
    import org.springframework.stereotype.Controller;
    import org.springframework.ui.Model;
    import org.springframework.web.bind.annotation.RequestMapping;
    
    
    /** * 首先通过/stomp建立连接， * 然后通过客户端向服务端推送数据sendName,匹配到该controller, * 然后通过controller传输数据，前端订阅/topic/sub，服务端推送到该地址，前端在处理解析该参数的数据 * * 没有推送消息，客户端没有触发该服务端向客户端的条件，还有一种情况websocket断开连接 * （1）以 /app 开头的消息都会被路由到带有 @MessageMapping 或 @SubscribeMapping 注解的方法中； * （2）以/topic 或 /queue 开头的消息都会发送到STOMP代理中，根据你所选择的STOMP代理不同，目的地的可选前缀也会有所限制； * （2）以/user开头的消息会将消息重路由到某个用户独有的目的地上。 */
    @Controller
    public class StompController { 
    
        @Autowired
        SimpMessagingTemplate SMT;
    
        @MessageMapping("/send")
        public void subscription(String str) throws MessagingException, UnsupportedEncodingException{ 
            System.err.println(str);
            SMT.convertAndSend("/topic/sub", "开始推送消息了：" + str);
        }
    
        @RequestMapping("/socket")
    	public String hello(HttpServletRequest request,HttpServletResponse response,Model model) { 
        	String url = request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort() + request.getContextPath();
    		model.addAttribute("addrUrl", url + "/" + Constant.WEBSOCKET_STOMP);
    		return "socket";
    	}
    }

7.socket.jsp

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
    <%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core"%>
    <!DOCTYPE html>
    <html lang="en">
    <head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>stomp</title>
     <link href="https://cdn.bootcss.com/bootstrap/4.1.1/css/bootstrap.min.css" rel="stylesheet">
        <script src="https://cdn.bootcss.com/jquery/3.3.1/jquery.min.js"></script>
        <script src="https://cdn.bootcss.com/sockjs-client/1.1.4/sockjs.min.js"></script>
        <script src="https://cdn.bootcss.com/stomp.js/2.3.3/stomp.min.js"></script>
       
    </head>
    <body>
    <noscript><h2 style="color: #ff0000">Seems your browser doesn't support Javascript! Websocket relies on Javascript being
        enabled. Please enable
        Javascript and reload this page!</h2></noscript>
    <div id="main-content" class="container">
        <div class="row">
            <div class="col-md-6">
                <form class="form-inline">
                	<div class="form-group">
                        <label for="connect">register an user,input name:</label>
                        <input type="text" id="username" class="form-control" placeholder="Your name here...">
                        <button id="confirm" class="btn btn-default" type="submit">confirm</button>
                    </div>
                    <div class="form-group">
                        <label for="connect">WebSocket connection:</label>
                        <button id="connect" class="btn btn-default" type="submit">Connect</button>
                        <button id="disconnect" class="btn btn-default" type="submit" disabled="disabled">Disconnect
                        </button>
                    </div>
                </form>
            </div>
            <div class="col-md-6">
                <form class="form-inline">
                    <div class="form-group">
                        <label for="name">What is your name?</label>
                        <input type="text" id="name" class="form-control" placeholder="Your name here...">
                    </div>
                    <button id="send" class="btn btn-default" type="submit">Send</button>
                </form>
            </div>
        </div>
        <div class="row">
            <div class="col-md-12">
                <table id="conversation" class="table table-striped">
                    <thead>
                    <tr>
                        <th>Greetings</th>
                    </tr>
                    </thead>
                    <tbody id="greetings">
                    </tbody>
                </table>
            </div>
        </div>
    </div>
    <script type="text/javascript"> /** * */ var stompClient = null; function setConnected(connected) { $("#connect").prop("disabled", connected); $("#disconnect").prop("disabled", !connected); if (connected) { $("#conversation").show(); } else { $("#conversation").hide(); } $("#greetings").html(""); } var userId="${userId}"; function connect() { var socket = new SockJS('${addrUrl}'); stompClient = Stomp.over(socket); stompClient.connect({ }, function (frame) { setConnected(true); console.log('Connected: ' + frame); stompClient.subscribe('/topic/sub', function (respone) { showGreeting(respone.body); }); // 订阅错误信息 stompClient.subscribe('/queue/errors', function (data) { console.log("error : " + data); showGreeting(data.body); }); /* stompClient.subscribe('/user/queue/sub', function (respone) { debugger showGreeting(respone.body); }); */ stompClient.subscribe('/user/topic/sub', function (greeting) { showGreeting(greeting.body); }); }, function (error) { console.log("STOMP error : " + error); }); } function disconnect() { if (stompClient !== null) { stompClient.disconnect(); } setConnected(false); console.log("Disconnected"); } function sendName() { //stompClient.send("/topic/sub", {},$("#name").val()); stompClient.send("/app/send",{ },$("#name").val()); } function showGreeting(message) { $("#greetings").append("<tr><td>" + message + "</td></tr>"); } $(function () { $("form").on('submit', function (e) { e.preventDefault(); }); $( "#connect" ).click(function() { connect(); }); $( "#disconnect" ).click(function() { disconnect(); }); $( "#send" ).click(function() { sendName(); }); $("#confirm").click(function(){ username=$("#username").val();connect();}); }); </script>
    </body>
    </html>