Java EE 7當(dāng)中的編程式Websocket端點(diǎn)
譯文這篇文章將簡要演示如何利用Java Websocket API的編程式版本開發(fā)并部署(服務(wù)器與客戶端)websocket端點(diǎn)。
第一步——擴(kuò)展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());
- }
- }
接下來我們還要編寫客戶端端點(diǎn)(使用同樣的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...
- }
第二步——實(shí)現(xiàn)ServerApplicationConfig接口
該接口屬于javax.websocket.server包的組成部分,且能夠通過覆寫以實(shí)現(xiàn)端點(diǎn)部署中的定制化邏輯(適用于注釋以及編程式端點(diǎn))。
- 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端點(diǎn)?
如果有必要,大家也可以創(chuàng)建自己的ClientEndpointConfig實(shí)例,并利用它對指向websocket服務(wù)器端點(diǎn)的連接進(jìn)行初始化。
- 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"));
注意事項(xiàng):
- 客戶端以及服務(wù)器端的config對象只能為等同于(編程式)對象的@ServerEndpoint以及@ClientEndpoint注釋元素(例如值、編碼器、解碼器以及配置器等等)。
- 各獨(dú)立builder類(ServerEndpointConfig.Builder與ClientEndpointConfig.Builder)用于分別創(chuàng)建服務(wù)器與客戶端配置實(shí)例。
- ServerEndpointConfig實(shí)例的創(chuàng)建屬于mandatory,因?yàn)榉?wù)器端點(diǎn)無法在不配合URI的前提下進(jìn)行部署。不過這種情況在客戶端端點(diǎn)方面不會出現(xiàn)——因?yàn)槠淙孔饔镁褪墙尤氍F(xiàn)有服務(wù)器端點(diǎn)。
- 端點(diǎn)config(服務(wù)器&客戶端)擁有configurator概念,其可通過對應(yīng)builder方法進(jìn)行創(chuàng)建與設(shè)置。
- 接下來我們還將發(fā)布更多與Websocket相關(guān)的指導(dǎo)性文章,各位敬請期待。
原文標(biāo)題:Programmatic Websocket Endpoints in Java EE 7
【51CTO譯稿,合作站點(diǎn)轉(zhuǎn)載請注明原文譯者和出處為51CTO.com】