詳解java WebSocket的實(shí)現(xiàn)以及Spring WebSocket

更新時(shí)間：2017年01月21日 17:17:42 作者：akanairen

這篇文章主要介紹了詳解java WebSocket的實(shí)現(xiàn)以及Spring WebSocket ,具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下。

開(kāi)始學(xué)習(xí)WebSocket，準(zhǔn)備用它來(lái)實(shí)現(xiàn)一個(gè)在頁(yè)面實(shí)時(shí)輸出log4j的日志以及控制臺(tái)的日志。

首先知道一些基礎(chǔ)信息：

1.java7 開(kāi)始支持WebSocket，并且只是做了定義，并未實(shí)現(xiàn)

2.tomcat7及以上，jetty 9.1及以上實(shí)現(xiàn)了WebSocket，其他容器沒(méi)有研究

3.spring 4.0及以上增加了WebSocket的支持

4.spring 支持STOMP協(xié)議的WebSocket通信

5.WebSocket 作為java的一個(gè)擴(kuò)展，它屬于javax包目錄下，通常需要手工引入該jar，以tomcat為例，可以在 tomcat/lib 目錄下找到 websocket-api.jar

開(kāi)始實(shí)現(xiàn)

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

public static void f1() {
    try {
      WebSocketContainer container = ContainerProvider.getWebSocketContainer(); // 獲取WebSocket連接器，其中具體實(shí)現(xiàn)可以參照websocket-api.jar的源碼,Class.forName("org.apache.tomcat.websocket.WsWebSocketContainer");
      String uri = "ws://localhost:8081/log/log";
      Session session = container.connectToServer(Client.class, new URI(uri)); // 連接會(huì)話
      session.getBasicRemote().sendText("123132132131"); // 發(fā)送文本消息
      session.getBasicRemote().sendText("4564546");
    } catch (Exception e) {
      e.printStackTrace();
    }
  }

其中的URL格式必須是ws開(kāi)頭，后面接注冊(cè)的WebSocket地址

Client.java 是用于收發(fā)消息

@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();
  }
}

到這一步，客戶端的收發(fā)消息已經(jīng)完成，現(xiàn)在開(kāi)始編寫(xiě)服務(wù)端代碼，用Spring 4.0，其中pom.xml太長(zhǎng)就不貼出來(lái)了，會(huì)用到j(luò)ackson,spring-websocket,spring-message

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Lazy;
import org.springframework.messaging.simp.SimpMessagingTemplate;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
import org.springframework.web.socket.WebSocketHandler;
import org.springframework.web.socket.config.annotation.EnableWebSocket;
import org.springframework.web.socket.config.annotation.WebSocketConfigurer;
import org.springframework.web.socket.config.annotation.WebSocketHandlerRegistry;

import com.gionee.log.client.LogWebSocketHandler;

/**
 * 注冊(cè)普通WebScoket
 * @author PengBin
 * @date 2016年6月21日 下午5:29:00
 */
@Configuration
@EnableWebMvc
@EnableWebSocket
public class WebSocketConfig extends WebMvcConfigurerAdapter implements WebSocketConfigurer {

  @Autowired
  @Lazy
  private SimpMessagingTemplate template;

  /** {@inheritDoc} */
  @Override
  public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
    registry.addHandler(logWebSocketHandler(), "/log"); // 此處與客戶端的 URL 相對(duì)應(yīng)
  }

  @Bean
  public WebSocketHandler logWebSocketHandler() {
    return new LogWebSocketHandler(template);
  }

}

import org.springframework.messaging.simp.SimpMessagingTemplate;
import org.springframework.web.socket.TextMessage;
import org.springframework.web.socket.WebSocketSession;
import org.springframework.web.socket.handler.TextWebSocketHandler;

/**
 * 
 * @author PengBin
 * @date 2016年6月24日 下午6:04:39
 */
public class LogWebSocketHandler extends TextWebSocketHandler {

  private SimpMessagingTemplate template;

  public LogWebSocketHandler(SimpMessagingTemplate template) {
    this.template = template;
    System.out.println("初始化 handler");
  }

  @Override
  protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
    String text = message.getPayload(); // 獲取提交過(guò)來(lái)的消息
    System.out.println("handMessage:" + text);
    // template.convertAndSend("/topic/getLog", text); // 這里用于廣播
    session.sendMessage(message);
  }
}

這樣，一個(gè)普通的WebSocket就完成了，自己還可以集成安全控制等等

Spring還支持一種注解的方式，可以實(shí)現(xiàn)訂閱和廣播，采用STOMP格式協(xié)議，類(lèi)似MQ，其實(shí)應(yīng)該就是用的MQ的消息格式，下面是實(shí)現(xiàn)

同樣客戶端：

public static void main(String[] args) {
    try {
      WebSocketContainer container = ContainerProvider.getWebSocketContainer();
      String uri = "ws://localhost:8081/log/hello/hello/websocket";
      Session session = container.connectToServer(Client.class, new URI(uri));
      char lf = 10; // 這個(gè)是換行
      char nl = 0; // 這個(gè)是消息結(jié)尾的標(biāo)記，一定要
      StringBuilder sb = new StringBuilder();
      sb.append("SEND").append(lf); // 請(qǐng)求的命令策略
      sb.append("destination:/app/hello").append(lf); // 請(qǐng)求的資源
      sb.append("content-length:14").append(lf).append(lf); // 消息體的長(zhǎng)度
      sb.append("{\"name\":\"123\"}").append(nl); // 消息體

      session.getBasicRemote().sendText(sb.toString()); // 發(fā)送消息
      Thread.sleep(50000); // 等待一小會(huì)
      session.close(); // 關(guān)閉連接

    } catch (Exception e) {
      e.printStackTrace();
    }
  }

這里一定要注意，換行符和結(jié)束符號(hào)，這個(gè)是STOMP協(xié)議規(guī)定的符號(hào)，錯(cuò)了就不能解析到

服務(wù)端配置

/**
 * 啟用STOMP協(xié)議WebSocket配置
 * @author PengBin
 * @date 2016年6月24日 下午5:59:42
 */
@Configuration
@EnableWebMvc
@EnableWebSocketMessageBroker
public class WebSocketBrokerConfig extends AbstractWebSocketMessageBrokerConfigurer {

  /** {@inheritDoc} */
  @Override
  public void registerStompEndpoints(StompEndpointRegistry registry) {
    System.out.println("注冊(cè)");
    registry.addEndpoint("/hello").withSockJS(); // 注冊(cè)端點(diǎn)，和普通服務(wù)端的/log一樣的
    // withSockJS()表示支持socktJS訪問(wèn)，在瀏覽器中使用
  }

  /** {@inheritDoc} */
  @Override
  public void configureMessageBroker(MessageBrokerRegistry config) {
    System.out.println("啟動(dòng)");
    config.enableSimpleBroker("/topic"); // 
    config.setApplicationDestinationPrefixes("/app"); // 格式前綴
  }

}

Controller

@Controller
public class LogController {

  private SimpMessagingTemplate template;

  @Autowired
  public LogController(SimpMessagingTemplate template) {
    System.out.println("init");
    this.template = template;
  }

  @MessageMapping("/hello") 
  @SendTo("/topic/greetings") // 訂閱
  public Greeting greeting(HelloMessage message) throws Exception {
    System.out.println(message.getName());
    Thread.sleep(3000); // simulated delay
    return new Greeting("Hello, " + message.getName() + "!");
  }

}

到這里就已經(jīng)全部完成。

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

對(duì)于用socktJS連接的時(shí)候會(huì)有一個(gè)訪問(wèn) /info 地址的請(qǐng)求

如果在瀏覽器連接收發(fā)送消息，則用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
   }));
 }

在瀏覽器中可以看到請(qǐng)求返回101狀態(tài)碼，意思就是切換協(xié)議