• 极客专栏正式上线!欢迎访问 https://www.jikewenku.com/topic.html
  • 极客专栏正式上线!欢迎访问 https://www.jikewenku.com/topic.html

springboot整合websocket实现一对一消息推送和广播消息推送

技术杂谈 勤劳的小蚂蚁 3个月前 (01-29) 88次浏览 已收录 0个评论 扫描二维码

springboot基础环境
请参考springboot文档
maven依赖
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-websocket</artifactId>
        </dependency>
代码准备
准备常量类
    //webSocket相关配置
    //链接地址
    public static String WEBSOCKETPATHPERFIX = “/ws-push”;
    public static String WEBSOCKETPATH = “/endpointWisely”;
    //消息代理路径
    public static String WEBSOCKETBROADCASTPATH = “/topic”;
    //前端发送给服务端请求地址
    public static final String FORETOSERVERPATH = “/welcome”;
    //服务端生产地址,客户端订阅此地址以接收服务端生产的消息
    public static final String PRODUCERPATH = “/topic/getResponse”;
    //点对点消息推送地址前缀
    public static final String P2PPUSHBASEPATH = “/user”;
    //点对点消息推送地址后缀,最后的地址为/user/用户识别码/msg
    public static final String P2PPUSHPATH = “/msg”;
接收前端消息实体
public class WiselyMessage {
    private String name;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}
后台发送消息实体
private String responseMessage;

    public WiselyResponse(String responseMessage){
        this.responseMessage = responseMessage;
    }

    public String getResponseMessage() {
        return responseMessage;
    }

    public void setResponseMessage(String responseMessage) {
        this.responseMessage = responseMessage;
    }
配置websocket
@Configuration
// @EnableWebSocketMessageBroker注解用于开启使用STOMP协议来传输基于代理(MessageBroker)的消息,这时候控制器(controller)
// 开始支持@MessageMapping,就像是使用@requestMapping一样。
@EnableWebSocketMessageBroker
public class WebSocketConfig extends AbstractWebSocketMessageBrokerConfigurer {

    @Override
    public void registerStompEndpoints(StompEndpointRegistry stompEndpointRegistry) {
        //注册一个Stomp的节点(endpoint),并指定使用SockJS协议。
        stompEndpointRegistry.addEndpoint(Constant.WEBSOCKETPATH).withSockJS();
    }

    @Override
    public void configureMessageBroker(MessageBrokerRegistry registry) {
        //服务端发送消息给客户端的域,多个用逗号隔开
        registry.enableSimpleBroker(Constant.WEBSOCKETBROADCASTPATH, Constant.P2PPUSHBASEPATH);
        //定义一对一推送的时候前缀
        registry.setUserDestinationPrefix(Constant.P2PPUSHBASEPATH);
        //定义websoket前缀
        registry.setApplicationDestinationPrefixes(Constant.WEBSOCKETPATHPERFIX);
    }
}
service
@Service
public class WebSocketService {

    @Autowired
    private SimpMessagingTemplate template;

    /**
     * 广播
     * 发给所有在线用户
     *
     * @param msg
     */
    public void sendMsg(WiselyResponse msg) {
        template.convertAndSend(Constant.PRODUCERPATH, msg);
    }

    /**
     * 发送给指定用户
     * @param users
     * @param msg
     */
    public void send2Users(List<String> users, WiselyResponse msg) {
        users.forEach(userName -> {
            template.convertAndSendToUser(userName, Constant.P2PPUSHPATH, msg);
        });
    }

}

控制器
@Controller
public class WsController {

    @Resource
    WebSocketService webSocketService;

    @MessageMapping(Constant.FORETOSERVERPATH)//@MessageMapping和@RequestMapping功能类似,用于设置URL映射地址,浏览器向服务器发起请求,需要通过该地址。
    @SendTo(Constant.PRODUCERPATH)//如果服务器接受到了消息,就会对订阅了@SendTo括号中的地址传送消息。
    public WiselyResponse say(WiselyMessage message) throws Exception {
        List<String> users = Lists.newArrayList();
        users.add(“d892bf12bf7d11e793b69c5c8e6f60fb”);//此处写死只是为了方便测试,此值需要对应页面中订阅个人消息的userId
        webSocketService.send2Users(users, new WiselyResponse(“admin hello”));

        return new WiselyResponse(“Welcome, “ + message.getName() + “!”);
    }
}
页面
<!DOCTYPE html>
<html xmlns:th=http://www.thymeleaf.org&#8221;>
<head>
    <meta charset=“UTF-8” />
    <title>Spring Boot+WebSocket+广播式</title>

</head>
<body onload=“disconnect()”>
<noscript><h2 style=“color: #ff0000”>貌似你的浏览器不支持websocket</h2></noscript>
<div>
    <div>
        <button id=“connect” onclick=“connect();”>连接</button>
        <button id=“disconnect” disabled=“disabled” onclick=“disconnect();”>断开连接</button>
    </div>
    <div id=“conversationDiv”>
        <label>输入你的名字</label><input type=“text” id=“name” />
        <button id=“sendName” onclick=“sendName();”>发送</button>
        <p id=“response”></p>
        <p id=“response1”></p>
    </div>
</div>
<!–<script th:src=”@{sockjs.min.js}”></script>
<script th:src=”@{stomp.min.js}”></script>
<script th:src=”@{jquery.js}”></script>–>
<script th:inline=“javascript”>
    var stompClient = null;
    //此值有服务端传递给前端,实现方式没有要求
    var userId = [[${userId}]];

    function setConnected(connected{
        document.getElementById(‘connect’).disabled = connected;
        document.getElementById(‘disconnect’).disabled = !connected;
        document.getElementById(‘conversationDiv’).style.visibility = connected ? ‘visible’ : ‘hidden’;
        $(‘#response’).html();
    }

    function connect() {
        var socket = new SockJS(‘/endpointWisely’); //1连接SockJS的endpoint是“endpointWisely”,与后台代码中注册的endpoint要一样。
        stompClient = Stomp.over(socket);//2创建STOMP协议的webSocket客户端。
        stompClient.connect({}, function(frame{//3连接webSocket的服务端。
            setConnected(true);
            console.log(‘开始进行连接Connected: ‘ + frame);
            //4通过stompClient.subscribe()订阅服务器的目标是’/topic/getResponse’发送过来的地址,与@SendTo中的地址对应。
            stompClient.subscribe(‘/topic/getResponse’function(respnose){
                showResponse(JSON.parse(respnose.body).responseMessage);
            });
            //4通过stompClient.subscribe()订阅服务器的目标是’/user/’ + userId + ‘/msg’接收一对一的推送消息,其中userId由服务端传递过来,用于表示唯一的用户,通过此值将消息精确推送给一个用户
            stompClient.subscribe(‘/user/’ + userId + ‘/msg’function(respnose){
                console.log(respnose);
                showResponse1(JSON.parse(respnose.body).responseMessage);
            });
        });
    }


    function disconnect() {
        if (stompClient != null) {
            stompClient.disconnect();
        }
        setConnected(false);
        console.log(“Disconnected”);
    }

    function sendName() {
        var name = $(‘#name’).val();
        //通过stompClient.send()向地址为”/welcome”的服务器地址发起请求,与@MessageMapping里的地址对应。因为我们配置了registry.setApplicationDestinationPrefixes(Constant.WEBSOCKETPATHPERFIX);所以需要增加前缀/ws-push/
        stompClient.send(“/ws-push/welcome”, {}, JSON.stringify({ ‘name’: name }));
    }

    function showResponse(message{
        var response = $(“#response”);
        response.html(message);
    }
    function showResponse1(message{
        var response = $(“#response1”);
        response.html(message);
    }
</script>
</body>
</html>
测试
点击连接控制台输出
表示连接成功并且订阅了两个地址
此时在文本框内输入任意值,结果如图所示则代表成功
控制台中显示依次为,发送信息,目标长度内容
此时服务端控制器接收到请求
同时给指定用户发送了消息,所以控制台接收到消息
同时因为控制器有注解@SendTo所以会向@SendTo的地址广播消息,客户端订阅了广播地址所有控制台显示接收了消息


丨极客文库, 版权所有丨如未注明 , 均为原创丨
本网站采用知识共享署名-非商业性使用-相同方式共享 3.0 中国大陆许可协议进行授权
转载请注明原文链接:springboot整合websocket实现一对一消息推送和广播消息推送
喜欢 (0)
[247507792@qq.com]
分享 (0)
勤劳的小蚂蚁
关于作者:
温馨提示:本文来源于网络,转载文章皆标明了出处,如果您发现侵权文章,请及时向站长反馈删除。

您必须 登录 才能发表评论!

  • 精品技术教程
  • 编程资源分享
  • 问答交流社区
  • 极客文库知识库

客服QQ


QQ:2248886839


工作时间:09:00-23:00