spring websocket 基于编码的方式手动进行推送

小咪咪 2022-08-21 07:47 127阅读 0赞

spring websocket基于注解的@SendTo和@SendToUser虽然方便，但是有局限性，例如我这样子的需求，我想手动的把消息推送给某个人，或者特定一组人，怎么办，@SendTo只能推送给所有人，@SendToUser只能推送给请求消息的那个人，这时，我们可以利用SimpMessagingTemplate这个类

SimpMessagingTemplate有俩个推送的方法

convertAndSend(destination, payload); //将消息广播到特定订阅路径中，类似@SendTo  
convertAndSendToUser(user, destination, payload);//将消息推送到固定的用户订阅路径中，类似@SendToUser

实现需求之前，我们来关注下websocket的一个ApplicationListener事件，SessionConnectedEvent，你可以订阅它，然后websocket通道链接成功之后，就广播这个事件

public class MySessionConnectedEvent implements ApplicationListener<SessionConnectedEvent> { 
    
        @Override
        public void onApplicationEvent(SessionConnectedEvent event) {
    
    
        }
    }

注册下这个接收事件到spring容器中，这里通过java config的方式注册

@Configuration
    public class AppConfig { 
    
        @Bean
        public MySessionConnectedEvent mySessionConnectedEvent(){
    
            return new MySessionConnectedEvent();
        }
    
    }

通过这个事件，我们可以把用户的登录授权信息保存起来，放到ServletContext中，以便于我们在推送消息的时候，拿到用户信息，当然，这里你也可以把用户的登录授权信息保存到其他的缓存策略中。

public class MySessionConnectedEvent implements ApplicationListener<SessionConnectedEvent> { 
    
        @SuppressWarnings("unchecked")
        @Override
        public void onApplicationEvent(SessionConnectedEvent event) {
    
            StompHeaderAccessor headers = StompHeaderAccessor.wrap(event.getMessage()); //获取消息头
            String name = headers.getUser().getName(); //获取账号名
            ServletContext sc = SpringBeanUtil.getServletContext(); //SpringBeanUtil的作用就是获取ServletContext 
            Object obj = sc.getAttribute("users");
            Map<String, Principal> users = (Map<String, Principal>) (obj == null ? new HashMap<String,Principal>() : obj);
            users.put(name, headers.getUser());
    
            sc.setAttribute("users", users); //将用户信息已map格式放存放起来
    
        }
    
    }

有了用户信息就可以使用SimpMessagingTemplate进行特定用户推送了

@Controller
    @RequestMapping("/webSocket")
    public class WebSocketController { 
    
        @Autowired private SimpMessagingTemplate template; 
    
    }

SimpMessagingTemplate在配置spring websocket的时候就已经放到spring容器中了

@Configuration
    @EnableWebSocketMessageBroker
    public class WebSocketMessageBrokerConfig implements WebSocketMessageBrokerConfigurer { 
    
        @Override
        public void registerStompEndpoints(StompEndpointRegistry registry) {
    
            //portfolio-stomp就是websocket的端点，客户端需要注册这个端点进行链接，withSockJS允许客户端利用sockjs进行浏览器兼容性处理
            registry.addEndpoint("/portfolio-stomp")/*.setAllowedOrigins("http://localhost:8080")*/.withSockJS(); 
    
        }
    
        @Override
        public void configureMessageBroker(MessageBrokerRegistry registry) {
            registry.enableSimpleBroker("/topic");               //设置服务器广播消息的基础路径
            registry.setApplicationDestinationPrefixes("/app");  //设置客户端订阅消息的基础路径
            registry.setPathMatcher(new AntPathMatcher("."));    //可以已“.”来分割路径，看看类级别的@messageMapping和方法级别的@messageMapping
        }
    
        @Override
        public boolean configureMessageConverters(List<MessageConverter> messageConverters) {
    
            return true;
        }
    
        @Override
        public void configureWebSocketTransport(WebSocketTransportRegistration registry) {
            // TODO Auto-generated method stub
            registry.addDecoratorFactory(new MyWebSocketHandlerDecoratorFactory());
        }
    
        @Override
        public void configureClientInboundChannel(ChannelRegistration registration) {
             registration.setInterceptors(new MyChannelInterceptor());
        }
    
        @Override
        public void configureClientOutboundChannel(ChannelRegistration registration) {
            // TODO Auto-generated method stub
    
        }
    
        @Override
        public void addArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) {
            // TODO Auto-generated method stub
    
        }
    
        @Override
        public void addReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers) {
            // TODO Auto-generated method stub
    
        }
    
    }

所以我们这里我们可以直接通过@Autowired注入进来。接下来我们就利用进行推送了

@Controller
    @RequestMapping("/webSocket")
    public class WebSocketController { 
    
        @Autowired private SimpMessagingTemplate template; 
    
        @SuppressWarnings("unchecked")
        @RequestMapping("/httpSendMsg")
        public void httpSendMsg(String msg){
    
            ServletContext sc = SpringBeanUtil.getServletContext();
            Map<String,Principal> users = sc.getAttribute("users") == null ? null : (Map<String,Principal>)sc.getAttribute("users");//获取放在servletContext中的用户信息
    
            Set<String> set = users.keySet();
            Iterator<String> iterator = set.iterator();
            while(iterator.hasNext()){ //遍历根据用户进行推送
                String key = iterator.next();
                this.template.convertAndSendToUser(key, "/topic/greetings", msg);
            }
    
        }
    }

在这里我们就成功的将消息推送到固定用户中了，这里有个想法，我们可以把spring websocket作为消息总线服务器独立出来，项目中，如果需要广播或者订阅消息就直接在消息总线中进行处理，只需要把推送路径和订阅路径做好就可以了，这里，跨域的操作，可以用setAllowedOrigins,下次可以看看