java WebSocket的實現以及Spring WebSocket

開始學習WebSocket，準備用它來實現一個在頁面實時輸出log4j的日誌以及控制檯的日誌。

首先知道一些基礎信息：

1. java7 開始支持WebSocket，而且只是作了定義，並未實現
2. tomcat7及以上，jetty 9.1及以上實現了WebSocket，其餘容器沒有研究
3. spring 4.0及以上增長了WebSocket的支持
4. spring 支持STOMP協議的WebSocket通訊
5. WebSocket 做爲java的一個擴展，它屬於javax包目錄下，一般須要手工引入該jar，以tomcat爲例，能夠在 tomcat/lib 目錄下找到 websocket-api.jar

 

開始實現

先寫一個普通的WebSocket客戶端，直接引入tomcat目錄下的jar，主要的jar有：websocket-api.jar、tomcat7-websocket.jar

1     public static void f1() {
 2         try {
 3             WebSocketContainer container = ContainerProvider.getWebSocketContainer(); // 獲取WebSocket鏈接器，其中具體實現能夠參照websocket-api.jar的源碼,Class.forName("org.apache.tomcat.websocket.WsWebSocketContainer");
 4             String uri = "ws://localhost:8081/log/log";
 5             Session session = container.connectToServer(Client.class, new URI(uri)); // 鏈接會話
 6             session.getBasicRemote().sendText("123132132131"); // 發送文本消息
 7             session.getBasicRemote().sendText("4564546");
 8         } catch (Exception e) {
 9             e.printStackTrace();
10         }
11     }

其中的URL格式必須是ws開頭，後面接註冊的WebSocket地址

Client.java 是用於收發消息

@ClientEndpoint
public class Client {

    @OnOpen
    public void onOpen(Session session) {
        System.out.println("Connected to endpoint: " + session.getBasicRemote());
    }

    @OnMessage
    public void onMessage(String message) {
        System.out.println(message);
    }

    @OnError
    public void onError(Throwable t) {
        t.printStackTrace();
    }
}

到這一步，客戶端的收發消息已經完成，如今開始編寫服務端代碼，用Spring 4.0，其中pom.xml太長就不貼出來了，會用到jackson,spring-websocket,spring-message

1 import org.springframework.beans.factory.annotation.Autowired;
 2 import org.springframework.context.annotation.Bean;
 3 import org.springframework.context.annotation.Configuration;
 4 import org.springframework.context.annotation.Lazy;
 5 import org.springframework.messaging.simp.SimpMessagingTemplate;
 6 import org.springframework.web.servlet.config.annotation.EnableWebMvc;
 7 import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
 8 import org.springframework.web.socket.WebSocketHandler;
 9 import org.springframework.web.socket.config.annotation.EnableWebSocket;
10 import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
11 import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;
12 
13 import com.gionee.log.client.LogWebSocketHandler;
14 
15 /**
16  * 註冊普通WebScoket
17  * @author PengBin
18  * @date 2016年6月21日 下午5:29:00
19  */
20 @Configuration
21 @EnableWebMvc
22 @EnableWebSocket
23 public class WebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer {
24 
25     @Autowired
26     @Lazy
27     private SimpMessagingTemplate template;
28 
29     /** {@inheritDoc} */
30     @Override
31     public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
32         registry.addHandler(logWebSocketHandler(), "/log"); // 此處與客戶端的 URL 相對應
33     }
34 
35     @Bean
36     public WebSocketHandler logWebSocketHandler() {
37         return new LogWebSocketHandler(template);
38     }
39 
40 }

1 import org.springframework.messaging.simp.SimpMessagingTemplate;
 2 import org.springframework.web.socket.TextMessage;
 3 import org.springframework.web.socket.WebSocketSession;
 4 import org.springframework.web.socket.handler.TextWebSocketHandler;
 5 
 6 /**
 7  * 
 8  * @author PengBin
 9  * @date 2016年6月24日 下午6:04:39
10  */
11 public class LogWebSocketHandler extends TextWebSocketHandler {
12 
13     private SimpMessagingTemplate template;
14 
15     public LogWebSocketHandler(SimpMessagingTemplate template) {
16         this.template = template;
17         System.out.println("初始化 handler");
18     }
19 
20     @Override
21     protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
22         String text = message.getPayload(); // 獲取提交過來的消息
23         System.out.println("handMessage:" + text);
24         // template.convertAndSend("/topic/getLog", text); // 這裏用於廣播
25         session.sendMessage(message);
26     }
27 }

這樣，一個普通的WebSocket就完成了，本身還能夠集成安全控制等等

Spring還支持一種註解的方式，能夠實現訂閱和廣播，採用STOMP格式協議，相似MQ，其實應該就是用的MQ的消息格式，下面是實現

一樣客戶端：

1     public static void main(String[] args) {
 2         try {
 3             WebSocketContainer container = ContainerProvider.getWebSocketContainer();
 4             String uri = "ws://localhost:8081/log/hello/hello/websocket";
 5             Session session = container.connectToServer(Client.class, new URI(uri));
 6             char lf = 10; // 這個是換行
 7             char nl = 0; // 這個是消息結尾的標記，必定要
 8             StringBuilder sb = new StringBuilder();
 9             sb.append("SEND").append(lf); // 請求的命令策略
10             sb.append("destination:/app/hello").append(lf); // 請求的資源
11             sb.append("content-length:14").append(lf).append(lf); // 消息體的長度
12             sb.append("{\"name\":\"123\"}").append(nl); // 消息體
13 
14             session.getBasicRemote().sendText(sb.toString()); // 發送消息
15             Thread.sleep(50000); // 等待一小會
16             session.close(); // 關閉鏈接
17 
18         } catch (Exception e) {
19             e.printStackTrace();
20         }
21     }

這裏必定要注意，換行符和結束符號，這個是STOMP協議規定的符號，錯了就不能解析到

服務端配置

1 /**
 2  * 啓用STOMP協議WebSocket配置
 3  * @author PengBin
 4  * @date 2016年6月24日 下午5:59:42
 5  */
 6 @Configuration
 7 @EnableWebMvc
 8 @EnableWebSocketMessageBroker
 9 public class WebSocketBrokerConfig extends AbstractWebSocketMessageBrokerConfigurer {
10 
11     /** {@inheritDoc} */
12     @Override
13     public void registerStompEndpoints(StompEndpointRegistry registry) {
14         System.out.println("註冊");
15         registry.addEndpoint("/hello").withSockJS(); // 註冊端點，和普通服務端的/log同樣的
16         // withSockJS()表示支持socktJS訪問，在瀏覽器中使用
17     }
18 
19     /** {@inheritDoc} */
20     @Override
21     public void configureMessageBroker(MessageBrokerRegistry config) {
22         System.out.println("啓動");
23         config.enableSimpleBroker("/topic"); // 
24         config.setApplicationDestinationPrefixes("/app"); // 格式前綴
25     }
26 
27 }

Controller

1 @Controller
 2 public class LogController {
 3 
 4     private SimpMessagingTemplate template;
 5 
 6     @Autowired
 7     public LogController(SimpMessagingTemplate template) {
 8         System.out.println("init");
 9         this.template = template;
10     }
11 
12     @MessageMapping("/hello") 
13     @SendTo("/topic/greetings") // 訂閱
14     public Greeting greeting(HelloMessage message) throws Exception {
15         System.out.println(message.getName());
16         Thread.sleep(3000); // simulated delay
17         return new Greeting("Hello, " + message.getName() + "!");
18     }
19 
20 }

到這裏就已經所有完成。

template.convertAndSend("/topic/greetings", "通知"); // 這個的意思就是向訂閱了/topic/greetings進行廣播

對於用socktJS鏈接的時候會有一個訪問 /info 地址的請求

若是在瀏覽器鏈接收發送消息，則用sockt.js和stomp.js

function connect() {
      var socket = new SockJS('/log/hello/hello');
      stompClient = Stomp.over(socket);
      stompClient.connect({}, function(frame) {
          setConnected(true);
          console.log('Connected: ' + frame);
          stompClient.subscribe('/topic/greetings', function(greeting) {
              showGreeting(JSON.parse(greeting.body).content);
          });
      });
  }

  function disconnect() {
      if (stompClient != null) {
          stompClient.disconnect();
      }
      setConnected(false);
      console.log("Disconnected");
  }

  function sendName() {
      var name = document.getElementById('name').value;
      stompClient.send("/app/hello", {}, JSON.stringify({
          'name' : name
      }));
  }

在瀏覽器中能夠看到請求返回101狀態碼，意思就是切換協議

更多信息參考：

1. STOMP協議  https://stomp.github.io/stomp-specification-1.2.html
2. Spring官方WebSocket demo  https://github.com/rstoyanchev/spring-websocket-test
3. 官方文檔 http://docs.spring.io/spring/docs/current/spring-framework-reference/html/websocket.html
4. http://assets.spring.io/wp/WebSocketBlogPost.html