Spring WebFlux WebSocket处理器中如何获取路径变量？

当然可以实现！在Spring WebFlux的WebSocket场景中，确实没法直接从WebSocketSession里拿到路径变量，但咱们有两种靠谱的方式来解决这个问题，我给你详细说说：

方法一：通过RouterFunction传递路径变量 #

这种方式适合用函数式路由配置的场景，核心思路是在握手阶段提取HTTP请求里的路径变量，然后把它存入WebSocket会话的属性中，后续处理器就能从属性里取出变量了。

首先定义你的WebSocket处理器，从会话属性中获取变量：

@Component
public class CustomWebSocketHandler implements WebSocketHandler {

    @Override
    public Mono<Void> handle(WebSocketSession session) {
        // 从会话属性中提取提前存入的路径变量
        String userId = session.getAttributes().get("userId").toString();
        System.out.println("已连接用户ID：" + userId);
        
        // 这里写你的WebSocket业务逻辑，比如收发消息
        return session.send(session.receive()
                .map(msg -> session.textMessage("用户" + userId + "，你发送的内容是：" + msg.getPayloadAsText())));
    }
}

然后配置RouterFunction，在路由时提取路径变量并存入属性：

@Configuration
public class WebSocketConfig {

    @Bean
    public RouterFunction<ServerResponse> webSocketRouter(CustomWebSocketHandler handler) {
        return RouterFunctions.route(
                // 匹配WebSocket请求路径，包含路径变量{userId}
                RequestPredicates.path("/ws/{userId}").and(RequestPredicates.ws()),
                request -> {
                    // 从HTTP请求中提取路径变量
                    String userId = request.pathVariable("userId");
                    // 将变量存入属性，传递给WebSocket处理器
                    return ServerResponse.ok()
                            .attributes(attributes -> attributes.put("userId", userId))
                            .body(BodyInserters.fromValue(handler));
                }
        );
    }
}

方法二：使用@WebSocketMapping注解直接获取 #

如果你用的是Spring Boot 2.4及以上版本，可以用@WebSocketMapping注解来简化开发，这个注解支持直接在方法参数中注入路径变量，不用手动处理属性传递。

示例代码如下：

@Component
public class AnnotatedWebSocketHandler {

    // 直接在路径中定义变量{userId}，方法参数通过@PathVariable接收
    @WebSocketMapping("/ws/{userId}")
    public Mono<Void> handleWebSocketSession(WebSocketSession session, @PathVariable String userId) {
        System.out.println("通过注解获取的用户ID：" + userId);
        
        // 业务逻辑示例：返回带用户ID的消息
        return session.send(session.receive()
                .map(msg -> session.textMessage("你好，用户" + userId + "，收到你的消息：" + msg.getPayloadAsText())));
    }
}

这种方式非常简洁，Spring会自动在握手阶段帮你提取路径变量并注入到方法参数中，不需要额外的路由配置（只要你引入了spring-boot-starter-webflux依赖，Spring Boot会自动处理WebSocket的相关配置）。

补充说明 #

为什么WebSocketSession里没有直接的路径变量呢？因为WebSocket的握手请求是HTTP协议，路径变量属于HTTP请求的信息，而握手完成后建立的WebSocket会话是基于TCP的，所以需要在握手阶段把HTTP请求里的路径变量“转移”到WebSocket会话的属性中，或者通过注解让框架帮你完成这个转移操作。

内容的提问来源于stack exchange，提问作者Slava