18-Spring Websocket例子

本文介绍了如何使用Spring实现WebSocket通信,包括WebSocket的基本概念、创建消息处理器、启用WebSocket映射、建立JS客户端、启动Spring MVC应用,并讨论了在实现过程中遇到的问题及解决思路。

基本概念

WebSocket协议提供了通过一个套接字实现全双工通信的功能。它能够实现Web浏览器和服务器之间的异步通信,全双工意味着服务器可以发送消息给浏览器,浏览器也可以发送消息给服务器。Spring 4.0为WebSocket通信提供了支持,主要是实现服务器端和基于浏览器的应用(Web)之间的异步通信

 

创建WebSocket消息处理器

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.AbstractWebSocketHandler;

/**
 * WebSocket消息处理器
 */
public class MarcoHandler extends AbstractWebSocketHandler {

	private static final Logger logger = LoggerFactory.getLogger(MarcoHandler.class);
	
	@Override
	protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
		logger.info("Received message: " + message.getPayload());
		Thread.sleep(2000);
		session.sendMessage(new TextMessage("Polo!"));
	}
	
}

一般情况下,创建WebSocket消息处理器需要实现WebSocketHandler接口,该接口中有5个方法需要实现,不过,这里我们不实现WebSocketHandler接口,我们继承AbstractWebSocketHandler抽象类。该类实现了WebSocketHandler接口,并提供了默认的实现,因此继承AbstractWebSocketHandler的一个好处是,只需要重写我们关心的方法就行。这个例子中,我们只关心文本消息的处理,因此我们只需要重写handleTextMessage方法就可以,而不用实现WebSocketHandler的所有接口

 

启用WebSocket并映射消息处理器

### Spring WebSocket 2.1.5 实现 WebSocket 连接 要在 Spring Boot 中使用 `spring-websocket` 版本 2.1.5.RELEASE 来实现 WebSocket 功能,可以按照以下方法完成配置和开发。 #### 配置依赖 首先,在项目的 `pom.xml` 文件中引入必要的依赖项: ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> <version>2.1.5.RELEASE</version> </dependency> ``` 此依赖包含了构建 WebSocket 应用所需的核心库[^3]。 --- #### 创建 WebSocket 配置类 创建一个配置类用于启用 WebSocket 支持。通过定义 `ServerEndpointExporter` Bean 自动扫描并注册带有 `@ServerEndpoint` 注解的 Endpoint 类。 以下是示例代码: ```java package com.example.websocket.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.web.socket.server.standard.ServerEndpointExporter; @Configuration public class WebSocketConfig { /** * 启用WebSocket支持的关键组件。 */ @Bean public ServerEndpointExporter serverEndpointExporter() { return new ServerEndpointExporter(); } } ``` 这个配置文件的作用是让 Spring 容器能够识别并管理所有的 WebSocket 组件。 --- #### 编写 WebSocket 处理逻辑 接下来编写处理客户端请求的具体业务逻辑。可以通过 Java 的标准 API 或者 Spring 提供的支持来实现。 ##### 使用标准注解的方式 下面是一个基于 `javax.websocket` 标准接口编写的 WebSocket Handler 示例: ```java package com.example.websocket.endpoint; import javax.websocket.OnClose; import javax.websocket.OnError; import javax.websocket.OnMessage; import javax.websocket.OnOpen; import javax.websocket.Session; import javax.websocket.server.ServerEndpoint; import java.io.IOException; import java.util.Collections; import java.util.HashSet; import java.util.Set; @ServerEndpoint("/ws") public class MyWebSocketHandler { private static final Set<Session> sessions = Collections.synchronizedSet(new HashSet<>()); @OnOpen public void onOpen(Session session) { sessions.add(session); System.out.println("New connection: " + session.getId()); } @OnMessage public String onMessage(String message, Session session) throws IOException { System.out.println("Received from client: " + message); // 广播消息给所有连接的客户端 synchronized (sessions) { for (Session s : sessions) { if (!s.equals(session)) { s.getBasicRemote().sendText(message); } } } return "Echo: " + message; } @OnClose public void onClose(Session session) { sessions.remove(session); System.out.println("Connection closed: " + session.getId()); } @OnError public void onError(Throwable error, Session session) { System.err.println("Error occurred in session " + session.getId()); error.printStackTrace(); } } ``` 在这个例子中,我们实现了基本的消息接收、广播以及错误处理的功能[^1]。 --- #### 测试 WebSocket 接口 启动应用程序后,可以在浏览器控制台或者 Postman 工具中测试 WebSocket 接口。例如,打开两个标签页分别连接到 `/ws` 地址,并发送消息查看是否成功广播至其他客户端。 --- #### 日志框架调整(可选) 如果希望自定义日志框架而不是默认使用的 Logback,则可以根据需求替换为 Log4j2。具体做法如下所示: 在 `pom.xml` 中排除默认的日志依赖,并加入 Log4j2 的依赖包: ```xml <dependencies> <!-- 剔除默认 logging --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> <version>2.1.5.RELEASE</version> <exclusions> <exclusion> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-logging</artifactId> </exclusion> </exclusions> </dependency> <!-- 添加 log4j2 --> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-log4j2</artifactId> </dependency> </dependencies> ``` 这样就可以切换到 Log4j2 作为日志记录工具[^4]。 --- #### 总结 以上就是在 Spring Boot 2.1.5.RELEASE 中集成 WebSocket 的完整流程。通过简单的配置即可快速搭建起具备实时通信能力的应用程序。 ---
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值