基于java實現(xiàn)websocket代碼示例

更新時間：2020年12月01日 09:44:35 作者：手撕高達(dá)的村長

這篇文章主要介紹了基于java實現(xiàn)websocket代碼示例,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下

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

為何需要WebSocket ？

HTTP 協(xié)議是一種無狀態(tài)的、無連接的、單向的應(yīng)用層協(xié)議。它采用了請求/響應(yīng)模型。通信請求只能由客戶端發(fā)起，服務(wù)端對請求做出應(yīng)答處理。

這種通信模型有一個弊端：HTTP 協(xié)議無法實現(xiàn)服務(wù)器主動向客戶端發(fā)起消息。

這種單向請求的特點，注定了如果服務(wù)器有連續(xù)的狀態(tài)變化，客戶端要獲知就非常麻煩。大多數(shù) Web 應(yīng)用程序?qū)⑼ㄟ^頻繁的異步JavaScript和XML（AJAX）請求實現(xiàn)長輪詢。輪詢的效率低，非常浪費資源（因為必須不停連接，或者 HTTP 連接始終打開）。

因此，工程師們一直在思考，有沒有更好的方法。WebSocket 就是這樣發(fā)明的。WebSocket 連接允許客戶端和服務(wù)器之間進行全雙工通信，以便任一方都可以通過建立的連接將數(shù)據(jù)推送到另一端。WebSocket 只需要建立一次連接，就可以一直保持連接狀態(tài)。這相比于輪詢方式的不停建立連接顯然效率要大大提高。

下面來一個例子，實現(xiàn)web客戶端和服務(wù)器端的連續(xù)通訊。

客戶端頁面index.html

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

服務(wù)器端：服務(wù)器端的很簡單。

1.創(chuàng)建一個web 的maven項目

2.引入一個包

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

3.創(chuàng)建一個類。

package com.sun.web.handler;
 
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;
 
import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
 
/**
 * @ServerEndpoint 注解是一個類層次的注解，它的功能主要是將目前的類定義成一個websocket服務(wù)器端,
 * 注解的值將被用于監(jiān)聽用戶連接的終端訪問URL地址,客戶端可以通過這個URL來連接到WebSocket服務(wù)器端
 */
@ServerEndpoint("/websocket")
public class WebSocketTest {
  //靜態(tài)變量，用來記錄當(dāng)前在線連接數(shù)。應(yīng)該把它設(shè)計成線程安全的。
  private static int onlineCount = 0;
 
  //concurrent包的線程安全Set，用來存放每個客戶端對應(yīng)的MyWebSocket對象。若要實現(xiàn)服務(wù)端與單一客戶端通信的話，可以使用Map來存放，其中Key可以為用戶標(biāo)識
  private static CopyOnWriteArraySet<WebSocketTest> webSocketSet = new CopyOnWriteArraySet<WebSocketTest>();
 
  //與某個客戶端的連接會話，需要通過它來給客戶端發(fā)送數(shù)據(jù)
  private Session session;
 
  /**
   * 連接建立成功調(diào)用的方法
   * @param session 可選的參數(shù)。session為與某個客戶端的連接會話，需要通過它來給客戶端發(fā)送數(shù)據(jù)
   */
  @OnOpen
  public void onOpen(Session session){
    this.session = session;
    webSocketSet.add(this);   //加入set中
    addOnlineCount();      //在線數(shù)加1
    System.out.println("有新連接加入！當(dāng)前在線人數(shù)為" + getOnlineCount());
  }
 
  /**
   * 連接關(guān)閉調(diào)用的方法
   */
  @OnClose
  public void onClose(){
    webSocketSet.remove(this); //從set中刪除
    subOnlineCount();      //在線數(shù)減1
    System.out.println("有一連接關(guān)閉！當(dāng)前在線人數(shù)為" + getOnlineCount());
  }
 
  /**
   * 收到客戶端消息后調(diào)用的方法
   * @param message 客戶端發(fā)送過來的消息
   * @param session 可選的參數(shù)
   */
  @OnMessage
  public void onMessage(String message, Session session) {
    System.out.println("來自客戶端的消息:" + message);
    //群發(fā)消息
    for(WebSocketTest item: webSocketSet){
      try {
        item.sendMessage(message);
      } catch (IOException e) {
        e.printStackTrace();
        continue;
      }
    }
  }
 
  /**
   * 發(fā)生錯誤時調(diào)用
   * @param session
   * @param error
   */
  @OnError
  public void onError(Session session, Throwable error){
    System.out.println("發(fā)生錯誤");
    error.printStackTrace();
  }
 
  /**
   * 這個方法與上面幾個方法不一樣。沒有用注解，是根據(jù)自己需要添加的方法。
   * @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運行就行了。

效果如圖：