Java-WebSocket框架
GitHub地址:https://github.com/TooTallNate/Java-WebSocket
目前已經有五千以上star,並且還在更新維護中,所以本文將介紹如何利用此開源庫實現一個穩定的即時通訊功能
一、引入Java-WebSocket
1、build.gradle中加入
implementation "org.java-websocket:Java-WebSocket:1.4.0"
2、加入網絡請求權限
<uses-permission android:name="android.permission.INTERNET" />
3、新建客戶端類
新建一個客戶端類並繼承WebSocketClient,需要實現它的四個抽象方法和構造函數,如下:
public class JWebSocketClient extends WebSocketClient { public JWebSocketClient(URI serverUri) { super(serverUri, new Draft_6455()); } @Override public void onOpen(ServerHandshake handshakedata) { Log.e("JWebSocketClient", "onOpen()"); } @Override public void onMessage(String message) { Log.e("JWebSocketClient", "onMessage()"); } @Override public void onClose(int code, String reason, boolean remote) { Log.e("JWebSocketClient", "onClose()"); } @Override public void onError(Exception ex) { Log.e("JWebSocketClient", "onError()"); } }
其中onOpen()方法在websocket連接開啟時調用,onMessage()方法在接收到消息時調用,onClose()方法在連接斷開時調用,onError()方法在連接出錯時調用。構造方法中的new Draft_6455()代表使用的協議版本,這里可以不寫或者寫成這樣即可。
4、建立websocket連接
建立連接只需要初始化此客戶端再調用連接方法,需要注意的是WebSocketClient對象是不能重復使用的,所以不能重復初始化,其他地方只能調用當前這個Client。
URI uri = URI.create("ws://*******"); JWebSocketClient client = new JWebSocketClient(uri) { @Override public void onMessage(String message) { //message就是接收到的消息 Log.e("JWebSClientService", message); } };
為了方便對接收到的消息進行處理,可以在這重寫onMessage()方法。初始化客戶端時需要傳入websocket地址(測試地址:
ws://echo.websocket.org),websocket協議地址大致是這樣的
ws:// ip地址 : 端口號
連接時可以使用connect()方法或connectBlocking()方法,建議使用connectBlocking()方法,connectBlocking多出一個等待操作,會先連接再發送
try { client.connectBlocking(); } catch (InterruptedException e) { e.printStackTrace(); }
運行之后可以看到客戶端的onOpen()方法得到了執行,表示已經和websocket建立了連接
5、發送消息發送消息只需要調用send()方法,如下
if (client != null && client.isOpen()) { client.send("你好"); }
6、關閉socket連接
關閉連接調用close()方法,最后為了避免重復實例化WebSocketClient對象,關閉時一定要將對象置空。
/** * 斷開連接 */ private void closeConnect() { try { if (null != client) { client.close(); } } catch (Exception e) { e.printStackTrace(); } finally { client = null; } }