SpringBoot中建立WebSocket连接(STOMP)主动推送消息
STOMP协议介绍
STOMP，Streaming Text Orientated Message Protocol，是流文本定向消息协议，是一种为MOM(Message Oriented Middleware，面向消息的中间件)设计的简单文本协议。
它提供了一个可互操作的连接格式，允许STOMP客户端与任意STOMP消息代理(Broker)进行交互，类似于OpenWire(一种二进制协议)。
由于其设计简单，很容易开发客户端，因此在多种语言和多种平台上得到广泛应用。其中最流行的STOMP消息代理是Apache ActiveMQ。
STOMP协议工作于TCP协议之上，使用了下列命令：
STOMP协议工作于TCP协议之上，使用了下列命令：
- SEND 发送
- SUBSCRIBE 订阅
- UNSUBSCRIBE 退订
- BEGIN 开始
- COMMIT 提交
- ABORT 取消
- ACK 确认
- DISCONNECT 断开
发送消息：
SEND
destination:/app/sendTest
content-type:application/json
content-length:44
{"userId":"rwerfef45434refgrege"}订阅消息：
SUBSCRIBE
id:sub-1
destination:/app/subscribeTest服务器进行广播：
MESSAGE
message-id:nxahklf6-1
subscription:sub-1
destination:/topic/subscribeTest
{"message":"it is test"}springboot使用STOMP消息步骤：
- 添加pom文件依赖
- java方式配置websocket stomp
- 消息实体类
- 书写控制层
- 书写客户端
1.添加pom文件依赖
-
org.springframework.boot spring-boot-starter-websocket
2.java方式配置websocket stomp使用注解@EnableWebSocketMessageBroker继承AbstractWebSocketMessageBrokerConfigurer类@EnableWebSocketMessageBroker注解。这表明这个配置类不仅配置了WebSocket，还配置了基于代理的STOMP消息。它重载了registerStompEndpoints()方法，将“/webSocketServer”注册为STOMP端点。这个路径与之前发送和接收消息的目的地路径有所不同。这是一个端点，客户端在订阅或发布消息到目的地路径前，要连接该端点。将其目的地前缀设置为“/topic”和“/queue”。这样的话，Spring就能知道所有目的地前缀为“/topic”或“/queue”的消息都会发送到STOMP代理中。根据你所选择的STOMP代理不同，目的地的可选前缀也会有所限制。
package com.ahut.config;
import org.springframework.context.annotation.Configuration;
@Configuration
@EnableWebSocketMessageBroker
public class WebSocketStompConfig extends AbstractWebSocketMessageBrokerConfigurer {
/**
* 注册stomp的端点
*/
@Override
public void registerStompEndpoints(StompEndpointRegistry registry) {
// 允许使用socketJs方式访问，访问点为webSocketServer，允许跨域
// 在网页上我们就可以通过这个链接
// http://localhost:8080/webSocketServer
// 来和服务器的WebSocket连接
registry.addEndpoint("/webSocketServer").setAllowedOrigins("*").withSockJS();
}
/**
* 配置信息代理
*/
@Override
public void configureMessageBroker(MessageBrokerRegistry registry) {
// 订阅Broker名称,这里设置的simple broker是指可以订阅的地址，也就是服务器可以发送的地址
registry.enableSimpleBroker("/queue", "/topic","/user");//如果客户端订阅了user则也需要加上/user否则不能订阅成功
// 全局使用的消息前缀（客户端订阅路径上会体现出来）将应用的前缀设置为“/app”。所有目的地以“/app”打头的消息都将会路由到带有@MessageMapping注解的方法中，而不会发布到代理队列或主题中。
registry.setApplicationDestinationPrefixes("/app");
// 点对点使用的订阅前缀（客户端订阅路径上会体现出来），不设置的话，默认也是/user/
// registry.setUserDestinationPrefix("/user/");
}
}
代码详解：
registry.addEndpoint("/webSocketServer").setAllowedOrigins("*").withSockJS();设置端点（访问url），客户端通过http://localhost:8080/webSocketServer来和服务器进行websocket连接
registry.enableSimpleBroker("/queue", "/topic");用户订阅主题的前缀
/topic 代表发布广播，即群发
/queue 代表点对点，即发指定用户
registry.setApplicationDestinationPrefixes("/app");- 1
设置客户端请求前缀
例如客户端发送消息的目的地为/app/sendTest，则对应控制层@MessageMapping(“/sendTest”)
客户端订阅主题的目的地为/app/subscribeTest，则对应控制层@SubscribeMapping(“/subscribeTest”)
3.消息实体类
任意对象都可以
4.书写控制层
package com.ahut.action;
@Controller
public class WebSocketAction {
private Logger logger = LoggerFactory.getLogger(this.getClass());
@MessageMapping("/sendTest")
@SendTo("/topic/subscribeTest")
public ServerMessage sendDemo(ClientMessage message) {
logger.info("接收到了信息" + message.getName());
return new ServerMessage("你发送的消息为:" + message.getName());
}
@SubscribeMapping("/subscribeTest")
public ServerMessage sub() {
logger.info("XXX用户订阅了我。。。");
return new ServerMessage("感谢你订阅了我。。。");
}
}代码详解：
@MessageMapping(“/sendTest”)
接收客户端发送的消息，当客户端发送消息的目的地为/app/sendTest时，交给该注解所在的方法处理消息，其中/app是在
registry.setApplicationDestinationPrefixes("/app");除了@MessagingMapping注解以外，Spring还提供了@SubscribeMapping注解。与@MessagingMapping注解方法类似，当收到STOMP订阅消息的时候，带有@SubscribeMapping注解的方法将会触发。
一步配置的客户端请求前缀
若没有添加@SendTo注解且该方法有返回值，则返回的目的地地址为/topic/sendTest，经过消息代理，客户端需要订阅了这个主题才能收到返回消息，sendTo方法的返回值对象即为发送到客户端的数据
@SubscribeMapping(“/subscribeTest”)
接收客户端发送的订阅，当客户端订阅的目的地为/app/subscribeTest时，交给该注解所在的方法处理订阅，其中/app为客户端请求前缀
若没有添加@SendTo注解且该方法有返回值，则返回的目的地地址为/app/sendTest，不经过消息代理，客户端需要订阅了这个主题才能收到返回消息
@SendTo(“/topic/subscribeTest”)
修改返回消息的目的地地址为/topic/subscribeTest，经过消息代理，客户端需要订阅了这个主题才能收到返回消息
服务器主动推数据
任意类中都可以
public class 任意类{
@Autowired
private SimpMessagingTemplate messagingTemplate;
//客户端只要订阅了/topic/subscribeTest主题，调用这个方法即可
public void templateTest() {
messagingTemplate.convertAndSend("/topic/subscribeTest", new ServerMessage("服务器主动推的数据"));
}
}
以下将会发送到将“/user/222/subscribeTest”目的地上
messagingTemplate.convertAndSendToUser("222", "/subscribeTest",
"你好"); SimpMessagingTemplate template是客户端主动发送消息到服务端，服务端马上回应指定的客户端消息类似http无状态请求，但是有质的区别，websocket可以从服务器指定发送哪个客户端，而不像http只能响应请求端
处理订阅
@SubscribeMapping的主要应用场景是实现请求-回应模式。在请求-回应模式中，客户端订阅某一个目的地，然后预期在这个目的地上获得一个一次性的响应。
例如，考虑如下@SubscribeMapping注解标注的方法：
@SubscribeMapping({"/marco"})
public Shout handleSubscription(){
Shout outgoing = new Shout();
outgoing.setMessage("Polo!");
return outgoing;
}
可以看到，handleSubscription()方法使用了@SubscribeMapping注解，用这个方法来处理对“/app/marco”目的地的订阅（与@MessageMapping类似，“/app”是隐含的）。当处理这个订阅时，handleSubscription()方法会产生一个输出的Shout对象并将其返回。然后，Shout对象会转换成一条消息，并且会按照客户端订阅时相同的目的地发送回客户端。
如果你觉得这种请求-回应模式与HTTP GET的请求-响应模式并没有太大差别的话，那么你基本上是正确的。但是，这里的关键区别在于HTTPGET请求是同步的，而订阅的请求-回应模式则是异步的，这样客户端能够在回应可用时再去处理，而不必等待。
当@MessageMapping注解标示的方法有返回值的时候，返回的对象将会进行转换（通过消息转换器）并放到STOMP帧的负载中，然后发送给消息代理。
默认情况下，帧所发往的目的地会与触发处理器方法的目的地相同，只不过会添加上“/topic”前缀。就本例而言，这意味着handleShout()方法所返回的Shout对象会写入到STOMP帧的负载中，并发布到“/topic/marco”目的地。不过，我们可以通过为方法添加@SendTo注解，重载目的地：
@MessageMapping("/marco")
@SendTo("/topic/shout")
public Shout handleShout(Shout incoming) {
logger.info("Received message: " + incoming.getMessage());
Shout outgoing = new Shout();
outgoing.setMessage("Polo!");
return outgoing;
}按照这个@SendTo注解，消息将会发布到“/topic/shout”。所有订阅这个主题的应用（如客户端）都会收到这条消息。
按照类似的方式，@SubscribeMapping注解标注的方式也能发送一条消息，作为订阅的回应。
@SubscribeMapping("/marco")
public Shout handleSubscription(){
Shout outgoing = new Shout();
outgoing.setMessage("Polo!");
return outgoing;
}@SubscribeMapping的区别在于这里的Shout消息将会直接发送给客户端，而不必经过消息代理。如果你为方法添加@SendTo注解的话，那么消息将会发送到指定的目的地，这样会经过代理。
可参考https://blog.csdn.net/liyongzhi1992/article/details/81221103