1. 程式人生 > 程式設計 >基於java實現websocket協議過程詳解

基於java實現websocket協議過程詳解

最近了解了下websocket和socket這個東西,說不得不來說下為何要使用 WebSocket ,和為何不用http。

為何需要WebSocket ?

HTTP 協議是一種無狀態的、無連線的、單向的應用層協議。它採用了請求/響應模型。通訊請求只能由客戶端發起,服務端對請求做出應答處理。

這種通訊模型有一個弊端:HTTP 協議無法實現伺服器主動向客戶端發起訊息。

這種單向請求的特點,註定瞭如果伺服器有連續的狀態變化,客戶端要獲知就非常麻煩。大多數 Web 應用程式將通過頻繁的非同步JavaScript和XML(AJAX)請求實現長輪詢。輪詢的效率低,非常浪費資源(因為必須不停連線,或者 HTTP 連線始終開啟)。

因此,工程師們一直在思考,有沒有更好的方法。WebSocket 就是這樣發明的。WebSocket 連線允許客戶端和伺服器之間進行全雙工通訊,以便任一方都可以通過建立的連線將資料推送到另一端。WebSocket 只需要建立一次連線,就可以一直保持連線狀態。這相比於輪詢方式的不停建立連線顯然效率要大大提高。

下面來一個例子,實現web客戶端和伺服器端的連續通訊。

客戶端頁面index.html

<!DOCTYPE html>
<html>
<head>
  <title>Java後端WebSocket的Tomcat實現</title>
</head>
<body>
  Welcome<br/><input id="text" type="text"/>
  <button onclick="send()">傳送訊息</button>
  <hr/>
  <button onclick="closeWebSocket()">關閉WebSocket連線</button>
  <hr/>
  <div id="message"></div>
</body>
 
<script type="text/javascript">
  var websocket = null;
  //判斷當前瀏覽器是否支援WebSocket
  if ('WebSocket' in window) {
    websocket = new WebSocket("ws://localhost:8080/Testwebsocket/websocket");
  }
  else {
    alert('當前瀏覽器 Not support websocket')
  }
 
  //連線發生錯誤的回撥方法
  websocket.onerror = function () {
    setMessageInnerHTML("WebSocket連線發生錯誤");
  };
 
  //連線成功建立的回撥方法
  websocket.onopen = function () {
    setMessageInnerHTML("WebSocket連線成功");
  }
 
  //接收到訊息的回撥方法
  websocket.onmessage = function (event) {
    setMessageInnerHTML(event.data);
  }
 
  //連線關閉的回撥方法
  websocket.onclose = function () {
    setMessageInnerHTML("WebSocket連線關閉");
  }
 
  //監聽視窗關閉事件,當視窗關閉時,主動去關閉websocket連線,防止連線還沒斷開就關閉視窗,server端會拋異常。
  window.onbeforeunload = function () {
    closeWebSocket();
  }
 
  //將訊息顯示在網頁上
  function setMessageInnerHTML(innerHTML) {
    document.getElementById('message').innerHTML += innerHTML + '<br/>';
  }
 
  //關閉WebSocket連線
  function closeWebSocket() {
    websocket.close();
  }
 
  //傳送訊息
  function send() {
    var message = document.getElementById('text').value;
    websocket.send(message);
  }
</script>
</html>

伺服器端:伺服器端的很簡單。

1.建立一個web 的maven專案

2.引入一個包

<!-- websocket -->
  <dependency>
   <groupId>javax</groupId>
   <artifactId>javaee-api</artifactId>
   <version>7.0</version>
   <scope>provided</scope>
  </dependency>

3.建立一個類。

package com.sun.web.handler;
 
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;
 
import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
 
/**
 * @ServerEndpoint 註解是一個類層次的註解,它的功能主要是將目前的類定義成一個websocket伺服器端,* 註解的值將被用於監聽使用者連線的終端訪問URL地址,客戶端可以通過這個URL來連線到WebSocket伺服器端
 */
@ServerEndpoint("/websocket")
public class WebSocketTest {
  //靜態變數,用來記錄當前線上連線數。應該把它設計成執行緒安全的。
  private static int onlineCount = 0;
 
  //concurrent包的執行緒安全Set,用來存放每個客戶端對應的MyWebSocket物件。若要實現服務端與單一客戶端通訊的話,可以使用Map來存放,其中Key可以為使用者標識
  private static CopyOnWriteArraySet<WebSocketTest> webSocketSet = new CopyOnWriteArraySet<WebSocketTest>();
 
  //與某個客戶端的連線會話,需要通過它來給客戶端傳送資料
  private Session session;
 
  /**
   * 連線建立成功呼叫的方法
   * @param session 可選的引數。session為與某個客戶端的連線會話,需要通過它來給客戶端傳送資料
   */
  @OnOpen
  public void onOpen(Session session){
    this.session = session;
    webSocketSet.add(this);   //加入set中
    addOnlineCount();      //線上數加1
    System.out.println("有新連線加入!當前線上人數為" + getOnlineCount());
  }
 
  /**
   * 連線關閉呼叫的方法
   */
  @OnClose
  public void onClose(){
    webSocketSet.remove(this); //從set中刪除
    subOnlineCount();      //線上數減1
    System.out.println("有一連線關閉!當前線上人數為" + getOnlineCount());
  }
 
  /**
   * 收到客戶端訊息後呼叫的方法
   * @param message 客戶端傳送過來的訊息
   * @param session 可選的引數
   */
  @OnMessage
  public void onMessage(String message,Session session) {
    System.out.println("來自客戶端的訊息:" + message);
    //群發訊息
    for(WebSocketTest item: webSocketSet){
      try {
        item.sendMessage(message);
      } catch (IOException e) {
        e.printStackTrace();
        continue;
      }
    }
  }
 
  /**
   * 發生錯誤時呼叫
   * @param session
   * @param error
   */
  @OnError
  public void onError(Session session,Throwable error){
    System.out.println("發生錯誤");
    error.printStackTrace();
  }
 
  /**
   * 這個方法與上面幾個方法不一樣。沒有用註解,是根據自己需要新增的方法。
   * @param message
   * @throws IOException
   */
  public void sendMessage(String message) throws IOException{
    this.session.getBasicRemote().sendText(message);
    //this.session.getAsyncRemote().sendText(message);
  }
 
  public static synchronized int getOnlineCount() {
    return onlineCount;
  }
 
  public static synchronized void addOnlineCount() {
    WebSocketTest.onlineCount++;
  }
 
  public static synchronized void subOnlineCount() {
    WebSocketTest.onlineCount--;
  }
}

4.以上三步就OK了,然後就是用tomcat執行就行了。

效果如圖:

基於java實現websocket協議過程詳解

後期整合了springboot + websocket,並且實現了定時推送給前,還可以實現推送給某個人,不過需要引數.

地址 :

https://github.com/sun2955/spring-test-study.git

以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支援我們。