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

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,下次可以看看

  • 2
    点赞
  • 11
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
要在Spring Boot应用中使用WebSocket向前端推送信息,可以使用SpringWebSocket支持,它提供了一个WebSocketHandler来处理WebSocket连接和消息。 以下是一个简单的示例代码,用于向所有已连接的WebSocket客户端推送当前时间: 1. 首先,需要在POM文件中添加Spring WebSocket的依赖: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> ``` 2. 创建一个WebSocketHandler类,处理WebSocket连接和消息: ```java import org.springframework.stereotype.Component; import org.springframework.web.socket.WebSocketHandler; import org.springframework.web.socket.WebSocketSession; import org.springframework.web.socket.handler.TextWebSocketHandler; import java.util.ArrayList; import java.util.List; import java.util.concurrent.CopyOnWriteArrayList; @Component public class MyWebSocketHandler extends TextWebSocketHandler { private final List<WebSocketSession> sessions = new CopyOnWriteArrayList<>(); @Override public void afterConnectionEstablished(WebSocketSession session) throws Exception { // 添加新连接 sessions.add(session); } @Override public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception { // 移除已关闭的连接 sessions.remove(session); } public void pushMessage(String message) { // 向所有已连接的客户端推送消息 for (WebSocketSession session : sessions) { session.sendMessage(new TextMessage(message)); } } } ``` 在上面的代码中,我们继承了TextWebSocketHandler,并实现了afterConnectionEstablished()和afterConnectionClosed()方法来处理连接的打开和关闭事件。我们还添加了一个pushMessage()方法,用于向所有已连接的客户端推送消息。 3. 在Controller中注入MyWebSocketHandler,并在需要推送消息的时候调用它的pushMessage()方法: ```java import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; @RestController public class MyController { @Autowired private MyWebSocketHandler webSocketHandler; @GetMapping("/push") public String push() { webSocketHandler.pushMessage("Current time: " + LocalDateTime.now()); return "OK"; } } ``` 在上面的代码中,我们注入了MyWebSocketHandler,并在/push接口中调用它的pushMessage()方法,向所有已连接的WebSocket客户端推送当前时间。 4. 在前端页面中,使用JavaScript连接WebSocket,并监听来自服务器的消息: ```javascript var socket = new WebSocket("ws://" + window.location.host + "/websocket"); socket.onmessage = function(event) { console.log(event.data); }; ``` 在上面的代码中,我们使用WebSocket连接到服务器上的/websocket路径,并监听来自服务器的消息。当服务器向客户端推送消息时,onmessage事件会被触发,我们在这里打印出收到的消息。 这样,当我们访问/push接口时,服务器会向所有已连接的WebSocket客户端推送当前时间。在前端页面中,我们可以监听这些推送的消息,并实时更新页面。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 2
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值