【Android WebSocket】Android 端 WebSocket 基本用法 ( 添加依赖和权限 | 创建 WebSocketClient 客户端类 | 建立连接并发送消息 )

使用 https://github.com/TooTallNate/Java-WebSocket 框架 ;

一、添加依赖和权限

---

在 build.gradle 构建脚本中 , 添加依赖 :

implementation 'org.java-websocket:Java-WebSocket:1.5.2'

在 AndroidManifest.xml 清单文件中 , 添加网络权限 :

<uses-permission android:name="android.permission.INTERNET" />

二、创建 WebSocketClient 客户端类

---

创建 org.java_websocket.client.WebSocketClient 子类 ;

package kim.hsl.websocketdemo

import android.util.Log
import org.java_websocket.client.WebSocketClient
import org.java_websocket.handshake.ServerHandshake
import java.lang.Exception
import java.net.URI

open class MyWebSocketClient(serverUri: URI?) : WebSocketClient(serverUri) {

    val TAG = "MyWebSocketClient"

    override fun onOpen(handshakedata: ServerHandshake?) {
        Log.i(TAG, "onOpen handshakedata=$handshakedata")
    }

    override fun onMessage(message: String?) {
        Log.i(TAG, "onMessage message=$message")
    }

    override fun onClose(code: Int, reason: String?, remote: Boolean) {
        Log.i(TAG, "onClose code=$code reason=$reason remote=$remote")
    }

    override fun onError(ex: Exception?) {
        Log.i(TAG, "onError ex=$ex")
    }
}

三、建立连接并发送消息

---

创建 客户端 对象 : 设置 WebSocket 地址 , 使用匿名内部类的方式实现 , 主要是为了在本类中获取 onMessage 方法中接收的来自服务器端的消息 ;

var uri: URI? = URI.create("ws://***自己实现服务器端***")
var client: MyWebSocketClient = object : MyWebSocketClient(uri){
    override fun onMessage(message: String?) {
        super.onMessage(message)
    }
}

连接服务器 : 调用 org.java_websocket.client.WebSocketClient 的 connectBlocking() 函数 , 即可连接远程服务器并阻塞该线程 , 服务器连接成功后 , 会回调该类的 onOpen 方法 , 并解除阻塞 ;

client.connectBlocking()

向服务器发送数据 : 调用 org.java_websocket.client.WebSocketClient 的 send() 函数 , 即可向远程服务器发送消息 , 回送的消息在 onMessage 回调方法中的 message: String? 参数可以获取到 ;

client.send("**自定义消息**")

完整代码如下 :

package kim.hsl.websocketdemo

import androidx.appcompat.app.AppCompatActivity
import android.os.Bundle
import java.net.URI

class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

		// 服务器端 WebSocket 地址
        var uri: URI? = URI.create("ws://***自己实现服务器端***")

		// 创建客户端对象
        var client: MyWebSocketClient = object : MyWebSocketClient(uri){
            override fun onMessage(message: String?) {
                super.onMessage(message)
            }
        }

		// 连接远程服务器
        client.connectBlocking()
			
		// 发送消息
        client.send("**自定义消息**")
    }
}

执行结果如下 :