springboot集成websocket
admin
2024-03-27 19:16:17
0次

简介

STOMP的全称是Simple (or Streaming) Text Orientated Messaging Protocol,一种简单的流式文本传输协议。对于不支持websocket的浏览器我们需要通过STOMP来兼容,兼容的需要俩个组件,一个是前端需要的SockJs,一个是后端需要的WebSocketMessageBroker。SockJs一种让前端可以支持socket通信的技术解决方案,WebSocketMessageBroker是基于消息组件实现的一种通信协议。

实现

一、在后端springboot服务中添加依赖

org.springframework.bootspring-boot-starter-websocket2.2.6.RELEASE

二、添加websocketConfig

import lombok.extern.slf4j.Slf4j;
import org.springframework.context.annotation.Configuration;
import org.springframework.messaging.simp.config.MessageBrokerRegistry;
import org.springframework.web.socket.config.annotation.EnableWebSocketMessageBroker;
import org.springframework.web.socket.config.annotation.StompEndpointRegistry;
import org.springframework.web.socket.config.annotation.WebSocketMessageBrokerConfigurer;/*** @author liqiang*/
@Slf4j
@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {@Overridepublic void registerStompEndpoints(StompEndpointRegistry registry) {// 增加一个后端服务端点registry.addEndpoint("/socket").setAllowedOrigins("*").withSockJS();// 增加一个前端服务端点registry.addEndpoint("/wsuser").setAllowedOrigins("*").withSockJS();// 配置客户端尝试连接地址
//        registry.addEndpoint("/ws").setAllowedOrigins("*").withSockJS();}/*** 定义服务器端点请求和订阅前缀* @param registry*/@Overridepublic void configureMessageBroker(MessageBrokerRegistry registry) {// 客户端订阅路径前缀registry.enableSimpleBroker("/sub", "/user");// 服务端点请求前缀registry.setApplicationDestinationPrefixes("/request");// 设置广播节点/*registry.enableSimpleBroker("/topic", "/user");// 客户端向服务端发送消息需有/app 前缀registry.setApplicationDestinationPrefixes("/app");*/// 指定用户发送(一对一)的前缀 /user/registry.setUserDestinationPrefix("/user/");}
}

解释:
1、

 registry.addEndpoint("/socket").setAllowedOrigins("*").withSockJS();

addEndpoint添加一个端点,用于前端创建socket连接,在示例中我们创建了俩个端点,这里传差的使用互补影响,不如我发送的时候创建链接使用的是socket端点,而接收信息的时候使用的wsuser端点,这样也是可以互通信息的。
setAllowedOrigins(“*”)这个是设置跨域的。

2、

registry.enableSimpleBroker("/sub", "/user");

设置客户端订阅的前缀

registry.setApplicationDestinationPrefixes("/request");

设置前端请求后端发送信息的前缀

registry.setUserDestinationPrefix("/user/");

设置一对一转发信息时的用户前缀

三、实现广播方式

1、前端代码

1.1 发送信息前端代码



websocket STOMP


websocket兼容STOMP测试11

跳转到消息接收页

1.2接收信息前端代码



websocket-stomp-receive





等待接收消息

解释:
在前端代码中主要的发送信息和接收信息的部分在js中,如下截取出来:

var stompClient = null;// 设置连接function connect() {// 定义请求服务器的端点var socket = new SockJS('/socket');// stomp客户端stompClient = Stomp.over(socket);// 连接服务器端点stompClient.connect({}, function (frame) {// 建立连接后的回调,这个是设置连接状态的setConnected(true);})}// 断开socket连接function disconnect() {if (stompClient != null) {stompClient.disconnect();}setConnected(false);console.log("Disconnected");}// 向/request/send服务端发送消息function sendMessage() {var message = $("#message").val();// 发送消息到"/request/send",其中/request是服务器定义的前缀// 而/send则是@MessageMapping所配置的路径stompClient.send("/request/send", {}, message);}connect();
var noticeSocket = function () {// 连接服务器端点var s = new SockJS('/socket');//客户端var stompClient = Stomp.over(s);stompClient.connect({}, function () {console.log("notice socket connected !");// 订阅消息地址,这里的/sub是在配置里设置的sub前缀,/sub/chat是后端服务代码中@SendTo注解消息路由到的订阅路径中stompClient.subscribe('/sub/chat', function (data) {$('#receive').html(data.body);});});};noticeSocket();

后端服务代码

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.messaging.handler.annotation.SendTo;
import org.springframework.messaging.simp.SimpMessagingTemplate;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;import javax.annotation.Resource;
import java.security.Principal;/*** @author */
@Controller
@RequestMapping("/device/ws")
@Api(tags = "WebsocketController")
public class WebsocketController {private final Logger logger = LoggerFactory.getLogger(WebsocketController.class);@MessageMapping("/send")@SendTo("/sub/chat")public String sendMessage(String value) {logger.info("发送消息内容:{}", value);return value;}/*** 测试发送广播消息的前端* @return*/@GetMapping("/test")public String test() {return "request";}/*** 测试接受广播消息的前端* @return*/@GetMapping("/user")public String user() {return "user";}
}

@MessageMapping注解的/send就是前端发送时路径的一部分,再加上服务前缀request,就是前端发送信息的完整路径/request/send.
@SendTo注解的路径是将要消息路由到的路径,正好是前端订阅的路径。
发送过来的消息可以在这里进行整理或处理后再转发出去

实现一对一发送

前端代码

发送信息的前端代码



websocket STOMP


websocket兼容STOMP测试11

跳转到消息接收页

stompClient.send 把信息发送到后端,
/requst 是服务端统一的前缀路径
/sendUser 是@MessageMaping的路径

接收信息的前端



websocket-stomp-receive





等待接收消息

解释:

// 订阅消息地址,stompClient.subscribe('/sub/admin/queue/customer', function (data) {console.log("接受到的消息:"+data)$('#receive').html(data.body);});

/sub/admin/queue/customer
/sub 是接收信息的订阅的前缀
/admin 是指定的user
/queue/customer 是转发信息的destination,目的地

后端服务代码


import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.messaging.handler.annotation.SendTo;
import org.springframework.messaging.simp.SimpMessagingTemplate;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;import javax.annotation.Resource;
import java.security.Principal;/*** @author */
@Controller
@RequestMapping("/device/ws")
@Api(tags = "WebsocketController")
public class WebsocketController {private final Logger logger = LoggerFactory.getLogger(WebsocketController.class);@Resourceprivate SimpMessagingTemplate simpMessagingTemplate;@MessageMapping("/sendToUser")public void sendToUser(Principal principal, String body,String token) {
//        String srcUser = principal.getName();System.out.println("传入的token是:"+token);String[] args = body.split(": ");String desUser = args[0];String message = String.format("【%s】给你发来消息:%s", "mali", args[1]);// 发送到用户和监听地址simpMessagingTemplate.convertAndSendToUser(desUser, "/queue/customer", message);}/*** 测试发送指定用户的前端* @return*/@GetMapping("/sendUser")public String sendUser() {return "sendUser";}/*** 接受指定用户的前端* @return*/@GetMapping("/userId")public String userId() {return "userId";}
}
 @MessageMapping("/sendToUser")public void sendToUser(Principal principal, String body,String token) {
//        String srcUser = principal.getName();System.out.println("传入的token是:"+token);String[] args = body.split(": ");String desUser = args[0];String message = String.format("【%s】给你发来消息:%s", "mali", args[1]);// 发送到用户和监听地址simpMessagingTemplate.convertAndSendToUser(desUser, "/queue/customer", message);}

这个方法正是前端发送消息的路径/sendToUser,路由消息的时候使用simpMessageTemplate.convertAndToUser,destUser是前端传过来的,
/queue/customer也是用户订阅的目的地址,发送的消息是message

相关内容

热门资讯

蜻蜓订购APP贵金属订购非法期...   蜻蜓订购APP以"投资平台"名义对外宣传,主打贵金属期货(订购)交易。该平台一方面强调自身"正规...
悟空订购APP非法期货交易欺骗...   近期,有投资者反映,“悟空订购APP”等平台以白银、贵金属订购为名,宣传所谓“高收益”“低门槛”...
小赢淘金APP期货投资骗局,平...   “小赢淘金”之流,最擅长的就是用“注册送现金”、“充值返券”的糖衣炮弹来引流。别天真地以为那是福...
八方淘金APP非法期货交易欺骗...   警惕!八方生财、每日淘金、小赢淘金、悟空订购、蜻蜓订购、斗金订购等APP均涉嫌非法期货交易!  ...
智易购APP贵金属订购交易骗局...   很多人看到“3元起投”“充值送福利”“操作简单”“随时提现”这类宣传,很容易把智易购APP当成普...
喜玛银庄APP商品订购投资骗局...   喜玛银庄APP白银、铂金“现货订购”骗局警示:无资质平台涉嫌非法期货交易,投资者爆仓后如何维权?...
吉鑫乐享APP炒贵金属订购交易...   近期,多名投资者反映在“吉鑫乐享APP”进行贵金属投资时遭遇严重亏损,甚至血本无归。看似正规的“...
易掘金APP虚假期货投资骗局,...   “易掘金”的APP它打着“高收益、灵活投资”的旗号,宣称通过“商品订购”就能轻松赚钱,吸引了不少...
在大吉订购APP订购交易亏损被...   近期,不少投资者反映在“大吉订购App”上投资白银、铂金等商品遭遇严重亏损。该平台宣称提供现货订...
铂银壹号APP商品订购交易亏损...   许多中小投资者误以为网上的“商品现货订购”是合规合法的理财渠道,殊不知这背后隐藏着巨大的合规风险...
兴鑫淘金APP贵金属订购交易亏...   白银、贵金属或其他商品类投资,除国家批准的正规期货交易场所及持牌期货公司外,市面上大量第三方交易...
铂银掘金APP无资质的违规平台...   铂银掘金等平台的投资者,往往是被“注册送现金”“充值返现券”“首单免亏”等广告话术吸引,进而下载...
八方淘金APP订购交易不合规,...   “八方淘金APP”“铂银掘金APP”“铂银壹号APP”等软件被指以“现货订购”为名,实际采用高杠...
在指尖订购APP订购商品亏损被...   指尖订购APP这类平台,表面是“订购交易”,实则是披着电商外衣的非法期货陷阱。绝大多数投资者被蒙...
在犀贝易购APP做商品订购交易...   市面上打着“现货投资”“贵金属交易”旗号的APP并不少,但真正合规、受监管的平台并不多。犀贝易购...
易达淘金APP虚假商品订购交易...   易达淘金APP存在严重的虚假宣传与违规交易行为。该平台打着“商品订购”的旗号,实则通过不合规的交...
大浪淘金APP白银订购亏损被骗...   大浪淘金APP最隐蔽的套路,在于其完全封闭的内盘交易系统。表面上,它宣称与国际贵金属市场接轨;实...
一品好购APP上订购白银出现亏...   一品好购APP原名“一品订购”,运营方为上海宝智未来信息技术有限公司。近期不少投资者反映在该平台...
九州订购APP贵金属订购投资骗...   九州订购APP正通过抖.音、快手、今日头条等平台大量投放投资广告,用“5元起投”“充值返现”“0...
坚锅淘金APP交易软件并不正规...   当前,市面上大量所谓的“现货商城订购”交易软件,早已偏离了正常的实物商品买卖,演变为高杠杆、高手...