网络协议结构如下
±-------------±--------------±-----------±--------------±----------±---------+
| 魔数(4) | version(1) |序列化方式(1) | command(1) |数据长度(4) |数据(n) |
±-------------±--------------±-----------±--------------±----------±---------+
-
魔数:4字节,本项目中使用 20200803(这一天编写的日子),为了防止该端口被意外调用,我们在收到报文后取前4个字节与魔数比对,如果不相同则直接拒绝并关闭连接。
-
版本号:1字节,仅表示协议的版本号,便于协议升级时使用
-
序列化方式:1字节,表示如何将 Java 对象转化为二进制数据,以及如何反序列化。
-
指令:1字节,表示该消息的意图(如拍照、拍视频、心跳、App 升级等)。最多支持 2^8 种指令。
-
数据长度:4字节,表示该字段后数据部分的长度。最多支持 2^32 位。
-
数据:具体数据的内容。
根据上述所设计的网络协议,定义一个抽象类 Packet:
abstract class Packet {
var magic:Int? = MAGIC_NUMBER // 魔数
var version:Byte = 1 // 版本号,当前协议的版本号为 1
abstract val serializeMethod:Byte // 序列化方式
abstract val command:Byte // Watcher 跟 App 相互通讯的指令
}
有多少个指令就需要定义多少个 Packet,下面以心跳的 Packet 为例,定义一个 HeartBeatPacket:
data class HeartBeatPacket(var msg:String = “ping”,
override val serializeMethod: Byte = Serialize.JSON,
override val command: Byte = Commands.HEART_BEAT) : Packet() {
}
HeartBeatPacket 是由 TCP 客户端发起,由 TCP 服务端接收并返回给客户端。
每个 Packet 类都包含了该 Packet 所使用的序列化方式。
/**
- 序列化方式的常量列表
*/
interface Serialize {
companion object {
const val JSON: Byte = 0
}