基于 Kotlin + Netty 实现一个简单的 TCP 自定义协议

最新推荐文章于 2024-04-10 10:37:47 发布

Java与Android技术栈

最新推荐文章于 2024-04-10 10:37:47 发布

阅读量301

点赞数

文章标签：网络协议网络通信 netty rpc qemu

本文链接：https://blog.csdn.net/SLFq6OF5O7aH/article/details/107925109

版权

本文介绍了基于 Kotlin 和 Netty 实现一个自定义 TCP 通讯协议的过程，包括协议设计、TCP 服务端和客户端的实现。通过魔数验证、序列化方式选择、指令编码解码等，确保了通信的稳定性和安全性。

摘要由CSDN通过智能技术生成

一. 开发背景

我们的项目需要开发一款智能硬件。它由 Web 后台发送指令到一款桌面端应用程序，再由桌面程序来控制不同的硬件设备实现业务上的操作。从 Web 后台到桌面端是通过一个 WebSocket 长链接来进行维护，而桌面程序到各个硬件设备也是一个 TCP 长链接来维护的。

本文讲述的，其实是从桌面程序到各个硬件之间的通讯。

二. 自定义通讯协议

首先，需要设计一个通用的 TCP 网络协议。

网络协议结构如下

     +--------------+---------------+------------+---------------+-----------+----------+
     | 魔数(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
    }
}

每个 Packet 也包含了其对应的 command。下面是 Commands 是指令集，支持256个指令。

/**
 * 指令集，支持从 -128 到 127 总共 256 个指令
 */
interface Commands {


    companion object {


        /**
         * 心跳包
         */
        const val HEART_BEAT: Byte = 0


        /**
         * 登录（App 需要告诉 Watcher ：cameraPosition 的位置&