返回 导航

SpringBoot / Cloud

hangge.com

SpringBoot - WebSocket的整合与使用详解2(消息点对点发送样例)

作者:hangge | 2020-01-18 08:10
    在上文中,服务端对客户端消息发送使用到了 @SendTo 注解,该注解将方法处理过的消息转发到 broker,再由 broker 进行消息广播。
    除了 @SendTo 注解外,Spring 还提供了 SimpMessagingTemplate 类来让开发者更加灵活地发送消息。使用 SimpMessagingTemplate,我们不仅可以在任意地方发送消息到 broker,也可以发送消息给某一个用户,即点对点的消息发送。下面通过样例进行演示。

三、消息点对点发送样例

1,添加依赖

既然是点对点发送,就应该有用户的概念,因此我们在前文的基础上再加入 Spring Security 依赖:
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-security</artifactId>
</dependency>

2,配置 Spring Security

Spring Security 进行配置,添加两个用户,同时配置所有地址都认证后才能访问:
@Configuration
public class WebSecurityConfig extends WebSecurityConfigurerAdapter {
    // 指定密码的加密方式
    @SuppressWarnings("deprecation")
    @Bean
    PasswordEncoder passwordEncoder(){
        // 不对密码进行加密
        return NoOpPasswordEncoder.getInstance();
    }

    // 配置用户及其对应的角色
    @Override
    protected void configure(AuthenticationManagerBuilder auth) throws Exception {
        auth.inMemoryAuthentication()
                .withUser("admin").password("123").roles("ADMIN","USER")
                .and()
                .withUser("hangge").password("123").roles("USER");
    }

    // 配置 URL 访问权限
    @Override
    protected  void configure(HttpSecurity http) throws Exception {
        http.authorizeRequests() // 开启 HttpSecurity 配置
                .anyRequest().authenticated() // 用户访问所有地址都必须登录认证后访问
                .and().formLogin().permitAll(); // 开启表单登录
    }
}

3,改造 WebSocket 配置

    接着对前文的 WebSocketConfig 做一个小修改,在 config.enableSimpleBroker("/topic"); 方法基础上又增加了一个 broker 前缀“/queue”,方便分别对群发消息和点对点消息进行管理。
@Configuration
@EnableWebSocketMessageBroker
public class WebSocketConfig implements WebSocketMessageBrokerConfigurer {

    @Override
    public void configureMessageBroker(MessageBrokerRegistry config) {
        // 设置消息代理的前缀,如果消息的前缀为"/topic"、"/queue",就会将消息转发给消息代理(broker)
        // 再由消息代理广播给当前连接的客户端
        config.enableSimpleBroker("/topic","/queue");
        // 下面方法可以配置一个或多个前缀,通过这些前缀过滤出需要被注解方法处理的消息。
        // 例如这里表示前缀为"/app"的destination可以通过@MessageMapping注解的方法处理
        // 而其他 destination(例如"/topic""/queue")将被直接交给 broker 处理
        config.setApplicationDestinationPrefixes("/app");
    }

    @Override
    public void registerStompEndpoints(StompEndpointRegistry registry) {
        // 定义一个前缀为"/chart"的endpoint,并开启 sockjs 支持。
        // sockjs 可以解决浏览器对WebSocket的兼容性问题,客户端将通过这里配置的URL建立WebSocket连接
        registry.addEndpoint("/chat").withSockJS();
    }
}

4,改造 Controller 配置

(1)接下来对 WebSocketController 进行改造,其中群发消息依然使用 @SendTo 注解来实现,点对点的消息发送则使用 SimpMessagingTemplate 来实现。
注意:点对点消息发送这里使用了 SimpMessagingTemplate 对象的 convertAndSendToUser 方法,该方法内部对消息路径做了处理,也就是会所消息最终发送路径变成了“/user/用户名/queue/chat
@Controller
public class GreetingController {

    @Autowired
    SimpMessagingTemplate messagingTemplate;

    // 处理来自"/app/hello"路径的消息
    @MessageMapping("/hello")
    @SendTo("/topic/greetings")
    public Message greeting(Message message) throws Exception {
        return message;
    }

    // 处理来自"/app/chat"路径的消息
    @MessageMapping("/chat")
    public void chat(Principal principal, Chat chat) {
        // 获取当前登录用户的用户名
        String from = principal.getName();
        // 将用户设置给chat对象的from属性
        chat.setFrom(from);
        // 再将消息发送出去,发送的目标用户就是 chat 对象的to属性值
        messagingTemplate.convertAndSendToUser(chat.getTo(),
                "/queue/chat", chat);
    }
}

(2)Chat 则是一个普通的 JavaBean,内容如下:
@Setter
@Getter
public class Chat {
    // 消息的目标用户
    private String to;
    // 消息的来源用户
    private String from;
    // 消息的主体内容
    private String content;
}

5,构建聊天页面 

resources/static 目录下创建 chat2.html 页面作为点对点的聊天页面,代码如下:
注意: 连接成功后,订阅的地址为“/user/queue/chat”,该地址比服务端配置的地址多了“/user”前缀,这是因为 SimpMessagingTemplate 类中自动添加了路径前缀。
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>单聊</title>
    <script src="/webjars/jquery/jquery.min.js"></script>
    <script src="/webjars/sockjs-client/sockjs.min.js"></script>
    <script src="/webjars/stomp-websocket/stomp.min.js"></script>
    <script>
        var stompClient = null;

        // 建立一个WebSocket连接
        function connect() {
            // 首先使用 SockJS 建立连接
            var socket = new SockJS('/chat');
            // 然后创建一个STOMP实例发起连接请求
            stompClient = Stomp.over(socket);
            // 连接成功回调
            stompClient.connect({}, function (frame) {
                // 订阅服务端发送回来的消息
                stompClient.subscribe('/user/queue/chat', function (chat) {
                    // 将服务端发送回来的消息展示出来
                    showGreeting(JSON.parse(chat.body));
                });
            });
        }

        // 发送消息
        function sendMsg() {
            stompClient.send("/app/chat", {},
                JSON.stringify({'content':$("#content").val(),
                    'to':$("#to").val()}));
        }

        // 将服务端发送回来的消息展示出来
        function showGreeting(message) {
            $("#chatsContent")
                .append("<div>" + message.from+":"+message.content + "</div>");
        }

        // 页面加载后进行初始化动作
        $(function () {
            // 页面加载完毕后自动连接
            connect();
            $( "#send" ).click(function() { sendMsg(); });
        });
    </script>
</head>
<body>
<div id="chat">
    <div id="chatsContent">
    </div>
    <div>
        请输入聊天内容:
        <input type="text" id="content" placeholder="聊天内容">
        目标用户:
        <input type="text" id="to" placeholder="目标用户">
        <button id="send" type="button">发送</button>
    </div>
</div>
</body>
</html>

6,运行测试

(1)启动项目后,使用浏览器访问“http://localhost:8080/chat2.html”,首先会自动跳转到 Spring Security 的默认登录页面:

(2)我们使用 admin 用户登录后边自动跳到之前访问的聊天页面:

(3)接着我们使用另一个浏览器登录 hangge 用户,这样这两个用户就可以互相发消息聊天了:
评论

全部评论(0)

回到顶部