- 目錄
- 序言
- 準(zhǔn)備工作
- 如何導(dǎo)入socket-io-java 框架
- socket-io的基本用法.
- 打印socket-io中的log信息
- socket-io源碼解析
- connect()里的都干了什么.
- 關(guān)于websocket的一些技術(shù)文檔和文章
序言
WebSocket 協(xié)議是伴隨HTML5發(fā)布的一種新協(xié)議,它實現(xiàn)了服務(wù)端到客戶端瀏覽器之間的全雙工通信.WebSocket常使用于IM通信等場景.當(dāng)然由于其全雙工的特性,也同樣適用于直播彈幕這種場景.
WebSocket 大概有以下特點(diǎn):
- 基于socket實現(xiàn)保證了消息通信的實時性.
- 提供文本和二進(jìn)制數(shù)據(jù)兩種格式的數(shù)據(jù)傳輸.
- 在建立連接時使用http協(xié)議,連接過程中使用ws/wss協(xié)議通信.ws占用http請求的80端口,wss占用https請求的443端口.建立連接后,websocket沒有規(guī)定具體協(xié)議,需要使用者自行進(jìn)行擴(kuò)展.
如何導(dǎo)入 socket-io-java框架
WebSocket協(xié)議是伴隨Html5協(xié)議發(fā)布的,最初它應(yīng)該是為瀏覽器程序與web服務(wù)器間通信而設(shè)計的一種協(xié)議.socket-io-java是 socket.io 在java平臺的客戶端實現(xiàn),而服務(wù)端實現(xiàn)則有配套的 socket-io-netty新症。
Eclipse下導(dǎo)入 socket-io jar
Android Studio 環(huán)境下導(dǎo)入socket-io 非常輕松方便,只需要在gradle文件中添加依賴,直接參閱 socket-io 的官方文檔即可.
而某些同學(xué)和我一樣,因為種種原因在eclipse下開發(fā),就需要導(dǎo)入jar包了.
這里總結(jié)下我在導(dǎo)入jar包時遇到的坑:
- 除了 socket-io-client 這個jar包之外,我們還需要導(dǎo)入一個 engine-io-socket 的包. client包中主要包含了客戶端操作websocket的api,而engine包中包含了socket-io的核心實現(xiàn).
- Socket-io庫中的網(wǎng)絡(luò)實現(xiàn)使用OkHttp實現(xiàn).如果你的項目之前沒有使用 OkHttp,那么你還需要額外導(dǎo)入 OkHttp相關(guān)的jar包.需要注意的是 okhttp-ws 這個jar包,我在maven上找到的最高版本是3.4.1.而它需要配合3.4.1版本的okhttp使用.在高版本的okhttp jar包中(例如3.8版本),是默認(rèn)包括了對WebSocket的支持的,但由于我使用的是 0.8.2版本的 socket-io-java礁凡，導(dǎo)致與3.8版本的okhttp不兼容.所以在導(dǎo)入jar包時需要注意版本的問題.
socke-io的基本用法
socket = IO.socket("http://localhost");
socket.on(Socket.EVENT_CONNECT, new Emitter.Listener() {
@Override
public void call(Object... args) {
socket.emit("foo", "hi");
socket.disconnect();
}
}).on("event", new Emitter.Listener() {
@Override
public void call(Object... args) {}
}).on(Socket.EVENT_DISCONNECT, new Emitter.Listener() {
@Override
public void call(Object... args) {}
});
socket.connect();
官方文檔中已經(jīng)給出 socket-io的基本用法了. socket-io的api非常的簡潔,基本只需要初始,化注冊回調(diào),連接 三步就搞定了.
打印socket-io中的log信息
socket-io對外暴露的api實在太少了,不像 rxjava 等一些框架海量的函數(shù),所以用起來非常方便簡單.但是同樣也造成一個問題盈滴，框架的封裝程度越高欲账，我們就越難獲取到框架中流程的信息.而 socket-io 這個框架連基本的日志信息都隱藏掉了,如果想要詳細(xì)了解內(nèi)部信息五鲫，這樣是很不利的:
public Manager open(final OpenCallback fn) {
EventThread.exec(new Runnable() {
@Override
public void run() {
if (logger.isLoggable(Level.FINE)) {
logger.fine(String.format("readyState %s", Manager.this.readyState));
}
可以看到框架中的日志使用的是java里的logger這個類來打印基本日志,但是這些日志級別太低,java中默認(rèn)打印debug以上級別的日志.
獲取的日志的思路就是要改變logger的日志級別,準(zhǔn)確的說是日志的輸出級別.
java中l(wèi)ogger輸出的日志級別由兩個因素決定:一個是logger中通過 setLevel() 函數(shù)設(shè)定的日志打印級別,用來決定日志中哪些日志會被輸出到輸出流中.還有一個就是Handler中設(shè)定的日志輸出級別,logger負(fù)責(zé)輸出日志到具體的某個Handler中溺职，例如 FiledHandler,ConsoleHandler,handler中設(shè)定的level決定哪些日志是最終會輸出到文件或者console中.
private void changeLoggerLevel() {
// init a new logger with level FINE
Logger logger = Logger.getLogger(Socket.class.getName());
logger.setLevel(Level.FINE);
Handler consoleHandler = new ConsoleHandler();
consoleHandler.setLevel(Level.ALL);
logger.addHandler(consoleHandler);
ArrayList<String> loggerName = new ArrayList<String>();
int i = IO.protocol;
String j = Socket.EVENT_CONNECT;
String k = Manager.EVENT_CLOSE;
try {
Manager manager = Manager.class.newInstance();
WebSocket webSocket = new WebSocket(new Options());
EventThread.exec(new Runnable() {
@Override
public void run() {
}
});
PollingXHR pollingXHR = new PollingXHR(
new io.socket.engineio.client.Transport.Options());
io.socket.engineio.client.Socket socket = new io.socket.engineio.client.Socket();
} catch (InstantiationException e) {
e.printStackTrace();
} catch (IllegalAccessException e) {
e.printStackTrace();
}
String m = PollingXHR.EVENT_REQUEST_HEADERS;
String n = WebSocket.EVENT_DRAIN;
loggerName.add(IO.class.getName());
loggerName.add(Socket.class.getName());
loggerName.add(Manager.class.getName());
loggerName.add(PollingXHR.class.getName());
loggerName.add(WebSocket.class.getName());
loggerName.add(io.socket.engineio.client.Socket.class.getName());
loggerName.add(Parser.class.getName());
for (String tag : loggerName) {
Logger temp = LogManager.getLogManager().getLogger(tag);
if (temp != null) {
temp.setLevel(Level.ALL);
temp.addHandler(consoleHandler);
} else {
LogUtil.debugLog(LEVEL.ERROR, TAG, temp + "=null", true);
}
}
}
清楚了原理，我們就可以來動手寫具體的代碼了:通過反射獲取你需要日志信息的類中l(wèi)ogger的實例,使用setLevel()函數(shù)將日志過濾等級調(diào)整為FINE級別以下位喂，然后再為其添加相同等級的ConsoleHandler對象,在 logcat 中查看TAG為system.err()的日志,就能查看到socket-io框架內(nèi)部輸出的信息了.如果沒有修改logger中handler的級別,即使修改logger的全局打印級別也是沒用的.
打印出來的信息大概就是這樣的浪耘，其中有非常詳細(xì)的建立連接,升級協(xié)議，發(fā)送和接受message等等信息,通過這些信息結(jié)合源代碼可以對整個流程進(jìn)行研究.
socket-io源碼的一點(diǎn)解析
socket-io的整個流程并不復(fù)雜塑崖。首先客戶端會發(fā)送http請求來與服務(wù)端建立連接,接著發(fā)送一個http請求請求升級為 ws協(xié)議七冲，如果服務(wù)端返回101就是表示切換協(xié)議成功,此時客戶端就與服務(wù)端建立了socket長連接,而后客戶端與服務(wù)端會不停地發(fā)送 ping包和 pong包來確認(rèn)連接沒有斷開.
connect()函數(shù)里都干了什么.
/**
* Connects the socket.
*/
public Socket open() {
EventThread.exec(new Runnable() {
@Override
public void run() {
if (Socket.this.connected) return;
Socket.this.subEvents();
Socket.this.io.open(); // ensure open
if (Manager.ReadyState.OPEN == Socket.this.io.readyState) Socket.this.onopen();
Socket.this.emit(EVENT_CONNECTING);
}
});
return this;
}
調(diào)用 socket-io的 connect()函數(shù)會直接轉(zhuǎn)入 open()函數(shù).這里首先會調(diào)用subEvents()函數(shù)為 Manager對象添加回調(diào)監(jiān)聽 EVENT_OPEN,EVENT_PACKET,EVENT_CLOSE這三個事件.
final Manager io = Socket.this.io;
Socket.this.subs = new LinkedList<On.Handle>() {{
add(On.on(io, Manager.EVENT_OPEN, new Listener() {
@Override
public void call(Object... args) {
Socket.this.onopen();
}
}));
add(On.on(io, Manager.EVENT_PACKET, new Listener() {
@Override
public void call(Object... args) {
Socket.this.onpacket((Packet<?>) args[0]);
}
}));
add(On.on(io, Manager.EVENT_CLOSE, new Listener() {
@Override
public void call(Object... args) {
Socket.this.onclose(args.length > 0 ? (String) args[0] : null);
}
}));
接著會調(diào)用 Manager中的open()函數(shù),接著會調(diào)用到 engine.io.Socket中的 open 函數(shù).
Manager.this.engine.open();
在open()函數(shù)中會判斷是否發(fā)起 WebSocket 連接.最后調(diào)用transport.open()向服務(wù)器發(fā)起連接.
if (Socket.this.rememberUpgrade && Socket.priorWebsocketSuccess && Socket.this.transports.contains(WebSocket.NAME)) {
transportName = WebSocket.NAME;
}
.....
transport.open();
具體的連接細(xì)節(jié)比較繁瑣，暫不展開规婆，后面再補(bǔ)充.
關(guān)于websocket的一些技術(shù)文檔和文章
socket-io的github地址: https://github.com/socketio/socket.io-client-java
engine-io的github地址: https://github.com/socketio/engine.io-client-java
騰訊bugly的文章: http://blog.csdn.net/tencent_bugly/article/details/60580396
一篇介紹okhttp實現(xiàn)websocket的文章: http://blog.csdn.net/sbsujjbcy/article/details/52839540
