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博客

相关推荐
CUIYD_19894 分钟前
Eclipse 常用搜索功能汇总
java·ide·eclipse
野犬寒鸦1 小时前
力扣hot100:相交链表与反转链表详细思路讲解(160,206)
java·数据结构·后端·算法·leetcode
ytadpole2 小时前
揭秘设计模式:工厂模式的五级进化之路
java·设计模式
计算机毕业设计木哥2 小时前
计算机毕设选题:基于Python+Django的B站数据分析系统的设计与实现【源码+文档+调试】
java·开发语言·后端·python·spark·django·课程设计
失散132 小时前
分布式专题——1.2 Redis7核心数据结构
java·数据结构·redis·分布式·架构
用户3721574261352 小时前
Python 实现 HTML 转 Word 和 PDF
java
a587692 小时前
Java核心概念精讲:TCP与UDP的区别、Java NIO的几个核心组件与HTTP和HTTPS的区别等(46-50)
java·面试·nio
渣哥2 小时前
ConcurrentHashMap 的 get 要不要加锁?一次“多此一举”的心路历程
java
愿你天黑有灯下雨有伞2 小时前
一种基于注解与AOP的Spring Boot接口限流防刷方案
java·spring boot·后端
MuMuMu#3 小时前
JAVA NIO学习笔记基础强化学习总结
java·学习·nio