提供了编程的基础技术教程

zl程序教程

您现在的位置是：首页 >  其他

当前栏目

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

服务器 WebSocket
2023-03-09 22:12:30 时间

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

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

 

  1. public class ProgrammaticEchoEnpoint extends Endpoint { 
  2.  
  3.     @Override 
  4.  
  5.     public void onOpen(Session session, EndpointConfig config) { 
  6.  
  7.         System.out.println("Peer " + session.getId() + " connected"); 
  8.  
  9.         session.addMessageHandler(new MessageHandler.Whole<String>() { 
  10.  
  11.             @Override 
  12.  
  13.             public void onMessage(String message) { 
  14.  
  15.                 try { 
  16.  
  17.                     session.getBasicRemote().sendText("Got message from " + session.getId() + "\n" + message); 
  18.  
  19.                 } catch (IOException ex) { 
  20.  
  21.                 } 
  22.  
  23.             } 
  24.  
  25.         }); 
  26.  
  27.     } 
  28.  
  29.     @Override 
  30.  
  31.     public void onClose(Session session, CloseReason closeReason) { 
  32.  
  33.         System.out.println("Peer " + session.getId() + " disconnected due to " + closeReason.getReasonPhrase()); 
  34.  
  35.     } 
  36.  
  37.     @Override 
  38.  
  39.     public void onError(Session session, Throwable error) { 
  40.  
  41.         System.out.println("Error communicating with peer " + session.getId() + ". Detail: "+ error.getMessage()); 
  42.  
  43.     } 
  44.  
  45. } 

 

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

 

  1. public class ProgrammaticEchoClient extends Endpoint { 
  2.  
  3.     @Override 
  4.  
  5.     public void onOpen(Session session, EndpointConfig config) { 
  6.  
  7.         System.out.println("Connected to server"); 
  8.  
  9.     } 
  10.  
  11.     //a message handler and other life cycle implementations have been skipped on purpose... 
  12.  
  13. } 

第二步——实现ServerApplicationConfig接口

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

 

  1. public class CustomServerAppConfigProvider implements ServerApplicationConfig { 
  2.  
  3.     @Override 
  4.  
  5.     public Set<ServerEndpointConfig> getEndpointConfigs(Set<Class<? extends Endpoint>> endpointClasses) { 
  6.  
  7.         Set<ServerEndpointConfig> result = new HashSet<>(); 
  8.  
  9.         for (Class epClass : endpointClasses) { 
  10.  
  11.             //need to ignore Client endpoint class 
  12.  
  13.             if (epClass.equals(ProgrammaticChatEndpoint.class)) { 
  14.  
  15.                 ServerEndpointConfig sec = ServerEndpointConfig.Builder.create(epClass, "/letschat").build(); 
  16.  
  17.                 result.add(sec); 
  18.  
  19.             } 
  20.  
  21.         } 
  22.  
  23.         return result; 
  24.  
  25.     } 
  26.  
  27.     @Override 
  28.  
  29.     public Set<Class<?>> getAnnotatedEndpointClasses(Set<Class<?>> scanned) { 
  30.  
  31.         return Collections.emptySet(); 
  32.  
  33.     } 
  34.  
  35. } 

 

怎样处理Client端点？

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

 

  1. WebSocketContainer webSocketContainer = ContainerProvider.getWebSocketContainer(); 
  2.  
  3. ClientEndpointConfig config = ClientEndpointConfig.Builder.create().decoders(StockTickDecoder.class).build(); 
  4.  
  5. Session session = webSocketContainer.connectToServer(StockTickerClient().class, config,  
  6.  
  7.                                                     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】

相关文章