SpringBoot整合Websocket，实现广播式和给特定用户发送消息

清疚 2023-05-29 12:00 17阅读 0赞

### 文章目录 ###

*  总结:
 *  这里我采用编程式使用。
 *  参考资料
 *  上面可能出现前端总404问题,转用原生的websocket。
 *   *  注意点

# 总结: #

*  广播式：通知所有人，简单。只需要订阅一个地址就行。
 *  特定用户： 2种做法。
    
     *  每个人订阅的地址不一样。
     *  编程式获得websocket，然后操作它就行了。

# 这里我采用编程式使用。 #

*  配置bean:

import org.springframework.context.annotation.Bean;
    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;
    
    /**
     * 服务推送: wss://www.example.com/websocket/SendTo/topic/greetings
     * 前端请求: wss://www.example.com/websocket/MessageMapping/topic/MessageMapping
     * socket核心配置容器
     */
    @Configuration
    @EnableWebSocketMessageBroker
    public class WebSocketConfig extends AbstractWebSocketMessageBrokerConfigurer {
    
        @Override
        public void configureMessageBroker(MessageBrokerRegistry config) {
            //
            config.enableSimpleBroker("/MessageMapping");// /users 默认通知
            config.setApplicationDestinationPrefixes("/SendTo");
            //设置前缀  默认是user 可以修改  点对点时使用 , 不使用
            config.setUserDestinationPrefix("/user-wlh/");
        }
    
        @Override
        public void registerStompEndpoints(StompEndpointRegistry registry) {
            //
            registry.addEndpoint("/websocket").withSockJS();
        }
    
    }

*  具体代码:

import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.messaging.MessageHeaders;
    import org.springframework.messaging.handler.annotation.MessageMapping;
    import org.springframework.messaging.handler.annotation.SendTo;
    import org.springframework.messaging.simp.SimpMessageHeaderAccessor;
    import org.springframework.messaging.simp.SimpMessageType;
    import org.springframework.messaging.simp.SimpMessagingTemplate;
    import org.springframework.stereotype.Controller;
    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.ResponseBody;
    import org.springframework.web.servlet.ModelAndView;
    
    import javax.servlet.http.HttpServletRequest;
    import java.io.IOException;
    import java.util.Date;
    import java.util.HashMap;
    import java.util.List;
    import java.util.Map;
    import java.util.stream.Collectors;
    
    @Controller
    @RequestMapping("/checkcenter")
    public class CheckCenterController {
    	/**
    	 * session操作类
    
    	@Autowired
    	SocketSessionRegistry webAgentSessionRegistry;	 */
    	/**
    	 * 消息发送工具
    	 */
    	@Autowired
    	private SimpMessagingTemplate template;
    
    	@RequestMapping(value = "/index")
    	public String index() {
    		template.convertAndSendToUser("userId", "/topic/greetings", "我的消息");
    		return "/index";
    	}
    
    	/**
    	 * 用户广播
    	 * 发送消息广播  用于内部发送使用
    	 *
    	 * @param request
    	 * @return
    	 */
    	@MessageMapping("/change-notice1")
    	public void greeting1(String value) {
    		this.template.convertAndSend("/topic/notice", value);
    	}
    	@MessageMapping("/change-notice")
    	@SendTo("/topic/notice")
    	public String greeting(String value) {
    		return value;
    	}
    
    
    	/**
    	 * 同样的发送消息   只不过是ws版本  http请求不能访问
    	 *
    	 * @param message
    	 * @return
    	 * @throws Exception
    	 */
    	@MessageMapping("/msg/hellosingle")
    	public void greeting2(String userId) throws Exception {
    		//这里没做校验
    		template.convertAndSendToUser(userId, "/topic/greetings", "我的消息");
    	}
    
    }

# 参考资料 #

*  [SpringBoot2.0集成WebSocket，实现后台向前端推送信息][SpringBoot2.0_WebSocket]

> 看他的原理，demo不通

*  [基于spring boot 2.x的websocket示例][spring boot 2.x_websocket]

> 基本demo，只有全局推送，全局推送的简易写法。

*  [Spring WebSocket初探1 (Spring WebSocket入门教程)][Spring WebSocket_1 _Spring WebSocket]

> 这个是java后端。

*  [Spring WebSocket初探2 (Spring WebSocket入门教程)][Spring WebSocket_2 _Spring WebSocket]

> 这个是js前端。

*  [SpringBoot整合Websocket，实现广播式和给特定用户发送消息，不需要登录即可发送消息。][SpringBoot_Websocket]

> 有demo和

*  [SpringBoot WebSocket 发送消息给指定的用户–注解版][SpringBoot WebSocket]

> 通过@SendToUser发送到特定的用户

*  [Spring websocket+Stomp+SockJS 实时通信详解][Spring websocket_Stomp_SockJS]

> boot全家桶使用方案。

# 上面可能出现前端总404问题,转用原生的websocket。 #

见下

*  [SpringBoot2集成WebSocket][SpringBoot2_WebSocket]

> 实现广播式

*  [websocket @ServerEndpoint(value = “/websocket/\{ip\}”)详解][websocket _ServerEndpoint_value _ _websocket_ip]

> 给特定用户发送消息

*  [WebSocket使用javax.websocket.RemoteEndpoint.Basic.sendObject(Object arg0)向页面方法发送对象][WebSocket_javax.websocket.RemoteEndpoint.Basic.sendObject_Object arg0]

> 放弃使用，这个更加麻烦。

## 注意点 ##

*  spring-boot-junit需要添加`@SpringBootTest( webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)`
 *  app类不能加注解websocket注解启动，否则报错。

[SpringBoot2.0_WebSocket]: https://blog.csdn.net/moshowgame/article/details/80275084
[spring boot 2.x_websocket]: https://www.cnblogs.com/yjmyzz/p/spring-boot-2-websocket-sample.html
[Spring WebSocket_1 _Spring WebSocket]: https://www.jianshu.com/p/60799f1356c5
[Spring WebSocket_2 _Spring WebSocket]: https://www.jianshu.com/p/8500ad65eb50
[SpringBoot_Websocket]: https://gitee.com/bgt0314/SpringbootWebSocket
[SpringBoot WebSocket]: https://blog.csdn.net/qq_30912043/article/details/80167991
[Spring websocket_Stomp_SockJS]: https://blog.csdn.net/leixiaotao_java/article/details/79982309
[SpringBoot2_WebSocket]: https://blog.csdn.net/wu_boy/article/details/84944981
[websocket _ServerEndpoint_value _ _websocket_ip]: https://blog.csdn.net/weixin_39793752/article/details/80949128
[WebSocket_javax.websocket.RemoteEndpoint.Basic.sendObject_Object arg0]: https://blog.csdn.net/u014175572/article/details/46490395