SpringBoot使用websocket(二)

本文详细介绍如何在SpringBoot项目中使用WebSocket实现一对一的消息发送功能。通过配置WebSocket依赖,创建消息对象和WebSocket服务,实现客户端上线、离线、错误处理及消息发送。文章提供了完整的代码示例,并演示了两个客户端之间的消息传递过程。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

本文讲解如何SpringBoot如何使用WebSocket进行一对一发送消息,如果想学习SpringBoot结合Websocket群发消息,可以前往查看我的上一篇文章:springboot结合websocket(一)

导入依赖
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-websocket</artifactId>
</dependency>
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>
<dependency>
    <groupId>com.google.code.gson</groupId>
    <artifactId>gson</artifactId>
</dependency>
新建Websocket配置类
/**
 * @author Gjing
 **/
@Configuration
public class WebsocketConfiguration {

    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}
新建消息对象
/**
 * @author Gjing
 **/
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
public class Message {

    private String userId;

    private String message;
}
新建websocket服务
/**
 * @author Gjing
 **/
@ServerEndpoint("/test-one")
@Component
@Slf4j
public class MyOneToOneServer {
    /**
     * 用于存放所有在线客户端
     */
    private static Map<String, Session> clients = new ConcurrentHashMap<>();

    private Gson gson = new Gson();

    @OnOpen
    public void onOpen(Session session) {
        log.info("有新的客户端上线: {}", session.getId());
        clients.put(session.getId(), session);
    }

    @OnClose
    public void onClose(Session session) {
        String sessionId = session.getId();
        log.info("有客户端离线: {}", sessionId);
        clients.remove(sessionId);
    }

    @OnError
    public void onError(Session session, Throwable throwable) {
        throwable.printStackTrace();
        if (clients.get(session.getId()) != null) {
            clients.remove(session.getId());
        }
    }

    @OnMessage
    public void onMessage(String message) {
        log.info("收到客户端发来的消息: {}", message);
        this.sendTo(gson.fromJson(message, Message.class));
    }

    /**
     * 发送消息
     *
     * @param message 消息对象
     */
    private void sendTo(Message message) {
        Session s = clients.get(message.getUserId());
        if (s != null) {
            try {
                s.getBasicRemote().sendText(message.getMessage());
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
}
测试
  • 上线两个客户端
    1
  • 使用其中一个客户端发送消息给另外一个,只需要带上另外一个客户端的id
    2
  • 接收方客户端
    3

本文中只介绍了最简单的业务处理方式,更深层次的处理各位请自行学习,demo源代码地址为:springboot-websocket

### 如何在Spring Boot项目中使用WebSocket进行实时通信 #### 一、引入依赖 为了使Spring Boot支持WebSocket,在项目的`pom.xml`文件中加入以下依赖[^3]: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> ``` #### 、配置WebSocket 创建一个名为`WebSocketConfig.java`的Java类用于配置WebSocket连接。该类通过继承`WebSocketConfigurer`接口并重写其方法来定义端点路径和其他设置[^1]: ```java @Configuration @EnableWebSocket public class WebSocketConfig implements WebSocketConfigurer { @Override public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) { registry.addHandler(myWebSocketHandler(), "/ws").setAllowedOrigins("*"); } @Bean public MyWebSocketHandler myWebSocketHandler() { return new MyWebSocketHandler(); } } ``` 这里设置了允许任何源(`*`)访问此WebScoket服务。 #### 三、编写处理程序 接着需要构建实际的消息处理器,即上面提到的`MyWebSocketHandler`对象。此类负责接收来自客户端的信息并向它们发送响应消息: ```java @Component public class MyWebSocketHandler extends TextWebSocketHandler { private final Logger logger = LoggerFactory.getLogger(MyWebSocketHandler.class); @Override protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception { String payload = message.getPayload(); logger.info("Received message from client: " + payload); // Echo back the received text to all connected clients or perform other actions. session.sendMessage(new TextMessage("Echo: " + payload)); } // Other methods can be overridden as needed... } ``` 这段代码实现了基本的功能——当接收到一条新消息时会记录日志并将相同的内容回传给发信方。 #### 四、启动应用程序 最后一步是在应用入口处添加必要的注解以启用自动装配功能,并确保整个工程能够正常运行起来。这通常位于主函数所在的那个类里边: ```java @SpringBootApplication public class Application { public static void main(String[] args){ SpringApplication.run(Application.class,args); } } ``` 以上就是关于如何利用Spring Boot框架快速搭建起一套简易版WebSocket聊天室系统的介绍[^4]。
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值