WebSocket在java Tomcat中實現

現很多網站爲了實現即時通訊，所用的技術都是輪詢(polling)。輪詢是在特定的的時間間隔（如每1秒），由瀏覽器對服務器發出HTTP request，然後由服務器返回最新的數據給客服端的瀏覽器。這種傳統的HTTP request 的模式帶來很明顯的缺點 – 瀏覽器需要不斷的向服務器發出請求，然而HTTP request 的header是非常長的，裏面包含的數據可能只是一個很小的值，這樣會佔用很多的帶寬。

而最比較新的技術去做輪詢的效果是Comet – 用了AJAX。但這種技術雖然可達到全雙工通信，但依然需要發出請求。

在 WebSocket API，瀏覽器和服務器只需要要做一個握手的動作，然後，瀏覽器和服務器之間就形成了一條快速通道。兩者之間就直接可以數據互相傳送。

輪詢是最原始的實現實時Web應用的解決方案。輪詢技術要求客戶端以設定的時間間隔週期性地向服務端發送請求，頻繁地查詢是否有新的數據改動。明顯地，這種方法會導致過多不必要的請求，浪費流量和服務器資源。

Comet技術又可以分爲長輪詢和流技術。長輪詢改進了上述的輪詢技術，減小了無用的請求。它會爲某些數據設定過期時間，當數據過期後纔會向服務端發送請求；這種機制適合數據的改動不是特別頻繁的情況。流技術通常是指客戶端使用一個隱藏的窗口與服務端建立一個HTTP長連接，服務端會不斷更新連接狀態以保持HTTP長連接存活；這樣的話，服務端就可以通過這條長連接主動將數據發送給客戶端；流技術在大併發環境下，可能會考驗到服務端的性能。

這兩種技術都是基於請求-應答模式，都不算是真正意義上的實時技術；它們的每一次請求、應答，都浪費了一定流量在相同的頭部信息上，並且開發複雜度也較大。

伴隨着HTML5推出的WebSocket，真正實現了Web的實時通信，使B/S模式具備了C/S模式的實時通信能力。WebSocket的工作流程是這樣的：瀏覽器通過JavaScript向服務端發出建立WebSocket連接的請求，在WebSocket連接建立成功後，客戶端和服務端就可以通過TCP連接傳輸數據。因爲WebSocket連接本質上是TCP連接，不需要每次傳輸都帶上重複的頭部數據，所以它的數據傳輸量比輪詢和Comet技術小了很多。本文不詳細地介紹WebSocket規範，主要介紹下WebSocket在Java
Web中的實現。

JavaEE 7中出了JSR-356:Java API for WebSocket規範。不少Web容器，如Tomcat,Nginx,Jetty等都支持WebSocket。Tomcat從7.0.27開始支持WebSocket，從7.0.47開始支持JSR-356，下面的Demo代碼也是需要部署在Tomcat7.0.47上才能運行。
客戶端（Web前端）代碼：

<%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>

<%

String path = request.getContextPath();

String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";

%>

<!DOCTYPE HTML>

<html>

  <head>

    <base href="<%=basePath%>">

    <title>My WebSocket</title>

  </head>

  <body>

    Welcome<br/>

    <input id="text" type="text" /><button οnclick="send()">Send</button>    <button οnclick="closeWebSocket()">Close</button>

    <div id="message">

    </div>

  </body>

  <script type="text/javascript">

      var websocket = null;

      //判斷當前瀏覽器是否支持WebSocket

      if('WebSocket' in window){

          websocket = new WebSocket("ws://localhost:8080/MyWebSocket/websocket");

      }

      else{

          alert('Not support websocket')

      }

      //連接發生錯誤的回調方法

      websocket.onerror = function(){

          setMessageInnerHTML("error");

      };

      //連接成功建立的回調方法

      websocket.onopen = function(event){

          setMessageInnerHTML("open");

      }

      //接收到消息的回調方法

      websocket.onmessage = function(){

          setMessageInnerHTML(event.data);

      }

      //連接關閉的回調方法

      websocket.onclose = function(){

          setMessageInnerHTML("close");

      }

      //監聽窗口關閉事件，當窗口關閉時，主動去關閉websocket連接，防止連接還沒斷開就關閉窗口，server端會拋異常。

      window.onbeforeunload = function(){

          websocket.close();

      }

      //將消息顯示在網頁上

      function setMessageInnerHTML(innerHTML){

          document.getElementById('message').innerHTML += innerHTML + '<br/>';

      }

      //關閉連接

      function closeWebSocket(){

          websocket.close();

      }

      //發送消息

      function send(){

          var message = document.getElementById('text').value;

          websocket.send(message);

      }

  </script>

</html>
Java Web後端代碼：

package com.chen.websocket;

import java.io.IOException;

import java.util.concurrent.CopyOnWriteArraySet;

import javax.websocket.OnClose;

import javax.websocket.OnError;

import javax.websocket.OnMessage;

import javax.websocket.OnOpen;

import javax.websocket.Session;

import javax.websocket.server.ServerEndpoint;

//該註解用來指定一個URI，客戶端可以通過這個URI來連接到WebSocket。類似Servlet的註解mapping

@ServerEndpoint("/websocket")

public class MyWebSocket {

    //靜態變量，用來記錄當前在線連接數。應該把它設計成線程安全的。

    private static int onlineCount = 0;

    //concurrent包的線程安全Set，用來存放每個客戶端對應的MyWebSocket對象。若要實現服務端與單一客戶端通信的話，可以使用Map來存放，其中Key可以爲用戶標識

    private static CopyOnWriteArraySet<MyWebSocket> webSocketSet = new CopyOnWriteArraySet<MyWebSocket>();

    //與某個客戶端的連接會話，需要通過它來給客戶端發送數據

    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(MyWebSocket 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() {

        MyWebSocket.onlineCount++;

    }

    public static synchronized void subOnlineCount() {

        MyWebSocket.onlineCount--;

    }

}

該Demo在以下環境測試過：

1.Jdk7+Tomcat7.0.47

2.Jdk7+Tomcat7.0.52

3.Jdk7+Tomcat8.0.3

4.Jdk7+Glassfish4

注意事項：在Eclipse或者MyEclipse中，需要添加Tomcat的library。直接拷貝Tomcat裏lib目錄下的jar包有時會出錯。

源碼github:https://github.com/sai129198/demo_webSocket_java

原文鏈接;http://blog.chenzuhuang.com/archive/28.html