1. 程式人生 > >websocket實現資料庫更新時前端頁面實時重新整理

websocket實現資料庫更新時前端頁面實時重新整理

如題,實現以上功能,我知道主要有兩大種思路:

  1. 輪詢:輪詢的原理是隔一段時間向伺服器傳送一個請求,這裡不累述。這裡主要談一下第二種思路。
  2. websocket進行前後端通訊:websocket是html5的新協議,基於TCP,在一次握手後,建立http連線,實現客戶端與服務端全雙工通訊。相比較輪詢機制,節約資源,不需要頻繁的請求。

下面通過最精簡的javaweb+mysql例項說明,只貼出關鍵程式碼。(原碼放在github中,裡面有本例需要的websocket-api.jar,.sql檔案以及README.doc,方便理解本例)。

user.jsp:

<%@ page import="model.UserBean"
%>
<%@ page import="java.util.List" %> <%@ page import="fun.Client" %> <%@ page contentType="text/html;charset=UTF-8" language="java" %> <html> <head> <title>$Title$</title> </head> <body> <table id="table" border="1"> <tr
>
<th >id</th> <th >name</th> </tr> <% //的到資料庫資訊,放在list中 Client client=new Client(); List<UserBean> list= client.list(); if(list != null){ for(UserBean user : list){ %> <tr >
<td ><%=user.getId()%></td> <td ><%=user.getName()%></td> </tr> <% } } %> </table> <div id="message"></div> <script> var websocket = null; //判斷當前瀏覽器是否支援WebSocket if ('WebSocket' in window) { //建立連線,這裡的/websocket ,是ManagerServlet中開頭註解中的那個值 websocket = new WebSocket("ws://localhost:8080/websocket"); } else { alert('當前瀏覽器 Not support websocket') } //連線發生錯誤的回撥方法 websocket.onerror = function () { setMessageInnerHTML("WebSocket連線發生錯誤"); }; //連線成功建立的回撥方法 websocket.onopen = function () { setMessageInnerHTML("WebSocket連線成功"); } //接收到訊息的回撥方法 websocket.onmessage = function (event) { setMessageInnerHTML(event.data); if(event.data=="1"){ location.reload(); } } //連線關閉的回撥方法 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(); } </script> </body> </html>

前面插入的java程式碼得到資料庫中的資訊,後面的js程式碼實現websocket通訊。

ManagerServlet.java:

package fun;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
import java.io.IOException;
import java.sql.PreparedStatement;
import java.util.concurrent.CopyOnWriteArraySet;

/**
 * 這個類即實現了進行資料庫操作的Servlet類,又實現了Websocket的功能.
 */

//該註解用來指定一個URI,客戶端可以通過這個URI來連線到WebSocket,類似Servlet的註解mapping;
// servlet的註冊放在了web.xml中。
@ServerEndpoint(value = "/websocket")
public class ManagerServlet extends HttpServlet {
    //concurrent包的執行緒安全Set,用來存放每個客戶端對應的MyWebSocket物件。若要實現服務端與單一客戶端通訊的話,可以使用Map來存放,其中Key可以為使用者標識
    private static CopyOnWriteArraySet<ManagerServlet> webSocketSet = new CopyOnWriteArraySet<ManagerServlet>();
    //這個session不是Httpsession,相當於使用者的唯一標識,用它進行與指定使用者通訊
    private  javax.websocket.Session session=null;

    public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException,IOException {
        String msg;
        String name=request.getParameter("name");
        //這裡submit是資料庫操作的方法,如果插入資料成功,則傳送更新訊號
        if(submit(name)){
            //傳送更新訊號
            sendMessage();
            msg="ok!";
        }else {
            msg="error!";
        }
        response.sendRedirect("manager.jsp?msg="+msg);
    }
    public void doPost(HttpServletRequest request,HttpServletResponse reponse) throws ServletException, IOException {
        doGet(request,reponse);
    }

    /**
     * 向資料庫插入一個name
     * @param name
     * @return
     */
    public boolean submit(String name){
        DB db=new DB();
        String sql="insert into users(name) values(?)";
        try{
            PreparedStatement pstmt=db.con.prepareStatement(sql);
            pstmt.setString(1,name);
            pstmt.executeUpdate();
            return true;
        }catch (Exception e){
            e.printStackTrace();
            return false;
        }finally {
            db.close();
        }
    }

    /**
     * @OnOpen allows us to intercept the creation of a new session.
     * The session class allows us to send data to the user.
     * In the method onOpen, we'll let the user know that the handshake was
     * successful.
     * 建立websocket連線時呼叫
     */
    @OnOpen
    public void onOpen(Session session){
        System.out.println("Session " + session.getId() + " has opened a connection");
        try {
            this.session=session;
            webSocketSet.add(this);     //加入set中
            session.getBasicRemote().sendText("Connection Established");
        } catch (IOException ex) {
            ex.printStackTrace();
        }
    }

    /**
     * When a user sends a message to the server, this method will intercept the message
     * and allow us to react to it. For now the message is read as a String.
     * 接收到客戶端訊息時使用,這個例子裡沒用
     */
    @OnMessage
    public void onMessage(String message, Session session){
        System.out.println("Message from " + session.getId() + ": " + message);
    }

    /**
     * The user closes the connection.
     *
     * Note: you can't send messages to the client from this method
     * 關閉連線時呼叫
     */
    @OnClose
    public void onClose(Session session){
        webSocketSet.remove(this);  //從set中刪除
        System.out.println("Session " +session.getId()+" has closed!");
    }

    /**
     * 注意: OnError() 只能出現一次.   其中的引數都是可選的。
     * @param session
     * @param t
     */
    @OnError
    public void onError(Session session, Throwable t) {
        t.printStackTrace();
    }

    /**
     * 這個方法與上面幾個方法不一樣。沒有用註解,是根據自己需要新增的方法。
     * @throws IOException
     * 傳送自定義訊號,“1”表示告訴前臺,資料庫發生改變了,需要重新整理
     */
    public void sendMessage() throws IOException{
        //群發訊息
        for(ManagerServlet item: webSocketSet){
            try {
                item.session.getBasicRemote().sendText("1");
            } catch (IOException e) {
                e.printStackTrace();
                continue;
            }
        }

    }
}

這個類首先繼承了HttpServlet,目的是接收表單資料完成資料庫的修改。其次,這個類實現了websocket的功能。在doGet()方法中,可以看到,一旦資料庫發生改變,就會向前臺傳送“1”,前臺收到“1”後即可重新整理頁面。