点击上方 蓝字 关注我，❤git
今天给你们带来一篇老文章，介绍WebSocket，你们能够了解了解。github
前言
最近老板又来新需求了，要作一个物联网相关的app，其中有个需求是客户端须要收发服务器不按期发出的消息。
心里OS：
🤔 这咋整呢？经过接口轮询？定时访问接口，有数据就更新？
🤔 不行不行，这样浪费资源了，还耗电，会致使不少请求都是无效的网络操做。
🤔 那就长链接呗？WebSocket协议好像不错，经过握手创建长链接后，能够随时收发服务器的消息。那就它了！
🤔 怎么集成呢？正好前段时间复习OkHttp源码的时候发现了它是支持Websocket协议的，那就用它试试吧！web
开淦！面试
WebSocket介绍
先简单介绍下WebSocket。咱们都知道Http是处于应用层的一个通讯协议，可是只支持单向主动通讯，作不到服务器主动向客户端推送消息。并且Http是无状态的，即每次通讯都没有关联性，致使跟服务器关系不紧密。服务器
为了解决和服务器长时间通讯的痛点呢，HTML5规范引出了WebSocket协议（知道这名字咋来的吧，人家HTML5规范引出的，随爸姓），是一种创建在TCP协议基础上的全双工通讯的协议。他跟Http同属于应用层协议，下层仍是须要经过TCP创建链接。微信
可是，WebSocket在TCP链接创建后，还要经过Http进行一次握手，也就是经过Http发送一条GET请求消息给服务器，告诉服务器我要创建WebSocket链接了，你准备好哦，具体作法就是在头部信息中添加相关参数。而后服务器响应我知道了，而且将链接协议改为WebSocket，开始创建长链接。websocket
这里贴上请求头和响应头信息，从网上找了一张图：网络
简单说明下参数：app
-
URL通常是以 ws或者wss开头，ws对应Websocket协议，wss对应在TLS之上的WebSocket。相似于Http和Https的关系。 -
请求方法为GET方法。 -
Connection:Upgrade，表示客户端要链接升级，不用Http协议。 -
Upgrade:websocket， 表示客户端要升级创建Websocket链接。 -
Sec-Websocket-Key:key， 这个key是随机生成的，服务器会经过这个参数验证该请求是否有效。 -
Sec-WebSocket-Version:13， websocket使用的协议，通常就是13。 -
Sec-webSocket-Extension:permessage-deflate，客户端指定的一些扩展协议，好比这里permessage-deflate就是WebSocket的一种压缩协议。 -
响应码101,表示响应协议升级，后续的数据交互都按照Upgradet指定的WebSocket协议来。
OkHttp实现
添加OkHttp依赖
implementation("com.squareup.okhttp3:okhttp:4.7.2")
实现代码
首先是初始化OkHttpClient和WebSocket实例：socket
/**
* 初始化WebSocket
*/
public void init() {
mWbSocketUrl = "ws://echo.websocket.org";
mClient = new OkHttpClient.Builder()
.pingInterval(10, TimeUnit.SECONDS)
.build();
Request request = new Request.Builder()
.url(mWbSocketUrl)
.build();
mWebSocket = mClient.newWebSocket(request, new WsListener());
}
这里主要是配置了OkHttp的一些参数，以及WebSocket的链接地址。其中newWebSocket方法就是进行WebSocket的初始化和链接。
这里要注意的点是pingInterval方法的配置，这个方法主要是用来设置WebSocket链接的保活。相信作过长链接的同窗都知道，一个长链接通常要隔几秒发送一条消息告诉服务器我在线，而服务器也会回复一个消息表示收到了，这样就确认了链接正常，客户端和服务器端都在线。
若是服务器没有按时收到这个消息那么服务器可能就会主动关闭这个链接，节约资源。客户端没有正常收到这个返回的消息，也会作一些相似重连的操做，因此这个保活消息很是重要。
咱们称这个消息叫做心跳包，通常用PING，PONG表示，像乒乓球同样，一来一回。因此这里的pingInterval就是设置心跳包发送的间隔时间，设置了这个方法以后，OkHttp就会自动帮咱们发送心跳包事件，也就是ping包。当间隔时间到了，没有收到pong包的话，监听事件中的onFailure方法就会被调用，此时咱们就能够进行重连。
可是因为实际业务需求不同，以及okhttp中心跳包事件给予咱们权限较少，因此咱们也能够本身完成心跳包事件，即在WebSocket链接成功以后，开始定时发送ping包，在下一次发送ping包以前检查上一个pong包是否收到，若是没收到，就视为异常，开始重连。感兴趣的同窗能够看看文末的相关源码。
创建链接后，咱们就能够正常发送和读取消息了，也就是在上文WsListener监听事件中表现：
//监听事件，用于收消息，监听链接的状态
class WsListener extends WebSocketListener {
@Override
public void onClosed(@NotNull WebSocket webSocket, int code, @NotNull String reason) {
super.onClosed(webSocket, code, reason);
}
@Override
public void onClosing(@NotNull WebSocket webSocket, int code, @NotNull String reason) {
super.onClosing(webSocket, code, reason);
}
@Override
public void onFailure(@NotNull WebSocket webSocket, @NotNull Throwable t, @Nullable Response response) {
super.onFailure(webSocket, t, response);
}
@Override
public void onMessage(@NotNull WebSocket webSocket, @NotNull String text) {
super.onMessage(webSocket, text);
Log.e(TAG, "客户端收到消息:" + text);
onWSDataChanged(DATE_NORMAL, text);
//测试发消息
webSocket.send("我是客户端，你好啊");
}
@Override
public void onMessage(@NotNull WebSocket webSocket, @NotNull ByteString bytes) {
super.onMessage(webSocket, bytes);
}
@Override
public void onOpen(@NotNull WebSocket webSocket, @NotNull Response response) {
super.onOpen(webSocket, response);
Log.e(TAG,"链接成功！");
}
}
//发送String消息
public void send(final String message) {
if (mWebSocket != null) {
mWebSocket.send(message);
}
}
/**
* 发送byte消息
* @param message
*/
public void send(final ByteString message) {
if (mWebSocket != null) {
mWebSocket.send(message);
}
}
//主动断开链接
public void disconnect(int code, String reason) {
if (mWebSocket != null)
mWebSocket.close(code, reason);
}
这里要注意，回调的方法都是在子线程回调的，若是须要更新UI，须要切换到主线程。
基本操做就这么多，仍是很简单的吧，初始化Websocket——链接——链接成功——收发消息。
其中WebSocket类是一个操做接口，主要提供了如下几个方法
-
send(text: String)发送一个String类型的消息 -
send(bytes: ByteString)发送一个二进制类型的消息 -
close(code: Int, reason: String?)关闭WebSocket链接
若是有同窗想测试下WebSocket的功能可是又没有实际的服务器，怎么办呢？其实OkHttp官方有一个MockWebSocket服务，能够用来模拟服务端，下面咱们一块儿试一下：
模拟服务器
首先集成MockWebSocket服务库：
implementation 'com.squareup.okhttp3:mockwebserver:4.7.2'
而后就能够新建MockWebServer，并加入MockResponse做为接收消息的响应。
MockWebServer mMockWebServer = new MockWebServer();
MockResponse response = new MockResponse()
.withWebSocketUpgrade(new WebSocketListener() {
@Override
public void onOpen(@NotNull WebSocket webSocket, @NotNull Response response) {
super.onOpen(webSocket, response);
//有客户端链接时回调
Log.e(TAG, "服务器收到客户端链接成功回调：");
mWebSocket = webSocket;
mWebSocket.send("我是服务器，你好呀");
}
@Override
public void onMessage(@NotNull WebSocket webSocket, @NotNull String text) {
super.onMessage(webSocket, text);
Log.e(TAG, "服务器收到消息：" + text);
}
@Override
public void onClosed(@NotNull WebSocket webSocket, int code, @NotNull String reason) {
super.onClosed(webSocket, code, reason);
Log.e(TAG, "onClosed：");
}
});
mMockWebServer.enqueue(response);
这里服务器端在收到客户端链接成功消息后，给客户端发送了一条消息。要注意的是这段代码要在子线程执行，由于主线程不能进行网络操做。
而后就能够去初始化Websocket客户端了：
//获取链接url，初始化websocket客户端
String websocketUrl = "ws://" + mMockWebServer.getHostName() + ":" + mMockWebServer.getPort() + "/";
WSManager.getInstance().init(websocketUrl);
ok，运行项目
//运行结果
E/jimu: mWbSocketUrl=ws://localhost:38355/
E/jimu: 服务器收到客户端链接成功回调：
E/jimu: 链接成功！
E/jimu: 客户端收到消息:我是服务器，你好呀
E/jimu: 服务器收到消息：我是客户端，你好啊
参考
https://github.com/square/okhttp
感谢你们的阅读，有一块儿学习的小伙伴能够关注下公众号—
码上积木❤️❤️
每日三问知识点/面试题，聚沙成塔。
天天一见
给你力量
码上积木
点点在看，你最好看
本文分享自微信公众号 - 码上积木（Lzjimu）。
若有侵权，请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”，欢迎正在阅读的你也加入，一块儿分享。