百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术文章 > 正文

WebSocket使用介绍,看这篇就够了

ccwgpt 2024-10-27 08:49 33 浏览 0 评论

一、WebSocket连接的建立、消息的接收和回复

  1. 当涉及到WebSocket框架的深度使用时,一个流行的选择是使用Java的Spring框架来实现。下面是一个基本的示例,演示了如何使用Spring WebSocket框架进行深度使用:

首先,确保你的项目中包含了Spring WebSocket的相关依赖。在pom.xml文件中添加以下依赖:

<dependencies>
    <!-- Spring WebSocket -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-websocket</artifactId>
    </dependency>
</dependencies>

接下来,创建一个WebSocket配置类,用于配置和管理WebSocket连接:

import org.springframework.context.annotation.Configuration;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {
    
    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(new MyWebSocketHandler(), "/websocket").setAllowedOrigins("*");
    }
}

在上面的示例中,MyWebSocketHandler是自定义的WebSocket处理程序,它将处理来自客户端的WebSocket连接和消息。

接下来,创建一个WebSocket处理程序类来处理WebSocket连接和消息的逻辑:

import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;

public class MyWebSocketHandler extends TextWebSocketHandler {

    @Override
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        // 当WebSocket连接建立成功时调用
        System.out.println("WebSocket连接已建立");
    }

    @Override
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        // 处理接收到的WebSocket消息
        String payload = message.getPayload();
        System.out.println("接收到消息:" + payload);
        
        // 发送回复消息给客户端
        String replyMessage = "收到消息:" + payload;
        session.sendMessage(new TextMessage(replyMessage));
    }

    @Override
    public void afterConnectionClosed(WebSocketSession session, CloseStatus status) throws Exception {
        // 当WebSocket连接关闭时调用
        System.out.println("WebSocket连接已关闭");
    }
}

在上面的示例中,我们覆盖了afterConnectionEstablished、handleTextMessage和afterConnectionClosed等方法,以处理WebSocket连接的建立、接收消息和连接关闭等事件。

最后,你可以在你的应用程序中使用WebSocket连接,例如在控制器中处理WebSocket请求:

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.messaging.handler.annotation.MessageMapping;
import org.springframework.messaging.handler.annotation.SendTo;
import org.springframework.stereotype.Controller;

@Controller
public class WebSocketController {

    @MessageMapping("/send")
    @SendTo("/topic/messages")
    public String sendMessage(String message) {
        // 处理接收到的消息,并返回处理结果
        String replyMessage = "处理消息:" + message;
        return replyMessage;
    }
}

在上面的示例中,我们使用@MessageMapping注解来指定处理客户端发送的消息的路径,然后使用@SendTo注解将处理结果发送回指定的订阅路径。

二、广播消息、用户认证

广播消息:除了在handleTextMessage方法中直接发送回复消息给单个客户端外,你还可以使用SimpMessagingTemplate来广播消息给所有订阅了特定主题的客户端。可以在WebSocketConfig中注入SimpMessagingTemplate,然后在处理程序中使用它发送消息。

@Autowired
private SimpMessagingTemplate messagingTemplate;

@Override
protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
    // 处理接收到的WebSocket消息
    String payload = message.getPayload();
    System.out.println("接收到消息:" + payload);

    // 广播消息给所有订阅了特定主题的客户端
    messagingTemplate.convertAndSend("/topic/messages", "收到消息:" + payload);
}
  • 用户认证和授权:如果你的应用程序需要对WebSocket连接进行认证和授权,你可以使用Spring Security框架来实现。你可以在WebSocketConfigurer的registerWebSocketHandlers方法中添加适当的拦截器来处理认证和授权逻辑。例如,使用HandshakeInterceptor进行握手阶段的认证,并使用ChannelInterceptor来拦截和处理每个消息的授权逻辑。
  • 处理其他WebSocket事件:除了处理连接建立、消息接收和连接关闭等事件外,你还可以覆盖其他WebSocket事件的处理方法,例如handleTransportError用于处理传输错误,handleBinaryMessage用于处理二进制消息等。根据你的需求,选择合适的方法进行覆盖和处理。
  • 集成其他功能:你可以将WebSocket与其他功能集成,例如数据库访问、消息队列、实时通知等。使用适当的组件和库,将WebSocket与你的应用程序的其他部分无缝集成,以实现更复杂的功能。
  • 三、转换器、存储与过滤器

    自定义消息转换器:Spring WebSocket框架支持使用不同的消息转换器来处理不同类型的消息。你可以自定义消息转换器,以实现自定义的消息格式和处理逻辑。通过实现WebSocketMessageConverter接口,你可以定义自己的消息转换器,并在WebSocketConfig中进行配置。

    @Configuration
    @EnableWebSocket
    public class WebSocketConfig implements WebSocketConfigurer {
    
        @Override
        public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
                    registry.addHandler(new MyWebSocketHandler(), "/websocket")
                    .setAllowedOrigins("*")
                    .addInterceptors(new HttpSessionHandshakeInterceptor())
                    .withSockJS();
        }
    
        @Override
        public void configureMessageBroker(MessageBrokerRegistry registry) {
            registry.enableSimpleBroker("/topic");
            registry.setApplicationDestinationPrefixes("/app");
        }
    
        @Override
        public boolean configureMessageConverters(List<MessageConverter> messageConverters) {
            // 添加自定义的消息转换器
            messageConverters.add(new MyMessageConverter());
            return true;
        }
    }

    2、广播消息给特定用户:除了广播消息给所有订阅了特定主题的客户端,你还可以使用SimpMessagingTemplate将消息发送给特定用户。通过将用户标识符作为消息的目的地,你可以确保消息仅发送给特定用户。

    @Autowired
    private SimpMessagingTemplate messagingTemplate;
    
    public void sendMessageToUser(String userId, String message) {
       messagingTemplate.convertAndSendToUser(userId, "/queue/messages", message);
    }

    3、会话管理和状态存储:WebSocket连接可以建立长时间的会话,你可能需要管理会话状态和存储用户相关的数据。你可以使用WebSocketSession对象来管理会话,并使用适当的存储机制(例如数据库、缓存等)来存储和检索会话状态。

    4、消息拦截器和过滤器:Spring WebSocket框架提供了拦截器和过滤器机制,允许你在处理消息之前或之后执行额外的逻辑。通过实现HandshakeInterceptor和ChannelInterceptor接口,你可以编写自定义的拦截器和过滤器来处理身份验证、消息转换、日志记录等操作。

    四、拦截器、STOMP协议

    1. 处理连接错误:WebSocket连接可能会出现错误,例如连接断开、超时等情况。你可以在handleTransportError方法中处理这些连接错误,并采取适当的措施,例如记录日志、重新连接等。
    @Override
    public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
        // 处理连接错误
        System.out.println("连接错误:" + exception.getMessage());
    
        // 可以根据具体情况采取适当的措施,例如关闭连接、重新连接等
    }

    2、使用WebSocket拦截器:WebSocket拦截器允许你在建立连接之前和之后执行额外的逻辑。你可以实现HandshakeInterceptor接口,并在WebSocketConfig中注册拦截器来处理握手阶段的逻辑。

    @Configuration
    @EnableWebSocket
    public class WebSocketConfig implements WebSocketConfigurer {
    
        @Override
        public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
            registry.addHandler(new MyWebSocketHandler(), "/websocket")
                    .setAllowedOrigins("*")
                    .addInterceptors(new MyHandshakeInterceptor())
                    .withSockJS();
        }
    
        // ...
    }

    3、使用自定义注解:你可以定义自己的注解,以便在WebSocket处理方法中进行更细粒度的控制。通过创建自定义注解并使用@Target(ElementType.METHOD)将其应用于处理方法,你可以在运行时执行特定的逻辑。

    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.METHOD)
    public @interface CustomWebSocketHandler {
        // 添加自定义属性
    }
    
    
    
    
    @CustomWebSocketHandler
    public void handleWebSocketMessage(WebSocketSession session, TextMessage message) {
        // 执行自定义逻辑
    }

    4、使用STOMP协议:STOMP(Simple Text Oriented Messaging Protocol)是一种简单的文本导向消息协议,用于在WebSocket之上进行消息传递。你可以使用Spring的STOMP支持来实现更高级的消息传递功能,例如订阅和发布、消息头、错误处理等。

    五、广播管理、定时任务

    1、消息广播和群组管理:除了向特定用户发送消息,你可能还需要实现消息的广播和群组管理功能。Spring WebSocket框架提供了SimpMessagingTemplate和SimpUserRegistry等工具类来实现这些功能。你可以使用SimpMessagingTemplate发送消息给特定主题或群组,而SimpUserRegistry则用于管理连接的用户和会话。

    @Autowired
    private SimpMessagingTemplate messagingTemplate;
    
    @Autowired
    private SimpUserRegistry userRegistry;
    
    public void broadcastMessage(String topic, String message) {
        messagingTemplate.convertAndSend(topic, message);
    }
    
    public Set<String> getConnectedUsers() {
        return userRegistry.getUsers().stream()
                .map(SimpUser::getName)
                .collect(Collectors.toSet());
    }

    2、定时任务和调度:在WebSocket应用中,你可能需要执行定时任务和调度任务,例如定时发送消息、定时清理会话等。你可以使用Spring框架提供的定时任务调度功能,结合WebSocket框架来实现这些任务。

    @Component
    public class WebSocketScheduler {
    
        @Autowired
        private SimpMessagingTemplate messagingTemplate;
    
        @Scheduled(fixedDelay = 5000) // 每5秒执行一次
        public void sendScheduledMessage() {
            String message = "Scheduled message";
            messagingTemplate.convertAndSend("/topic/messages", message);
        }
    }

    3、跨域访问控制:如果你的WebSocket应用需要跨域访问控制,你可以配置相应的跨域策略。Spring WebSocket框架提供了setAllowedOrigins方法来设置允许的跨域来源。

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(new MyWebSocketHandler(), "/websocket")
                .setAllowedOrigins("http://example.com")
                .addInterceptors(new HttpSessionHandshakeInterceptor())
                .withSockJS();
    }

    4、安全认证和授权:如果你的WebSocket应用需要安全认证和授权,你可以结合Spring Security框架来实现。通过配置适当的安全规则和认证机制,你可以确保只有经过授权的用户才能建立WebSocket连接和发送消息。

    @Configuration
    @EnableWebSocket
    public class WebSocketConfig implements WebSocketConfigurer {
    
        @Override
        public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
            registry.addHandler(new MyWebSocketHandler(), "/websocket")
                    .setAllowedOrigins("*")
                    .addInterceptors(new HttpSessionHandshakeInterceptor())
                    .withSockJS();
        }
    
        // ...
    }
    @Configuration
    @EnableWebSecurity
    public class SecurityConfig extends WebSecurityConfigurerAdapter {
    
        @Override
        protected void configure(HttpSecurity http) throws Exception {
            http
                .authorizeRequests()
                .antMatchers("/websocket").authenticated()
                .anyRequest().permitAll()
                .and()
                .formLogin()
                .permitAll()
                .and()
                .logout()
                .permitAll();
        }
    }

    六、存储、多频道管理与部署

    1. 消息存储和持久化:如果你的应用需要存储和持久化消息,可以结合使用WebSocket和消息队列或数据库来实现。当接收到消息时,你可以将消息存储到数据库或消息队列中,并在需要的时候进行读取和处理。
    @Autowired
    private MessageRepository messageRepository;
    
    public void handleMessage(WebSocketSession session, TextMessage message) {
        // 存储消息到数据库或消息队列
        messageRepository.save(message.getPayload());
    }
    
    public List<String> getMessages() {
        // 从数据库或消息队列中读取消息
        return messageRepository.findAll();
    }

    2、多频道管理:如果你的应用需要管理多个频道或主题,可以考虑使用WebSocket的订阅和发布模式。你可以创建多个频道或主题,并在客户端订阅感兴趣的频道,以便接收相应的消息。

    @Autowired
    private SimpMessagingTemplate messagingTemplate;
    
    public void sendMessage(String channel, String message) {
        messagingTemplate.convertAndSend("/topic/" + channel, message);
    }
    
    public void subscribeChannel(String channel, WebSocketSession session) {
        messagingTemplate.subscribe("/topic/" + channel, session.getId());
    }
    
    public void unsubscribeChannel(String channel, WebSocketSession session) {
        messagingTemplate.unsubscribe("/topic/" + channel, session.getId());
    }

    3、跨服务器部署:如果你的应用需要在多个服务器上部署,可以考虑使用分布式消息代理来实现跨服务器的消息传递。一种常见的方案是使用RabbitMQ或Apache Kafka等消息队列作为消息代理,以确保消息在不同服务器之间的可靠传递。

    4、错误处理和异常处理:在处理WebSocket连接和消息时,可能会出现错误和异常。你可以实现WebSocketHandler接口的handleTransportError和handleMessageException方法来处理连接错误和消息异常,并进行相应的处理,例如记录日志、发送错误消息等。

    public class MyWebSocketHandler implements WebSocketHandler {

    @Override
        public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
            // 处理连接错误
        }
    
        @Override
        public void handleMessage(WebSocketSession session, WebSocketMessage<?> message) throws Exception {
            try {
                // 处理接收到的消息
            } catch (Exception e) {
                // 处理消息异常
            }
        }
    }

    相关推荐

    RACI矩阵:项目管理中的角色与责任分配利器

    作者:赵小燕RACI矩阵RACI矩阵是项目管理中的一种重要工具,旨在明确团队在各个任务中的角色和职责。通过将每个角色划分为负责人、最终责任人、咨询人和知情人四种类型,RACI矩阵确保每个人都清楚自己...

    在弱矩阵组织中,如何做好项目管理工作?「慕哲制图」

    慕哲出品必属精品系列在弱矩阵组织中,如何做好项目管理工作?【慕哲制图】-------------------------------慕哲制图系列0:一图掌握项目、项目集、项目组合、P2、商业分析和NP...

    Scrum模式:每日站会(Daily Scrum)

    定义每日站会(DailyScrum)是一个Scrum团队在进行Sprint期间的日常会议。这个会议的主要目的是为了应对Sprint计划中的不断变化,确保团队能够有效应对挑战并达成Sprint目标。为...

    大家都在谈论的敏捷开发&amp;Scrum,到底是什么?

    敏捷开发作为一种开发模式,近年来深受研发团队欢迎,与瀑布式开发相比,敏捷开发更轻量,灵活性更高,在当下多变环境下,越来越多团队选择敏捷开发。什么是敏捷?敏捷是一种在不确定和变化的环境中,通过创造和响应...

    敏捷与Scrum是什么?(scrum敏捷开发是什么)

    敏捷是一种思维模式和哲学,它描述了敏捷宣言中的一系列原则。另一方面,Scrum是一个框架,规定了实现这种思维方式的角色,事件,工件和规则/指南。换句话说,敏捷是思维方式,Scrum是规定实施敏捷哲学的...

    敏捷项目管理与敏捷:Scrum流程图一览

    敏捷开发中的Scrum流程通常可以用一个简单的流程图来表示,以便更清晰地展示Scrum框架的各个阶段和活动。以下是一个常见的Scrum流程图示例:这个流程图涵盖了Scrum框架的主要阶段和活动,其中包...

    一张图掌握项目生命周期模型及Scrum框架

    Mockito 的最佳实践(mock方法)

    记得以前面试的时候,面试官问我,平常开发过程中自己会不会测试?我回答当然会呀,自己写的代码怎么不测呢。现在想想我好像误会他的意思了,他应该是想问我关于单元测试,集成测试以及背后相关的知识,然而当时说到...

    EffectiveJava-5-枚举和注解(java枚举的作用与好处)

    用enum代替int常量1.int枚举:引入枚举前,一般是声明一组具名的int常量,每个常量代表一个类型成员,这种方法叫做int枚举模式。int枚举模式是类型不安全的,例如下面两组常量:性别和动物种...

    Maven 干货 全篇共:28232 字。预计阅读时间:110 分钟。建议收藏!

    Maven简介Maven这个词可以翻译为“知识的积累”,也可以翻译为“专家”或“内行”。Maven是一个跨平台的项目管理工具。主要服务于基于Java平台的项目构建、依赖管理和项目信息管理。仔...

    Java单元测试框架PowerMock学习(java单元测试是什么意思)

    前言高德的技术大佬在谈论方法论时说到:“复杂的问题要简单化,简单的问题要深入化。”这句话让我感触颇深,这何尝不是一套编写代码的方法——把一个复杂逻辑拆分为许多简单逻辑,然后把每一个简单逻辑进行深入实现...

    Spring框架基础知识-第六节内容(Spring高级话题)

    Spring高级话题SpringAware基本概念Spring的依赖注入的最大亮点是你所有的Bean对Spring容器的存在是没有意识的。但是在实际的项目中,你的Bean必须要意识到Spring容器...

    Java单元测试浅析(JUnit+Mockito)

    作者:京东物流秦彪1.什么是单元测试(1)单元测试环节:测试过程按照阶段划分分为:单元测试、集成测试、系统测试、验收测试等。相关含义如下:1)单元测试:针对计算机程序模块进行输出正确性检验工作...

    揭秘Java代码背后的质检双侠:JUnit与Mockito!

    你有没有发现,现在我们用的手机App、逛的网站,甚至各种智能设备,功能越来越复杂,但用起来却越来越顺畅,很少遇到那种崩溃、卡顿的闹心事儿?这背后可不是程序员一拍脑袋写完代码就完事儿了!他们需要一套严谨...

    单元测试框架哪家强?Junit来帮忙!

    大家好,在前面的文章中,给大家介绍了以注解和XML的方式分别实现IOC和依赖注入。并且我们定义了一个测试类,通过测试类来获取到了容器中的Bean,具体的测试类定义如下:@Testpublicvoid...

    取消回复欢迎 发表评论: