Android中使用WebSocket

Android WebSocket 实现长连接及心跳检测与断线重连
本文详细介绍了在Android环境中如何使用Java-WebSocket库建立WebSocket长连接,包括心跳检测机制以保持连接活跃,以及断线后自动重连的实现方法。示例代码展示了连接建立、消息收发、关闭连接和异常处理的过程,并提供了心跳检测的实现。

参考网址:Android WebSocket 建立一个长连接(带心跳检测)Activity页面可接发信息_mr_lichao的博客-优快云博客_android websocket 心跳
Android中使用WebSocket_Huang兄-优快云博客_android websocket

//导包:implementation "org.java-websocket:Java-WebSocket:1.4.0"
private WebSocketClient webSocketClient;
    private void webSocket(){
        //https://blog.youkuaiyun.com/huangyuan_xuan/article/details/109325021
        //https://www.jianshu.com/p/ee5bdb999df6
        new Thread(){
            @Override
            public void run() {
                super.run();
                try{
                    URI serverURI = URI.create("ws://192.168.1.1:8080?");
                    webSocketClient = new WebSocketClient(serverURI) {
                        //打开连接
                        @Override
                        public void onOpen(ServerHandshake handshakedata) {
                            System.out.println("onOpen:服务器状态:"+handshakedata.getHttpStatusMessage());
                        }
                        //服务端返回消息
                        @Override
                        public void onMessage(String message) {
                            System.out.println("onMessage:"+message); //得到返回的数据
                        }
                        //关闭连接
                        @Override
                        public void onClose(int code, String reason, boolean remote) {
                            System.out.println("onClose:"+code+reason+remote);
                        }
                        //出现异常
                        @Override
                        public void onError(Exception ex) {
                            System.out.println("onError:"+ex.fillInStackTrace());
                        }
                    };
                    webSocketClient.connectBlocking();
                    mHandler.postDelayed(heartBeatRunnable, HEART_BEAT_RATE);//开启心跳检测
                }catch (Exception e){
                    System.out.println("webSocket:"+e.fillInStackTrace());
                }
            }
        }.start();
    }
    //******websocket心跳检测********
    private String heartbeat = "123";//心跳
    private static final long HEART_BEAT_RATE = 10 * 1000;//每隔10秒进行一次对长连接的心跳检测
    private Handler mHandler = new Handler();
    private Runnable heartBeatRunnable = new Runnable() {
        @Override
        public void run() {
            System.out.println("心跳包检测websocket连接状态");
            if (webSocketClient != null) {
                if (webSocketClient.isClosed()) {
                    reconnectWs();
                }else {
                    //业务逻辑 这里如果服务端需要心跳包为了防止断开 需要不断发送消息给服务端
                    webSocketClient.send(heartbeat);
                    System.out.println("客户端发送消息:"+heartbeat);
                }
            } else {
                //如果client已为空,重新初始化连接
                webSocketClient = null;
                webSocket();
            }
            //每隔一定的时间,对长连接进行一次心跳检测
            mHandler.postDelayed(this, HEART_BEAT_RATE);
        }
    };
    //开启重连
    private void reconnectWs() {
        mHandler.removeCallbacks(heartBeatRunnable);
        new Thread() {
            @Override
            public void run() {
                try {
                    //connectBlocking多出一个等待操作,会先连接再发送,否则未连接发送会报错
                    webSocketClient.reconnectBlocking();
                } catch (Exception e) {
                    System.out.println("reconnectWs:"+e.fillInStackTrace());
                }
            }
        }.start();
    }
	@Override
    protected void onDestroy() {
        super.onDestroy();
        mHandler.removeCallbacks(heartBeatRunnable);
        if (webSocketClient!=null){
            webSocketClient.close();
            webSocketClient = null;
        }
    }

包含断线重连工具类

package com.service;

import org.java_websocket.client.WebSocketClient;
import org.java_websocket.enums.ReadyState;
import org.java_websocket.handshake.ServerHandshake;
import java.net.URI;

public class MyWebSocket {
    private WebSocketClient webSocketClient;
    private String data;
    private boolean bl = false;
    private boolean bl2 = false;
    public MyWebSocket(String data) {
        this.data = data;
        webSocket(data);
    }
    private void webSocket(String data){
        new Thread(){
            @Override
            public void run() {
                super.run();
                try{
                    URI serverURI = URI.create("ws://"+IP+":"+ 端口);
                    webSocketClient = new WebSocketClient(serverURI) {
                        //打开连接
                        @Override
                        public void onOpen(ServerHandshake handshakedata) {
                            System.out.println("WebSocket:::onOpen:");
                            if (bl2)
                                sendData(data);
                        }
                        //服务端返回消息
                        @Override
                        public void onMessage(String message) {
                            //System.out.println("WebSocket:::onMessage:"+message);
                            listener.getMessage(message);
                            bl = false;
                        }
                        //关闭连接
                        @Override
                        public void onClose(int code, String reason, boolean remote) {
                            System.out.println("WebSocket:::onClose:"+code);
                            if (!bl){
                                listener.closeWebSocket(code,reason,remote);
                                bl = true;
                            }
                            bl2 = false;
                        }
                        //出现异常
                        @Override
                        public void onError(Exception ex) {
                            String str = ex.fillInStackTrace().toString();
                            System.out.println("WebSocket:::onError:"+str);
                            if (!bl){
                                listener.closeWebSocket(-1,str,false);
                                bl = true;
                            }
                            bl2 = false;
                        }
                    };
                    //webSocketClient.connectBlocking();
                    reConnect();
                    sendData(data);
                }catch (Exception e){
                    System.out.println("WebSocket:::"+e.fillInStackTrace());
                }
            }
        }.start();
        new Thread(){
            @Override
            public void run() {
                super.run();
                while (true){
                    //webSocket连接断开后一直重复尝试连接直到连接成功为止
                    if (webSocketClient != null&&webSocketClient.isClosed()) {
                        reConnect();
                        if (!bl2)
                            bl2 = true;
                    }
                }
            }
        }.start();
    }
    //断线重连方法
    private void reConnect(){
        try{
            if (webSocketClient==null)
                return;
            if (webSocketClient.getReadyState().equals(ReadyState.NOT_YET_CONNECTED)) {
                webSocketClient.connectBlocking();
            } else if (webSocketClient.getReadyState().equals(ReadyState.CLOSING)
                    || webSocketClient.getReadyState().equals(ReadyState.CLOSED)) {
                webSocketClient.reconnectBlocking();
            }
        }catch (Exception e){
            System.out.println("WebSocket:::reConnect:"+e.fillInStackTrace());
        }
    }
    public void sendData(String data){
        //防止WebsocketNotConnectedException
        while (!webSocketClient.getReadyState().equals(ReadyState.OPEN)){
            System.out.equals("WebSocket:::连接断开了");
        }
        if (webSocketClient != null&&!webSocketClient.isClosed()) {
            webSocketClient.send(data);
        }
    }
    public boolean isClosed(){
        if (webSocketClient != null) {
            return webSocketClient.isClosed();
        }
        return false;
    }
    public void closeWebSocket(){
        if (webSocketClient!=null){
            webSocketClient.close();
            webSocketClient = null;
        }
    }

    WebSocketListener listener;
    public void setWebSocket(WebSocketListener listener){
        this.listener = listener;
    }
    public interface WebSocketListener{
        void getMessage(String message);
        void closeWebSocket(int code, String reason, boolean remote);
    }
}

错误码

<think>我们参考了多个关于在Android使用WebSocket的引用,结合这些信息为用户提供实现方法的步骤和关键代码。 步骤如下: 1. 添加依赖:在项目的build.gradle文件中添加WebSocket库的依赖。 2. 创建WebSocket客户端:使用库提供的API创建WebSocket客户端实例。 3. 建立连接并设置监听器:连接到WebSocket服务器,并设置回调以处理连接状态、接收消息等事件。 4. 发送消息:通过建立的连接发送消息。 5. 断开连接:在适当的时候关闭连接。 根据引用,我们注意到以下几点: - 引用[1]提到WebSocket实现了双向通信,是构建响应式应用的有力工具。 - 引用[2]提到在Android的WebView中,如果平台不支持WebSocketSocket.io会使用其他方式(如XHR)实现,但这里我们讨论的是原生WebSocket。 - 引用[3]提到了在客户端中,WebSocket的回调方法不在主线程,更新UI需要切换到主线程;同时也提到了可以使用Service和广播机制来更新UI。 - 引用[4]提到了处理超时和重连的机制。 下面我们分步骤详细说明: ### 步骤1:添加依赖 常用的WebSocket库有`Java-WebSocket`和`OkHttp`。这里以`OkHttp`为例,因为它广泛用于Android网络请求,并且支持WebSocket。 在app模块的`build.gradle`文件中添加依赖: ```groovy dependencies { implementation 'com.squareup.okhttp3:okhttp:4.9.3' // 使用较新版本,注意版本号可能更新 } ``` ### 步骤2:创建WebSocket客户端 使用OkHttp的`OkHttpClient`来创建WebSocket客户端实例。 ```java OkHttpClient client = new OkHttpClient(); ``` ### 步骤3:建立连接并设置监听器 创建一个`Request`对象指定服务器地址,然后通过`newWebSocket`方法建立连接,并传入一个`WebSocketListener`以处理事件。 ```java Request request = new Request.Builder() .url("ws://your_websocket_server_url") // 替换为你的WebSocket服务器地址 .build(); WebSocket webSocket = client.newWebSocket(request, new WebSocketListener() { @Override public void onOpen(WebSocket webSocket, Response response) { // 连接成功 // 可以在这里发送一条初始消息,如果需要 webSocket.send("Hello from Android"); } @Override public void onMessage(WebSocket webSocket, String text) { // 收到文本消息 // 注意:这个方法在后台线程执行,更新UI需要使用Handler或runOnUiThread runOnUiThread(() -> { // 更新UI,例如将消息显示在TextView上 textView.append("Received: " + text + "\n"); }); } @Override public void onClosed(WebSocket webSocket, int code, String reason) { // 连接关闭 } @Override public void onFailure(WebSocket webSocket, Throwable t, Response response) { // 连接失败 t.printStackTrace(); // 可以在这里实现重连逻辑 } }); // 为了避免内存泄漏,在不需要的时候应该取消请求(例如在Activity的onDestroy中) client.dispatcher().executorService().shutdown(); ``` 注意:`runOnUiThread`是Activity的方法,如果在非Activity环境中,可以使用Handler或LiveData等机制更新UI。 ### 步骤4:发送消息 通过`WebSocket`对象的`send`方法发送消息。 ```java webSocket.send("This is a message from Android"); ``` ### 步骤5:断开连接 在适当的时候(如Activity销毁时)关闭连接。 ```java @Override protected void onDestroy() { super.onDestroy(); webSocket.close(1000, "Goodbye!"); // 1000是正常关闭的状态码 } ``` ### 关于重连 引用[4]提到超时重连,可以在`onFailure`回调中实现重连逻辑。注意重连时可能需要设置延迟和次数限制。 ```java @Override public void onFailure(WebSocket webSocket, Throwable t, Response response) { t.printStackTrace(); // 重连逻辑 reconnect(); } private void reconnect() { // 使用Handler延迟重连,避免频繁重连 new Handler(Looper.getMainLooper()).postDelayed(() -> { // 重新创建WebSocket连接 // 注意:这里需要重新执行步骤2和3(创建新的WebSocket连接) }, 5000); // 5秒后重连 } ``` ### 在Service中使用 如果需要在后台维持WebSocket连接,可以在Service中实现上述逻辑,并通过广播或绑定服务的方式与Activity通信。 以上就是在Android使用WebSocket的基本方法。 §§相关问题§§ 1. WebSocket与HTTP长轮询有什么区别? 2. 在Android中如何保证WebSocket连接的安全性(例如使用wss)? 3. 如何实现WebSocket的断线重连机制? 4. 如何在Android后台服务中维持WebSocket连接? </think>以下是Android使用WebSocket的完整实现方法,结合了关键引用信息和代码示例: ### 一、核心实现步骤 1. **添加依赖**(使用OkHttp库) 在`build.gradle`中添加: ```groovy implementation 'com.squareup.okhttp3:okhttp:4.12.0' // 包含WebSocket支持 ``` 2. **创建WebSocket客户端** ```java OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("ws://your_server_address") // 替换为实际地址 .build(); WebSocket webSocket = client.newWebSocket(request, new WebSocketListener() { @Override public void onOpen(WebSocket webSocket, Response response) { // 连接成功回调 webSocket.send("Hello Server!"); // 发送初始消息 } @Override public void onMessage(WebSocket webSocket, String text) { // 接收文本消息(注意:在后台线程执行) runOnUiThread(() -> { textView.append("Received: " + text + "\n"); // 更新UI }); } @Override public void onClosed(WebSocket webSocket, int code, String reason) { // 连接关闭回调 } @Override public void onFailure(WebSocket webSocket, Throwable t, Response response) { // 连接失败处理(需实现重连机制)[^4] reconnect(); // 自定义重连方法 } }); ``` 3. **消息发送** ```java webSocket.send("Message from Android"); // 发送文本 ``` 4. **连接关闭** ```java webSocket.close(1000, "Normal closure"); // 状态码1000表示正常关闭 client.dispatcher().executorService().shutdown(); // 释放资源 ``` ### 二、关键注意事项 1. **线程处理** 所有回调均在后台线程执行,更新UI需切换到主线程: ```java runOnUiThread(() -> { /* 更新UI操作 */ }); // Activity中使用 // 或 new Handler(Looper.getMainLooper()).post(() -> { ... }); // 非Activity环境 ``` 2. **后台服务集成** 建议在`Service`中维护WebSocket连接,通过广播更新UI[^3]: ```java // Service中接收消息后发送广播 Intent intent = new Intent("WEB_SOCKET_MSG"); intent.putExtra("message", receivedMsg); sendBroadcast(intent); ``` 3. **重连机制实现**[^4] ```java private void reconnect() { new Handler().postDelayed(() -> { if (!isConnected) { initWebSocket(); // 重新初始化连接 } }, 5000); // 5秒后重试 } ``` ### 三、备选方案(WebView场景) 若需在WebView中使用WebSocket: 1. 平台会自动降级到XHR长轮询[^2] 2. 使用Socket.IO库: ```javascript // WebView中加载的JS代码 const socket = io("http://your_server"); socket.on("message", (data) => { console.log(data); }); ``` ### 四、安全建议 1. 生产环境使用`wss://`加密协议 2. 添加连接超时控制: ```java OkHttpClient client = new OkHttpClient.Builder() .connectTimeout(15, TimeUnit.SECONDS) .build(); ``` > **引用要点总结**: > - WebSocket实现双向实时通信[^1] > - 回调需处理线程切换问题[^3] > - 必须实现异常重连逻辑[^4] > - WebView中自动降级兼容[^2]
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符  | 博主筛选后可见
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值