2. 程式人生 > >Spring+Websocket實現伺服器與Andoird端通訊

Spring+Websocket實現伺服器與Andoird端通訊

阿新 • • 發佈：2019-01-08

本部落格伺服器端內容參考於部落格：http://www.cnblogs.com/3dianpomian/p/5902084.html。
寫這篇部落格的原因是在網上查閱了很多資料，關於websocket的介紹和程式碼很多，但是很少有統一給出伺服器端和Andorid端的具體實現的，在這裡給出我的解決方案，希望可以幫助大家。如有疑問，歡迎留言。

伺服器端

第一步：使用Maven(不會自行百度，這個很實用)自動更新新增依賴包

   <dependency>
         <groupId>org.springframework</groupId>
         <artifactId
 
>spring-websocket</artifactId>
         <version>${srping.version}</version>
   </dependency>
   <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-messaging</artifactId>
        <version>${srping.version}</version
 
>
   </dependency>

另外還有配置Sping的相關包，不在此全部列出。

第二步：配置WebSocket的入口,編寫WebSocketConfig類實現WebSocketConfigurer 介面

@Configuration
@EnableWebSocket
public class WebSocketConfig implements WebSocketConfigurer {

    @Override
    public void registerWebSocketHandlers(WebSocketHandlerRegistry registry) {
        registry.addHandler(webSocketHandler(),"/websocket/socketServer.do"
 
).addInterceptors(new SpringWebSocketHandlerInterceptor());
        registry.addHandler(webSocketHandler(), "/sockjs/socketServer.do").addInterceptors(new SpringWebSocketHandlerInterceptor()).withSockJS();       
    }

    @Bean
    public TextWebSocketHandler webSocketHandler(){
        return new SpringWebSocketHandler();
    }
}

第三步：定義一個SpringWebSocketHandler類繼承TextWebSocketHandler，這個類是用來處理Websocket連線建立、斷開，訊息傳送的邏輯的，這個是訊息處理的核心程式碼

public class SpringWebSocketHandler extends TextWebSocketHandler {
    private static final ArrayList<WebSocketSession> users;//這個會出現效能問題，最好用Map來儲存，key用userid
    private static Logger logger = Logger.getLogger(SpringWebSocketHandler.class);
    static {
        users = new ArrayList<WebSocketSession>();
    }

    public SpringWebSocketHandler() {
        // TODO Auto-generated constructor stub
    }

    /**
     * 連線成功時候，會觸發頁面上onopen方法
     */
    public void afterConnectionEstablished(WebSocketSession session) throws Exception {
        // TODO Auto-generated method stub
        System.out.println("connect to the websocket success......當前數量:"+users.size());
        users.add(session);
        //這塊會實現自己業務，比如，當用戶登入後，會把離線訊息推送給使用者
//        TextMessage returnMessage = new TextMessage("你將收到的離線");
//        session.sendMessage(returnMessage);
    }

    /**
     * 關閉連線時觸發
     */
    public void afterConnectionClosed(WebSocketSession session, CloseStatus closeStatus) throws Exception {
        logger.debug("websocket connection closed......");
        String username= (String) session.getAttributes().get("WEBSOCKET_USERNAME");
        System.out.println("使用者"+username+"已退出！");
        users.remove(session);
        System.out.println("剩餘線上使用者"+users.size());
    }

    /**
     * js呼叫websocket.send時候，會呼叫該方法
     */
    @Override    
    protected void handleTextMessage(WebSocketSession session, TextMessage message) throws Exception {
        super.handleTextMessage(session, message);
        logger.debug("message:"+message.getPayload().toString());
        TextMessage returnMessage = new TextMessage(message.getPayload().toString());
        //session.sendMessage(returnMessage);
        //sendMessageToUser("123",returnMessage);
        sendMessageToUsers(returnMessage);
    }

    public void handleTransportError(WebSocketSession session, Throwable exception) throws Exception {
        if(session.isOpen()){session.close();}
        logger.debug("websocket connection closed......");
        users.remove(session);
    }

    public boolean supportsPartialMessages() {
        return false;
    }

    /**
     * 給某個使用者傳送訊息
     *
     * @param userName
     * @param message
     */
    public void sendMessageToUser(String userName, TextMessage message) {
        for (WebSocketSession user : users) {
            if (user.getAttributes().get("WEBSOCKET_USERNAME").equals(userName)) {
                try {
                    if (user.isOpen()) {
                        user.sendMessage(message);
                    }
                } catch (IOException e) {
                    e.printStackTrace();
                }
                break;
            }
        }
    }

    /**
     * 給所有線上使用者傳送訊息
     *
     * @param message
     */
    public void sendMessageToUsers(TextMessage message) {
        for (WebSocketSession user : users) {
            try {
                if (user.isOpen()) {
                    user.sendMessage(message);
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }   
}

第四步：攔截器配置
從WebSocketConfig中可以看到在註冊WebSocket通道時，不僅設定了入口地址，還配置了攔截器，攔截器可以實現握手之前和之後的邏輯操作，這裡配置的攔截器主要用於儲存使用者名稱以便於在Handler中定向傳送訊息。

public class SpringWebSocketHandlerInterceptor extends HttpSessionHandshakeInterceptor {

    @Override
    public boolean beforeHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,
            Map<String, Object> attributes) throws Exception {
        // TODO Auto-generated method stub
        System.out.println("Before Handshake");
        if (request instanceof ServletServerHttpRequest) {
            ServletServerHttpRequest servletRequest = (ServletServerHttpRequest) request;
            HttpSession session = servletRequest.getServletRequest().getSession(false);
            if (session != null) {
                //使用userName區分WebSocketHandler，以便定向傳送訊息
                String userName = (String) session.getAttribute("SESSION_USERNAME");
                if (userName==null) {
                    userName="default-system";
                }
                attributes.put("WEBSOCKET_USERNAME",userName);
            }
        }
        return super.beforeHandshake(request, response, wsHandler, attributes);

    }

    @Override
    public void afterHandshake(ServerHttpRequest request, ServerHttpResponse response, WebSocketHandler wsHandler,
            Exception ex) {
        super.afterHandshake(request, response, wsHandler, ex);
    }
}

第五步：配置Websocket連線前臺頁面
網頁端連線Websocket和推送訊息的介面就是這裡

<%@ page language="java" contentType="text/html; charset=utf-8"
    pageEncoding="utf-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Insert title here</title>
</head>
<body>
<script type="text/javascript" src="http://cdn.bootcss.com/jquery/3.1.0/jquery.min.js"></script>
<script type="text/javascript" src="http://cdn.bootcss.com/sockjs-client/1.1.1/sockjs.js"></script>

<script type="text/javascript">

    var msgDiv = document.getElementById("#msgDiv");
    var websocket = null;
    if ('WebSocket' in window) {
        websocket = new WebSocket("ws://localhost:8080/bank_pm/websocket/socketServer.do");
    }
    else if ('MozWebSocket' in window) {
        websocket = new MozWebSocket("ws://localhost:8080/bank_pm/websocket/socketServer.do");
    } 
    else {
        websocket = new SockJS("http://localhost:8080/bank_pm/sockjs/socketServer.do");
    }
    websocket.onopen = onOpen;      
    websocket.onmessage = onMessage;
    websocket.onerror = onError;
    websocket.onclose = onClose;

    function onOpen(openEvt) {
        //alert(openEvt.Data+"onOpen");
    }

    function onMessage(evt) {
        alert(evt.data+"onMessage");
    }
    function onError() {
        alert("出錯"+"onError");
    }
    function onClose() {
        alert("關閉"+"onClose");
    }

    function doSend() {
        if (websocket.readyState == websocket.OPEN) {          
            var msg = document.getElementById("inputMsg").value;  
            websocket.send(msg); //呼叫後臺handleTextMessage方法
            alert("傳送成功!");
        } else {  
            alert("連線失敗!");  
        }  
    }
    window.close=function(){
        websocket.onclose();
    }
</script>
<body align="center">
    <h3>訊息推送</h3>
    請輸入：<textarea rows="8" cols="50" id="inputMsg" name="inputMsg"></textarea>
    <button onclick="doSend();">傳送</button>
    <hr/>
    <textarea rows="10" cols="70" id="msgDiv"></textarea>
</body>
</html>

第六步：登入介面與登入的Controller配置
因為我們傳送訊息是需要傳送給登入使用者的，所以在這裡補充登入的相關程式碼：
（1）登入頁面，地址可自己換成自己的：

<%@ page language="java" contentType="text/html; charset=utf-8"
    pageEncoding="utf-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>

<body align="center">
    <h2>銀行績效管理系統</h2>
    <form action="${pageContext.request.contextPath}/login.action" method="post">
        登入名:<input type="text" name="username"/><br/>
        密碼 : <input type="text" name="password"/><br/>
        <input type="submit" id="login_btn_id" value="登入"/>
    </form>    
</body>
</html>

（2）登入的Controller編寫：主要是在登入是用HttpSession儲存了使用者名稱，為攔截器獲取使用者名稱做了準備。

@ResponseBody
    @RequestMapping(value="/login.action",method={RequestMethod.POST,RequestMethod.GET})
    public User checkUserAndPassword(
    @RequestParam(value="username",required=true) String username,
    @RequestParam(value="password",required=true) String password,User user,HttpServletRequest request) throws Exception{
        User u = new User();
        //登入成功
        if((u = userService.checkUsernameAndPassword(user)) != null){
            HttpSession session = request.getSession(true);
            session.setAttribute("SESSION_USERNAME", user.getUsername());
            return u;
        };
        //登入失敗，返回Null
        return null;
    }

另：web.xml中的servlet和filter中新增非同步支援

<async-supported>true</async-supported>

Android端

現在，伺服器端通過前臺介面websocket.jsp可以傳送和接收訊息了，那麼Android端是如何接收和傳送訊息的呢？同樣，Android端的處理方法也是用到了WebSocket。
第一步：Android專案中匯入JavaWebSocket_fat.jar包，放到專案的libs目錄下，記得新增檔案依賴哦。

編寫ManActivity測試程式碼
實現思路：在導好包後，在MainActivity中使用WebSocketClient這個類來進行Websocket網路通訊，詳細解釋見程式碼。點選andorid介面上的TextView實現網路連線，在網頁上推送訊息，介面上就會以Toast形式彈出傳送過來的訊息。
MainActivity：

public class MainActivity extends AppCompatActivity {

    private WebSocketClient mWebSocketClient;
    //注意更改成為你的伺服器地址，格式："ws://ip:port/專案名字/websocket入口地址
    private String address = "ws://192.168.1.115:8080/bank_pm/websocket/socketServer.do";
    private TextView tv;
    private Handler handler = new Handler(){
        public void handleMessage(Message msg){
            if(msg.what == 0x111){
                String news = "";
                news = msg.getData().getString("news");
                Toast.makeText(MainActivity.this, "收到訊息:"+news, Toast.LENGTH_SHORT).show();
            }
        }
    };
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        tv = (TextView) findViewById(R.id.tv);
        tv.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View v) {
                try {
                    initSocketClient();
                    mWebSocketClient.connect();
                } catch (URISyntaxException e) {
                    e.printStackTrace();
                }
            }
        });

    }

    private void initSocketClient() throws URISyntaxException {
        if(mWebSocketClient == null) {
            mWebSocketClient = new WebSocketClient(new URI(address)) {
                @Override
                public void onOpen(ServerHandshake serverHandshake) {
                    //連線成功
                    Log.i("LOG","opened connection");
                }
‘
                @Override
                public void onMessage(String s) {
                    //服務端訊息來了
                    Log.i("LOG","received:" + s);
                    Message msg = Message.obtain();
                    msg.what = 0x111;
                    Bundle bundle = new Bundle();
                    bundle.putString("news",s);
                    msg.setData(bundle);
                    handler.sendMessage(msg);
                }

                @Override
                public void onClose(int i, String s, boolean remote) {
                    //連線斷開，remote判定是客戶端斷開還是服務端斷開
                    Log.i("LOG","Connection closed by " + ( remote ? "remote peer" : "us" ) + ", info=" + s);
                    //
                    closeConnect();
                }

                @Override
                public void onError(Exception e) {
                    Log.i("LOG","error:" + e);
                }
            };
        }
    }

    //斷開連線
    private void closeConnect() {
        try {
            mWebSocketClient.close();
        }
        catch(Exception e) {
            e.printStackTrace();
        }
        finally {
            mWebSocketClient = null;
        }
    }
    //向伺服器傳送訊息的方法
    private void sendMsg(String msg) {
        mWebSocketClient.send(msg);
    }
}

注意：websocket的網路連線自己已經是用了執行緒的，所以不用我們再去寫執行緒操作了。android專案記得新增網路許可權。

PS：OK，終於初步實現了這個東西，以後還是要多擠出時間寫部落格，向大牛邁進！

相關推薦

Spring+Websocket實現伺服器與Andoird端通訊

本部落格伺服器端內容參考於部落格：http://www.cnblogs.com/3dianpomian/p/5902084.html。 寫這篇部落格的原因是在網上查閱了很多資料，關於websocket的介紹和程式碼很多，但是很少有統一給出伺服器端和Andori

Vue+Java servlet 通過websocket實現伺服器與客戶端雙向通訊

1. vue程式碼 methods: { //在方法裡呼叫 this.websocketsend()傳送資料給伺服器 onConfirm () { //需要傳輸的資料 let data = { cod

JAVA整合WebSocket,實現伺服器與客戶端握手

                                      WebSocket實現伺服器與客戶端握手 自學的WebSocket途中遇到很多坑，希望需要使用的朋友可以少走彎路， 使用的環境:tomcat7.0,mysql,springMvc,spring,M

socket程式設計（一），實現伺服器與客戶端簡單通訊

本節主講客戶端向服務傳送資訊，伺服器轉發給客戶端，當然也可以稍微改一下程式碼可以實現互傳訊息，不再贅述。 難點在於伺服器端的程式碼思路： （1）主程式Socket socket=server.acc

二、Netty實現伺服器與客戶端完整互動連線實戰

        本節內容是程式碼實現伺服器與客戶端完整連線過程。整體把控netty的工作流程。我們先不要被某個類，某個api的封裝深入挖掘，這樣你會踩很多坑，陷入進去而拔不出來，後面我會一一講解，原始碼剖析工作原理。這就是我個人學習技術的一種方法，深入淺出

【隨堂筆記】unity開發中Socket的用法（一，實現伺服器與客戶端簡單的連結）

實現了簡單的連結，也增加了客戶端沒有連結到伺服器的自動重連 伺服器程式碼 using System; using System.Net; using System.Net.Sockets; namespace SeverSocket { class Program

socket網路程式設計中伺服器與客戶端通訊失敗的問題

伺服器程式碼如下 public class server { public static void main(String[] args) throws IOException { ServerSocket server=new S

ssm中spring websocket 實現伺服器推送訊息 以及 一對一聊天

上網看了很多方式，最後覺得這種方式比較簡單易懂，這邊主要有三個類（包括註解的配置檔案）就可以實現後臺內容文末會展示結果例項，如果是你所需要的效果，直接拿去用吧~專案中複製直接用本文根據網上整理並修改！！！本文思路來自：連結現在開始。開始前請確保pom已經引入需要的包首先是配置

Qt實現伺服器與客戶端傳輸文字和圖片（Qt②）

初學者記錄學習內容，如有錯誤請各位前輩指點。 此次工程完成過程借鑑了下面得兩個帖子，附上鍊接，並致以感謝： qt 寫的tcp客戶端程式實現簡單的連線接受和傳送訊息 qt寫的一個簡單的tcp伺服器程式，可以接受訊息傳送資料 好了閒話少說進入正題。 瞭解C

C# Socket簡單例子（伺服器與客戶端通訊）

這個例子只是簡單實現瞭如何使用 Socket 類實現面向連線的通訊。注意：此例子的目的只是為了說明用套接字寫程式的大概思路，而不是實際專案中的使用程式。在這個例子中，實際上還有很多問題沒有解決，如訊息邊界問題、埠號是否被佔用、訊息命令的解析問題等。。下面是兩個程式的程式碼，（

一個基於TCP/IP的伺服器與客戶端通訊的小專案（超詳細版）

1.目的：實現客戶端向伺服器傳送資料   原理： 2.建立兩個控制檯應用，一個為伺服器，用於接收資料。一個為客戶端，用於傳送資料。   關鍵類與對應方法：   1）類IPEndPoint：   1.是抽象類EndPoint的實現類   2.So

TCP實現伺服器端與客戶端通訊

TCP實現伺服器端接收客戶端傳送過來的訊息。 伺服器端： import java.io.IOException; import java.io.InputStream; import java.net.ServerSocket; import java.net.Socket; p

C#.網路程式設計 Socket基礎（一）Socket TCP協議 實現端到端（伺服器與客戶端）簡單字串通訊

簡介：        本章節主要討論了Socket的入門知識，還未針對Socket的難點問題（比如TCP的無訊息邊界問題）展開討論，往後在其他章節中進行研究。 注意點： 伺服器（比如臺式電腦）的IP為1.1.1.2，那麼客戶端（其他裝置，比如手機，Ipad）連線的一定是

LINUX下socket實現伺服器與多客戶端通訊（一）

一直對網路方面的技術比較感興趣，有時間就學習學習。雖然現在很多高階語言都已將網路程式設計部分做了封裝處理，使之使用更加方便，但是學習基礎原理，還是一個程式設計師必須要做的。 linux下的socket程式設計原理，網路上已經有大把的詳細說明，這裡不做說明，程式碼中已有簡單註釋。 具體方法，有

Java實現簡單的Socket伺服器與客戶端字串通訊（適合初學者閱讀）

       近段時間，頻繁看到很多學生做畢業設計用到了Socket通訊技術，問題非常多，特寫一個小例子，希望對馬上畢業的同學有所幫助。如果希望學習的更加深入，需要掌握的知識有：面向物件、多執行緒、Socket通訊、IO流、異常處理 伺服器端程式碼： import java

多執行緒實現伺服器與多個客戶端通訊,客戶端之間相互不干擾

1,服務端建立ServerSocket繫結埠號，迴圈呼叫accept()方法 2,客戶端建立一個socket並請求和伺服器端連線 3,伺服器端接受客戶端請求，建立socket與該客戶建立連線 4,兩個socket在一個單獨的執行緒上通話 5,伺服器端繼續等待新的連線

spring websocket實現前後端通訊

  專案要用websocket實現一個前後端實時通訊的功能，做完之後感觸頗多，寫個部落格回顧下整個歷程，也希望能給後面的同志有點幫助。百度網盤示例原始碼：連結：https://pan.baidu.com/s/1Gi3qRyLO-lTnkVn4MqGIJA 密碼：4ovr我使用

四、Netty實現webSocket，實現伺服器與瀏覽器（HTML）線上聊天功能

        由於http協議有一個缺陷：通訊只能由客戶端發起。如果伺服器有連續的狀態變化，客戶端要獲知只能使用"輪詢"：每隔一段時候，就發出一個詢問，瞭解伺服器有沒有新的資訊。輪詢的效率低，非常浪費資源（因為必須不停連線，或者 HTTP 連線始終開啟）

C#Socket通訊基礎（非同步Socket通訊TCP）伺服器與客戶端

一、效果圖 二、伺服器端程式碼（原始碼下載地址：https://download.csdn.net/download/xiaochenxihua/10748789） using System; using System.Collections.Generic; using System

C++ 簡單的 Tcp 實現 socket 客戶端與客戶端通訊

分享一下我老師大神的人工智慧教程！零基礎，通俗易懂！http://blog.csdn.net/jiangjunshow 也歡迎大家轉載本篇文章。分享知識，造福人民，實現我們中華民族偉大復興！