Hermes资瓷MQTT和WebSocket两种长连接推送。
-
MQTT的实现基于 paho.mqtt 开源库的封装，可对后台主题进行订阅和发送。
-
WebSocket的实现基于 Java-WebSocket 开源库的封装，可实现双向推送。
由于jcenter删库跑路，请大家添加mavenCentral依赖，并引用最新版本（为了配合迁移，引用的域名从cn.lodz改为ink.lodz）
repositories {
...
mavenCentral()
...
}
implementation 'ink.lodz:hermes:2.1.2'
该库引用了下列这些第三方库，你可以确认你的项目，排除重复的引用。
dependencies {
api 'org.eclipse.paho:org.eclipse.paho.client.mqttv3:1.2.5'
api 'org.eclipse.paho:org.eclipse.paho.android.service:1.1.1'
api 'org.java-websocket:Java-WebSocket:1.5.2'
}
Hermes的使用非常简单，仅需3步：
Hermes hermes =
HermesAgent.create()
.setConnectType(HermesAgent.MQTT)// 使用WebSocket可传入HermesAgent.WEB_SOCKET
.setUrl(url)// 设置tcp地址和端口
.setClientId(clientId)// 设置客户端id（使用WebSocket可不传）
.setPrintLog(true)// 是否启用日志（默认是关闭的）
.setLogTag("HermesLog")// 设置日志标签
.setSilent(true)// 设置是否保持连接静默不接收消息（默认false）
.setSubTopics(subTopic)// 订阅多个主题（使用WebSocket可不传）
.setSubTopic(subTopic)// 订阅单个主题（使用WebSocket可不传）
.setConnectOptions(MqttConnectOptions)// 可以将自己创建的MqttConnectOptions对象配置后传入（使用WebSocket可不传）
.setOnConnectListener(new OnConnectListener() {// 设置连接回调监听器
@Override
public void onConnectComplete(boolean isReconnected) {
// 连接完成，isReconnected表示是否是重连
}
@Override
public void onConnectFailure(Throwable cause) {
// 连接失败
}
@Override
public void onConnectionLost(Throwable cause) {
// 连接断开（丢失）
}
})
.setOnSendListener(new OnSendListener() {// 设置发送监听器
@Override
public void onSendComplete(String topic, String content) {
// 发送成功
}
@Override
public void onSendFailure(String topic, Throwable cause) {
// 发送失败
}
})
.setOnSubscribeListener(new OnSubscribeListener() {// 设置订阅监听器
@Override
public void onSubscribeSuccess(String topic) {
// 订阅主题成功
}
@Override
public void onSubscribeFailure(String topic, Throwable cause) {
// 订阅主题失败
}
@Override
public void onMsgArrived(String subTopic, String msg) {
// 后台消息到达
}
})
.build(getContext().getApplicationContext())// 构建Hermes对象
.buildConnect(getContext().getApplicationContext())// 构建Hermes对象并自动连接后台
- 小伙伴可以根据自己的需要选择方法进行设置
- setUrl()一定要配置，否则会抛出空指针异常，如果选择MQTT连接方式setClientId()也同理必须设置
- 使用MQTT方式setSubTopics()和setSubTopic()正常二选一进行调用，如果不设置将不会订阅后台的主题，订阅状态会通过setOnSubscribeListener()内的监听器回调
- 使用MQTT方式setConnectOptions()正常情况下不需要设置，内部默认的MqttConnectOptions包含了自动断线重连，如果需要深度定制再调用该方法
- setOnConnectListener()、setOnSendListener()和setOnSubscribeListener()这3个监听器方法大家根据自己的业务需要选择监听即可
- build()和buildConnect()和也是二选一调用，差别在于后者会在创建后自动帮你连接，建议传入的Context使用ApplicationContext
- WebSocket内部已实现自动断线重连机制，如果要关闭可以通过以下配置:
val options = MqttConnectOptions()
options.isAutomaticReconnect = false
setConnectOptions(options)
hermes.sendTopic(topic, content);（使用WebSocket主题topic可传空或空字符串）
- 传入发送的主题和内容
- 发送的结果和状态会通过setOnSendListener()方法内的监听器回调
hermes.connect();// 连接后台
hermes.disconnect();// 断开连接
hermes.isConnected();// 是否已连接
hermes.subscribeTopic();// 订阅主题（订阅时机由Hermes内部把握，不建议外部来调用，不过这边预留了方法给有需要的小伙伴）
- 如果你希望在build()后手动进行连接，可以调用connect()方法
- 调用disconnect()方法可以手动断开连接
- isConnected()可以告诉你当前的连接状态
你会看到3个压缩包，分别是：activemq5.zip、lib.zip和optional.zip
由于github限制了上传文件的大小，我只能将他们分开打包，上述步骤解压完成后就完成了初始配置
bin -> win64 -> activemq.bat
http://192.168.6.150:8161/admin/topics.jsp
（具体IP以你PC本机IP为主）
通过继承WebSocketServer类实现内部的抽象方法，来实现WebSocket服务端逻辑。
- 我继承WebSocketServer实现了一个简单的封装基类 BaseWebSocketServer.kt 。
- 内部包含了主线程的监听器回调，以及连接上的客户端缓存。
- 简单业务可直接生成对象调用，复杂业务可以继承后自定义。
- 具体使用方法可以参考WebsocketServerActivity.kt ，有完整的例子。
- 可使用http://www.websocket-test.com/等网站来进行调试验证。
Copyright 2022 Lodz
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.