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

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

ztj100 2025-01-19 02:00 12 浏览 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) {
                // 处理消息异常
            }
        }
    }

    相关推荐

    从IDEA开始,迈进GO语言之门(idea got)

    前言笔者在学习GO语言编程的时候,GO语言在国内还没有像JAVA/Php/Python那样普及,绕了不少的弯路,要开始入门学习一门编程语言,最好就先从选择一个好的编程语言的开发环境开始,有了这个开发环...

    基于SpringBoot+MyBatis的私人影院java网上购票jsp源代码Mysql

    本项目为前几天收费帮学妹做的一个项目,JavaEEJSP项目,在工作环境中基本使用不到,但是很多学校把这个当作编程入门的项目来做,故分享出本项目供初学者参考。一、项目介绍基于SpringBoot...

    基于springboot的个人服装管理系统java网上商城jsp源代码mysql

    本项目为前几天收费帮学妹做的一个项目,JavaEEJSP项目,在工作环境中基本使用不到,但是很多学校把这个当作编程入门的项目来做,故分享出本项目供初学者参考。一、项目介绍基于springboot...

    基于springboot的美食网站Java食品销售jsp源代码Mysql

    本项目为前几天收费帮学妹做的一个项目,JavaEEJSP项目,在工作环境中基本使用不到,但是很多学校把这个当作编程入门的项目来做,故分享出本项目供初学者参考。一、项目介绍基于springboot...

    贸易管理进销存springboot云管货管账分析java jsp源代码mysql

    本项目为前几天收费帮学妹做的一个项目,JavaEEJSP项目,在工作环境中基本使用不到,但是很多学校把这个当作编程入门的项目来做,故分享出本项目供初学者参考。一、项目描述贸易管理进销存spring...

    SpringBoot+VUE员工信息管理系统Java人员管理jsp源代码Mysql

    本项目为前几天收费帮学妹做的一个项目,JavaEEJSP项目,在工作环境中基本使用不到,但是很多学校把这个当作编程入门的项目来做,故分享出本项目供初学者参考。一、项目介绍SpringBoot+V...

    目前见过最牛的一个SpringBoot商城项目(附源码)还有人没用过吗

    帮粉丝找了一个基于SpringBoot的天猫商城项目,快速部署运行,所用技术:MySQL,Druid,Log4j2,Maven,Echarts,Bootstrap...免费给大家分享出来前台演示...

    SpringBoot+Mysql实现的手机商城附带源码演示导入视频

    今天为大家带来的是基于SpringBoot+JPA+Thymeleaf框架的手机商城管理系统,商城系统分为前台和后台、前台用的是Bootstrap框架后台用的是SpringBoot+JPA都是现在主...

    全网首发!马士兵内部共享—1658页《Java面试突击核心讲》

    又是一年一度的“金九银十”秋招大热门,为助力广大程序员朋友“面试造火箭”,小编今天给大家分享的便是这份马士兵内部的面试神技——1658页《Java面试突击核心讲》!...

    SpringBoot数据库操作的应用(springboot与数据库交互)

    1.JDBC+HikariDataSource...

    SpringBoot 整合 Flink 实时同步 MySQL

    1、需求在Flink发布SpringBoot打包的jar包能够实时同步MySQL表,做到原表进行新增、修改、删除的时候目标表都能对应同步。...

    SpringBoot + Mybatis + Shiro + mysql + redis智能平台源码分享

    后端技术栈基于SpringBoot+Mybatis+Shiro+mysql+redis构建的智慧云智能教育平台基于数据驱动视图的理念封装element-ui,即使没有vue的使...

    Springboot+Mysql舞蹈课程在线预约系统源码附带视频运行教程

    今天发布的是由【猿来入此】的优秀学员独立做的一个基于springboot脚手架的Springboot+Mysql舞蹈课程在线预约系统,系统项目源代码在【猿来入此】获取!https://www.yuan...

    SpringBoot+Mysql在线众筹系统源码+讲解视频+开发文档(参考论文

    今天发布的是由【猿来入此】的优秀学员独立做的一个基于springboot脚手架的在线众筹管理系统,主要实现了普通用户在线参与众筹基本操作流程的全部功能,系统分普通用户、超级管理员等角色,除基础脚手架外...

    Docker一键部署 SpringBoot 应用的方法,贼快贼好用

    这两天发现个Gradle插件,支持一键打包、推送Docker镜像。今天我们来讲讲这个插件,希望对大家有所帮助!GradleDockerPlugin简介...

    取消回复欢迎 发表评论: