SpringBoot整合Netty处理WebSocket(支持url参数)

SpringBoot整合Netty处理WebSocket(支持url参数)

这篇文章是参考SpringBoot2+Netty+WebSocket(netty实现websocket,支持URL参数)这个博客文章进行编写完善的,有兴趣可以多多关注原博主。

后面经过自己的研究,看了Netty相关的WebSocket处理代码,重新写了一篇文章使用Netty处理WebSocket请求,可以更加优雅的处理WebSocket请求。


添加MAVEN依赖

<!-- Netty -->
<dependency>
    <groupId>io.netty</groupId>
    <artifactId>netty-all</artifactId>
    <version>4.1.45.Final</version>
</dependency>

WebSocketProperties配置类

为了能在SpringBoot项目中灵活配置相关的值,这里使用了配置类,并使用了默认值。

@Getter
@Setter
@Component
@ConfigurationProperties(prefix = "chat.websocket")
public class WebSocketProperties {
   

  private Integer port = 8081; // 监听端口
  private String path = "/ws"; // 请求路径
  private Integer boss = 2; // bossGroup线程数
  private Integer work = 2; // workGroup线程数

}

WebSocket连接通道池

用来管理已经连接的客户端通道,方便数据传输交互。

@Slf4j
@Component
public class NioWebSocketChannelPool {
   

  private final ChannelGroup channels = new DefaultChannelGroup(GlobalEventExecutor.INSTANCE);

  /**
   * 新增一个客户端通道
   *
   * @param channel
   */
  public void addChannel(Channel channel) {
   
    channels.add(channel);
  }

  /**
   * 移除一个客户端连接通道
   *
   * @param channel
   */
  public void removeChannel(Channel channel) {
   
    channels.remove(channel);
  }

}

请求路径工具类

public class RequestUriUtils {
   

  /**
   * 将路径参数转换成Map对象,如果路径参数出现重复参数名,将以最后的参数值为准
   * @param uri 传入的携带参数的路径
   * @return
   */
  public static Map<String, String> getParams(String uri) {
   
    Map<String, String> params = new HashMap<>(10);

    int idx = uri.indexOf("?");
    if (idx != -1) {
   
      String[] paramsArr = uri.substring(idx + 1).split("&"
### Spring Boot 整合 NettyWebSocket 实现方案 #### 1. 添加依赖项 要在Spring Boot项目中集成NettyWebSocket,首先需要在`pom.xml`文件中添加必要的依赖项。这通常包括Spring WebFlux、Netty以及WebSocket支持的相关库。 ```xml <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-webflux</artifactId> </dependency> <dependency> <groupId>io.projectreactor.netty</groupId> <artifactId>reactor-netty</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-websocket</artifactId> </dependency> ``` 这些依赖项提供了构建基于反应式的Web应用程序所需的基础结构和支持[^4]。 #### 2. 创建WebSocket配置类 创建一个Java配置类来定义WebSocket服务器的行为。通过继承`WebSocketServerEndpointConfigurer`并重写相应的方法可以自定义握手处理器和其他设置。 ```java @Configuration public class WebSocketConfig implements WebSocketServerCustomizer { @Override public void customize(ReactiveWebSocketService service) { // 自定义WebSocket服务行为 } } ``` 此部分代码用于初始化WebSocket服务端逻辑,并允许开发者根据需求调整其工作方式[^2]。 #### 3. 编写处理程序 编写具体的WebSocket事件处理程序,负责监听来自客户端的消息并与之交互。这里展示了一个简单的例子: ```java @Component @ServerEndpoint("/ws/{userId}") public class MyWebSocketHandler extends TextWebSocketHandler { private final Logger logger = LoggerFactory.getLogger(MyWebSocketHandler.class); @Autowired private PushMsgService pushMsgService; @OnOpen public void handleConnection(ServerHttpRequest request, ServerHttpResponse response, WebSocketSession session, EndpointConfig config) throws IOException { String userId = (String)session.getAttributes().get("USER_ID"); this.pushMsgService.addUser(userId, session); logger.info("New connection from user {}", userId); } @OnMessage public void handleMessage(TextMessage message, WebSocketSession session) throws IOException { // 处理接收到的信息 } @OnError public void handleError(Throwable error){ // 错误处理机制 } @OnClose public void handleClose(CloseReason reason, WebSocketSession session)throws Exception{ // 断开连接后的清理操作 } } ``` 上述代码片段展示了如何利用注解驱动的方式捕获不同类型的WebSocket生命周期事件,并执行相应的业务逻辑[^5]。 #### 4. 构建消息推送服务 为了能够向已建立的WebSocket会话发送通知或更新数据给前端页面,还需要开发一套有效的消息广播系统。下面给出了一种可能的设计模式——即封装好的`PushMsgService`接口及其默认实现: ```java @Service public class SimplePushMsgServiceImpl implements PushMsgService { private Map<String, List<WebSocketSession>> usersSessionsMap = new ConcurrentHashMap<>(); @Override public synchronized void addUser(String userId, WebSocketSession session) { if (!usersSessionsMap.containsKey(userId)) { usersSessionsMap.putIfAbsent(userId, Collections.synchronizedList(new ArrayList<>())); } usersSessionsMap.get(userId).add(session); } @Override public void pushMsgToOne(String userId, String msg) { Optional.ofNullable(usersSessionsMap.get(userId)) .ifPresent(sessions -> sessions.forEach(session -> sendToSession(msg, session))); } @Override public void pushMsgToAll(String msg) { usersSessionsMap.values() .stream() .flatMap(Collection::stream) .forEach(session -> sendToSession(msg, session)); } private void sendToSession(String msg, WebSocketSession session) { try { if (session.isOpen()) { session.sendMessage(new TextMessage(msg)); } } catch (IOException e) { log.error("Failed to send message", e); } } } ``` 这段代码实现了基本的一对一及一对多的消息分发能力,确保任何时刻都能及时有效地传递信息到目标用户那里。 #### 5. 测试与调试 最后,在完成以上步骤之后就可以启动应用并通过工具如Postman或者专门设计用来测试WebSocket的应用来进行验证了。确保一切正常运行后再考虑部署上线等问题[^3]。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值