SpringBoot使用Websocket(一)

webSocket是HTML5的一种新协议,它实现了服务端与客户端的全双工通信,建立在传输层,tcp协议之上,即浏览器与服务端需要先建立tcp协议,再发送webSocket连接建立请求。webSocket的连接:客户端发送请求信息,服务端接受到请求并返回相应的信息。连接建立。客户端发送http请求时,通过 Upgrade:webSocket Connection:Upgrade 告知服务器需要建立的是webSocket连接,并且还会传递webSocket版本号,协议的字版本号,原始地址,主机地址, webSocket相互通信的Header很小,大概只有2Bytes

本文介绍SpringBoot结合WebSocket实现群发消息, 如想学习如何一对一发送可看我第二篇文章springboot使用websocket(二)

一. 消息群发

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

    @Bean
    public ServerEndpointExporter serverEndpointExporter() {
        return new ServerEndpointExporter();
    }
}
3. 新建WebSocket服务端
/**
 * @author Gjing
 **/
@ServerEndpoint("/test")
@Component
@Slf4j
public class MyWebsocketServer {
    /**
     * 存放所有在线的客户端
     */
    private static Map<String, Session> clients = new ConcurrentHashMap<>();

    @OnOpen
    public void onOpen(Session session) {
        log.info("有新的客户端连接了: {}", session.getId());
        //将新用户存入在线的组
        clients.put(session.getId(), session);
    }

    /**
     * 客户端关闭
     * @param session session
     */
    @OnClose
    public void onClose(Session session) {
        log.info("有用户断开了, id为:{}", session.getId());
        //将掉线的用户移除在线的组里
        clients.remove(session.getId());
    }

    /**
     * 发生错误
     * @param throwable e
     */
    @OnError
    public void onError(Throwable throwable) {
        throwable.printStackTrace();
    }

    /**
     * 收到客户端发来消息
     * @param message  消息对象
     */
    @OnMessage
    public void onMessage(String message) {
        log.info("服务端收到客户端发来的消息: {}", message);
        this.sendAll(message);
    }

    /**
     * 群发消息
     * @param message 消息内容
     */
    private void sendAll(String message) {
        for (Map.Entry<String, Session> sessionEntry : clients.entrySet()) {
            sessionEntry.getValue().getAsyncRemote().sendText(message);
        }
    }
}
4. 启动后,客户端连接websocket

1

5. 客户端发送消息得到的响应和服务端的响应
  • 客户端
    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]。
评论 11
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值