Java EE 7当中的编程式Websocket端点

这篇文章将简要演示如何利用Java Websocket API的编程式版本开发并部署（服务器与客户端）websocket端点。

第一步——扩展javax.websocket.Endpoint类

public class ProgrammaticEchoEnpoint extends Endpoint { 
 
    @Override 
 
    public void onOpen(Session session, EndpointConfig config) { 
 
        System.out.println("Peer " + session.getId() + " connected"); 
 
        session.addMessageHandler(new MessageHandler.Whole<String>() { 
 
            @Override 
 
            public void onMessage(String message) { 
 
                try { 
 
                    session.getBasicRemote().sendText("Got message from " + session.getId() + "\n" + message); 
 
                } catch (IOException ex) { 
 
                } 
 
            } 
 
        }); 
 
    } 
 
    @Override 
 
    public void onClose(Session session, CloseReason closeReason) { 
 
        System.out.println("Peer " + session.getId() + " disconnected due to " + closeReason.getReasonPhrase()); 
 
    } 
 
    @Override 
 
    public void onError(Session session, Throwable error) { 
 
        System.out.println("Error communicating with peer " + session.getId() + ". Detail: "+ error.getMessage()); 
 
    } 
 
} 

接下来我们还要编写客户端端点（使用同样的API组合）：

public class ProgrammaticEchoClient extends Endpoint { 
 
    @Override 
 
    public void onOpen(Session session, EndpointConfig config) { 
 
        System.out.println("Connected to server"); 
 
    } 
 
    //a message handler and other life cycle implementations have been skipped on purpose... 
 
} 

第二步——实现ServerApplicationConfig接口

该接口属于javax.websocket.server包的组成部分，且能够通过覆写以实现端点部署中的定制化逻辑（适用于注释以及编程式端点）。

public class CustomServerAppConfigProvider implements ServerApplicationConfig { 
 
    @Override 
 
    public Set<ServerEndpointConfig> getEndpointConfigs(Set<Class<? extends Endpoint>> endpointClasses) { 
 
        Set<ServerEndpointConfig> result = new HashSet<>(); 
 
        for (Class epClass : endpointClasses) { 
 
            //need to ignore Client endpoint class 
 
            if (epClass.equals(ProgrammaticChatEndpoint.class)) { 
 
                ServerEndpointConfig sec = ServerEndpointConfig.Builder.create(epClass, "/letschat").build(); 
 
                result.add(sec); 
 
            } 
 
        } 
 
        return result; 
 
    } 
 
    @Override 
 
    public Set<Class<?>> getAnnotatedEndpointClasses(Set<Class<?>> scanned) { 
 
        return Collections.emptySet(); 
 
    } 
 
} 

怎样处理Client端点？

如果有必要，大家也可以创建自己的ClientEndpointConfig实例，并利用它对指向websocket服务器端点的连接进行初始化。

WebSocketContainer webSocketContainer = ContainerProvider.getWebSocketContainer(); 
 
ClientEndpointConfig config = ClientEndpointConfig.Builder.create().decoders(StockTickDecoder.class).build(); 
 
Session session = webSocketContainer.connectToServer(StockTickerClient().class, config,  
 
                                                    new URI("ws://hotstocks.com/ticker")); 

注意事项：

• 客户端以及服务器端的config对象只能为等同于（编程式）对象的@ServerEndpoint以及@ClientEndpoint注释元素（例如值、编码器、解码器以及配置器等等）。
• 各独立builder类（ServerEndpointConfig.Builder与ClientEndpointConfig.Builder）用于分别创建服务器与客户端配置实例。
• ServerEndpointConfig实例的创建属于mandatory，因为服务器端点无法在不配合URI的前提下进行部署。不过这种情况在客户端端点方面不会出现——因为其全部作用就是接入现有服务器端点。
• 端点config（服务器&客户端）拥有configurator概念，其可通过对应builder方法进行创建与设置。
• 接下来我们还将发布更多与Websocket相关的指导性文章，各位敬请期待。

原文标题：Programmatic Websocket Endpoints in Java EE 7

【51CTO译稿，合作站点转载请注明原文译者和出处为51CTO.com】