如何通过编程自定义WebSocket Endpoint参数及配置？

嘿，作为WebSocket新手，你的想法方向是对的，但只替换getEndpointConfigs方法里的类型肯定是不够的，咱们一步步理清楚问题和解决方案：

首先得明确**Java WebSocket规范（JSR-356）**的核心要求：容器只会识别直接或间接实现Endpoint接口的类作为合法的WebSocket端点，而且标准的onOpen方法签名是固定的——void onOpen(Session session, EndpointConfig config)，容器会严格按照这个签名来调用方法，所以你不能直接修改这个方法的参数列表。

那怎么实现给onOpen添加username这类自定义参数呢？这里有两种靠谱的方案：

方案1：基于编程式Endpoint的扩展（适配你的现有代码） #

你需要调整自定义抽象类的结构，让它继承标准Endpoint，然后通过EndpointConfig传递参数，再转发到你自定义的带参数的onOpen方法：

第一步：调整自定义抽象类 #

让它继承Endpoint，并实现标准的onOpen方法，在里面取出参数再调用你自定义的抽象方法：

public abstract class MyCustomEndpoint extends Endpoint {
    @Override
    public void onOpen(Session session, EndpointConfig config) {
        // 从EndpointConfig的用户属性中取出提前存入的username
        String username = (String) config.getUserProperties().get("username");
        // 调用自定义的带参数的onOpen方法
        this.onOpen(username, session, config);
    }

    // 自定义抽象方法，让子类实现
    public abstract void onOpen(String username, Session session, EndpointConfig config);
}

第二步：修改Configurator，存入自定义参数 #

在modifyHandshake方法里，从握手请求（比如URL参数、HTTP头、Cookie）中获取username，存入EndpointConfig的用户属性：

public class CustomConfigurator extends ServerEndpointConfig.Configurator {
    @Override
    public void modifyHandshake(ServerEndpointConfig sec, HandshakeRequest request, HandshakeResponse response) {
        // 示例：从URL查询参数中获取username，你也可以从HTTP头/Cookie取
        String username = request.getParameterMap().getOrDefault("username", Collections.singletonList("unknown")).get(0);
        sec.getUserProperties().put("username", username);
    }

    @Override
    public Set<ServerEndpointConfig> getEndpointConfigs(Set<Class<? extends Endpoint>> endpointClasses) {
        Set<ServerEndpointConfig> configs = new HashSet<>();
        for (Class<? extends Endpoint> clazz : endpointClasses) {
            // 这里的clazz就是你的MyCustomEndpoint子类
            ServerEndpointConfig config = ServerEndpointConfig.Builder.create(clazz, "/ws-endpoint")
                    .configurator(this)
                    .build();
            configs.add(config);
        }
        return configs;
    }
}

第三步：实现具体的端点类 #

public class MySpecificEndpoint extends MyCustomEndpoint {
    @Override
    public void onOpen(String username, Session session, EndpointConfig config) {
        // 这里就可以直接使用username参数了
        System.out.println("用户 " + username + " 已连接");
        // 后续的WebSocket逻辑写在这里
    }
}

方案2：用注解式端点（更简洁，推荐） #

如果不是必须用编程式的Endpoint，用@ServerEndpoint注解会更省心，能直接通过注解获取参数：

@ServerEndpoint(value = "/ws/{username}") // 从URL路径参数取username
// 或者从查询参数取：@ServerEndpoint(value = "/ws")
public class AnnotatedWebSocketEndpoint {
    @OnOpen
    public void onOpen(Session session, @PathParam("username") String username) {
        // 直接拿到username，无需额外配置
        System.out.println("用户 " + username + " 已连接");
    }

    // 你还可以添加@OnMessage、@OnClose等方法
    @OnMessage
    public void onMessage(String message, Session session) {
        // 处理消息
    }
}

回到你的问题：只替换类型为什么不够？ #

• 你的myCustomEndPoint没有继承标准Endpoint，容器根本识别不了它是合法的WebSocket端点，会直接报错。
• 就算继承了Endpoint，容器只会调用标准签名的onOpen方法，不会自动调用你自定义的带username的方法，必须手动做转发逻辑。

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