基于Kotlin实现一个简单的TCP自定义协议，android组件化面试

我们的项目需要开发一款智能硬件。它由 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 的位置）
  */
  const val LOGIN: Byte = 1

…
}
}

由于使用自定义的协议，必须要有对报文的 encode、decode，PacketManager 负责这些事情。
encode 时按照协议的结构进行组装报文，同理 decode 是其逆向的过程。

/**

• 报文的管理类，对报文进行 encode、decode
  */
  object PacketManager {

fun encode(packet: Packet):ByteBuf = encode(ByteBufAllocator.DEFAULT, packet)

fun encode(alloc:ByteBufAllocator, packet: Packet) = encode(alloc.ioBuffer(), packet)

fun encode(buf: ByteBuf, packet: Packet): ByteBuf {

val serializer = SerializerFactory.getSerializer(packet.serializeMethod)

val bytes: ByteArray = serializer.serialize(packet)

//组装报文:魔数（4字节）+ 版本号（1字节）+ 序列化方式（1字节）+ 指令（1字节）+ 数据长度（4字节）+ 数据（N字节）
buf.writeInt(MAGIC_NUMBER)
buf.writeByte(packet.version.toInt())
buf.writeByte(packet.serializeMethod.toInt())
buf.writeByte(packet.command.toInt())
buf.writeInt(bytes.size)
buf.writeBytes(bytes)

return buf
}

fun decode(buf:ByteBuf): Packet {

buf.skipBytes(4) // 魔数由单独的 Handler 进行校验
buf.skipBytes(1)

val serializationMethod = buf.readByte()
val serializer = SerializerFactory.getSerializer(serializationMethod)

val command = buf.readByte()
val clazz = PacketFactory.getPacket(command)

val length = buf.readInt() // 数据的长度
val bytes = ByteArray(length) // 定义需要读取的字符数组
buf.readBytes(bytes)
return serializer.deserialize(clazz, bytes)
}

}

三. TCP 服务端

启动 TCP 服务的方法

fun execute() {
boss = NioEventLoopGroup()
worker = NioEventLoopGroup()
val bootstrap = ServerBootstrap()
bootstrap.group(boss, worker).channel(NioServerSocketChannel::class.java)
.option(ChannelOption.SO_BACKLOG, 100)
.childOption(ChannelOption.SO_KEEPALIVE, true)
.childOption(ChannelOption.SO_REUSEADDR, true)
.childOption(ChannelOption.TCP_NODELAY, true)
.childHandler(object : ChannelInitializer() {

@Throws(Exception::class)
override fun initChannel(nioSocketChannel: NioSocketChannel) {

val pipeline = nioSocketChannel.pipeline()
pipeline.addLast(ServerIdleHandler())
pipeline.addLast(MagicNumValidator())
pipeline.addLast(PacketCodecHandler)
pipeline.addLast(HeartBeatHandler)
pipeline.addLast(ResponseHandler)
}
})

val future: ChannelFuture = bootstrap.bind(TCP_PORT)

future.addListener(object : ChannelFutureListener {

@Throws(Exception::class)
override fun operationComplete(channelFuture: ChannelFuture) {
if (channelFuture.isSuccess) {
logInfo(logger, “TCP Server is starting…”)
} else {
logError(logger,channelFuture.cause(),“TCP Server failed”)
}
}
})
}

其中，ServerIdleHandler： 表示 5 分钟内没有收到心跳，则断开连接。

class ServerIdleHandler : IdleStateHandler(0, 0, HERT_BEAT_TIME) {

private val logger: Logger = LoggerFactory.getLogger(ServerIdleHandler::class.java)

@Throws(Exception::class)
override fun channelIdle(ctx: ChannelHandlerContext, evt: IdleStateEvent) {
logInfo(logger) {
ctx.channel().close()
“$HERT_BEAT_TIME 秒内没有收到心跳，则断开连接”
}
}

companion object {

private const val HERT_BEAT_TIME = 300
}
}

自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Android工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Android移动开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Android开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录大纲截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且后续会持续更新

如果你觉得这些内容对你有帮助，可以添加V获取：vip204888 （备注Android）

最后

感觉现在好多人都在说什么安卓快凉了，工作越来越难找了。又是说什么程序员中年危机啥的，为啥我这年近30的老农根本没有这种感觉，反倒觉得那些贩卖焦虑的都是瞎j8扯谈。当然，职业危机意识确实是要有的，但根本没到那种草木皆兵的地步好吗？

Android凉了都是弱者的借口和说辞。虽然 Android 没有前几年火热了，已经过去了会四大组件就能找到高薪职位的时代了。这只能说明 Android 中级以下的岗位饱和了，现在高级工程师还是比较缺少的，很多高级职位给的薪资真的特别高（钱多也不一定能找到合适的），所以努力让自己成为高级工程师才是最重要的。

所以，最后这里放上我耗时两个月，将自己8年Android开发的知识笔记整理成的Android开发者必知必会系统学习资料笔记，上述知识点在笔记中都有详细的解读，里面还包含了腾讯、字节跳动、阿里、百度2019-2021面试真题解析，并且把每个技术点整理成了视频和PDF（知识脉络 + 诸多细节）。

以上全套学习笔记面试宝典，吃透一半保你可以吊打面试官，只有自己真正强大了，有核心竞争力，你才有拒绝offer的权力，所以，奋斗吧！骚年们！千里之行，始于足下。种下一颗树最好的时间是十年前，其次，就是现在。

最后，赠与大家一句诗，共勉！

不驰于空想，不骛于虚声。不忘初心，方得始终。

一个人可以走的很快，但一群人才能走的更远。不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎扫码加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

有拒绝offer的权力，所以，奋斗吧！骚年们！千里之行，始于足下。种下一颗树最好的时间是十年前，其次，就是现在。

最后，赠与大家一句诗，共勉！

不驰于空想，不骛于虚声。不忘初心，方得始终。

一个人可以走的很快，但一群人才能走的更远。不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎扫码加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！
[外链图片转存中…(img-6kTFRPRl-1712716682913)]