EndpointConfig端点配置类使用

EndpointConfig 是Spring WebSocket框架中的一个接口,用于配置WebSocket端点(Endpoint)。它提供了访问WebSocket端点配置信息的方法,这些信息在处理WebSocket连接时非常有用。以下是对 EndpointConfig 的详细介绍:

接口定义

EndpointConfig 接口位于 javax.websocket.server 包中,它是Java WebSocket API(JSR 356)的一部分。Spring WebSocket框架也提供了对这个接口的支持。

主要方法

  1. 返回一组类,这些类是在配置过程中传递给 EndpointConfig 的:Set<Class<?>> getClasses()

  2. 获取指定名称的初始化参数值:String getInitParam(String name)

  3. 获取所有的初始化参数:Map<String, String> getInitParams()

  4. 获取与当前WebSocket连接关联的用户主体(Principal):Principal getUserPrincipal()

  5. 检查当前用户是否具有指定的角色:boolean isUserInRole(String role)

  6. 获取路径参数的映射:Map<String, String> getPathParameters()

  7. 获取解码器列表:List<Class<? extends Decoder>> getDecoders()

  8. 获取编码器列表:List<Class<? extends Encoder>> getEncoders()

使用场景

  1. 初始化参数配置

    在配置中设置一些初始化参数,并在 Endpoint 中通过 EndpointConfig 访问这些参数。

  2. 用户认证和授权

    通过 getUserPrincipal()isUserInRole() 方法,你可以在连接建立时检查用户的身份和角色。

  3. 路径参数

    如果你的WebSocket端点URL中有路径参数,可以通过 getPathParameters() 方法获取这些参数。

  4. 编解码器

    配置自定义的编解码器,并在 Endpoint 中通过 getDecoders()getEncoders() 方法访问它们。

示例代码

如何在 Endpoint 中使用 EndpointConfig

java 复制代码
// 自定义配置器
public class ChatEndpointConfigurator extends ServerEndpointConfig.Configurator {

    @Override
    public void modifyHandshake(ServerEndpointConfig sec, HandshakeRequest request, HandshakeResponse response) {
        // 设置初始化参数
        sec.getUserProperties().put("myInitParam", "Hello, World!");

        // 设置路径参数
        Map<String, List<String>> pathParams = request.getUri().getQueryParameters();
        sec.getUserProperties().put("userId", pathParams.getFirst("userId"));

        // 设置用户主体
        Principal userPrincipal = new Principal() {
            @Override
            public String getName() {
                return "user123";
            }
        };
        sec.getUserProperties().put("javax.websocket.endpoint.principal", userPrincipal);
    }
}


@ServerEndpoint(value = "/chat", configurator = ChatEndpointConfigurator.class)
public class ChatEndpoint {

    @OnOpen
    public void onOpen(Session session, EndpointConfig config) {
        // 获取初始化参数
        String initParam = config.getInitParam("myInitParam");
        System.out.println("Init Param: " + initParam);

        // 获取路径参数
        Map<String, String> pathParams = config.getPathParameters();
        String userId = pathParams.get("userId");
        System.out.println("User ID: " + userId);

        // 获取用户主体
        Principal userPrincipal = config.getUserPrincipal();
        if (userPrincipal != null) {
            System.out.println("User Principal: " + userPrincipal.getName());
        }

        // 检查用户角色
        boolean isAdmin = config.isUserInRole("admin");
        System.out.println("Is Admin: " + isAdmin);
    }
}

完整WebSocket使用demo

WebSocket简易聊天室实现(有详细解释)-CSDN博客

相关推荐
用户29869853014几秒前
Java HTML 转 Word 完整指南
java·后端
渣哥9 分钟前
原来公平锁和非公平锁差别这么大
java
渣哥19 分钟前
99% 的人没搞懂:Semaphore 到底是干啥的?
java
J2K28 分钟前
JDK都25了,你还没用过ZGC?那真得补补课了
java·jvm·后端
kfyty72531 分钟前
不依赖第三方,不销毁重建,loveqq 框架如何原生实现动态线程池?
java·架构
isysc12 小时前
面了一个校招生,竟然说我是老古董
java·后端·面试
道可到5 小时前
Java 反射现代实践速查表(JDK 11+/17+)
java
道可到5 小时前
Java 反射现代实践指南(JDK 11+ / 17+ 适用)
java
玉衡子6 小时前
九、MySQL配置参数优化总结
java·mysql
叽哥6 小时前
Kotlin学习第 8 课:Kotlin 进阶特性:简化代码与提升效率
android·java·kotlin