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

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

}

}

MagicNumValidator：用于 TCP 报文的魔数校验。

class MagicNumValidator : LengthFieldBasedFrameDecoder(Int.MAX_VALUE, LENGTH_FIELD_OFFSET, LENGTH_FIELD_LENGTH) {

private val logger: Logger = LoggerFactory.getLogger(this.javaClass)

@Throws(Exception::class)

override fun decode(ctx: ChannelHandlerContext, in: ByteBuf): Any? {

if (in.getInt(in.readerIndex()) !== MAGIC_NUMBER) { // 魔数校验不通过，则关闭连接

logInfo(logger,“魔数校验失败”)

ctx.channel().close()

return null

}

return super.decode(ctx, in)

}

companion object {

private const val LENGTH_FIELD_OFFSET = 7

private const val LENGTH_FIELD_LENGTH = 4

}

}

PacketCodecHandler: 解析报文的 Handler。

PacketCodecHandler 继承自 ByteToMessageCodec ，它是用来处理 byte-to-message 和message-to-byte，便于解码字节消息成 POJO 或编码 POJO 消息成字节。

@ChannelHandler.Sharable

object PacketCodecHandler : MessageToMessageCodec<ByteBuf, Packet>() {

override fun encode(ctx: ChannelHandlerContext, msg: Packet, list: MutableList) {

val byteBuf = ctx.channel().alloc().ioBuffer()

PacketManager.encode(byteBuf, msg)

list.add(byteBuf)

}

override fun decode(ctx: ChannelHandlerContext, msg: ByteBuf, list: MutableList) {

list.add(PacketManager.decode(msg));

}

}

HeartBeatHandler：心跳的 Handler，接收 TCP 客户端发来的"ping"，然后给客户端返回"pong"。

@ChannelHandler.Sharable

object HeartBeatHandler : SimpleChannelInboundHandler(){

private val logger: Logger = LoggerFactory.getLogger(this.javaClass)

override fun channelRead0(ctx: ChannelHandlerContext, msg: HeartBeatPacket) {

logInfo(logger,“收到心跳包：${GsonUtils.toJson(msg)}”)

msg.msg = “pong” // 返回 pong 给到客户端

ctx.writeAndFlush(msg)

}

}

ResponseHandler：通用的处理接收 TCP 客户端发来指令的 Handler，可以根据对应的指令去查询对应的 Handler 并处理其命令。

object ResponseHandler: SimpleChannelInboundHandler() {

private val logger: Logger = LoggerFactory.getLogger(this.javaClass)

private val handlerMap: ConcurrentHashMap<Byte, SimpleChannelInboundHandler> = ConcurrentHashMap()

init {

handlerMap[LOGIN] = LoginHandler

…

handlerMap[ERROR] = ErrorHandler

}

override fun channelRead0(ctx: ChannelHandlerContext, msg: Packet) {

logInfo(logger,“收到客户端的指令: ${msg.command}”)

val handler: SimpleChannelInboundHandler? = handlerMap[msg.command]

handler?.let {

logInfo(logger,“找到响应指令的 Handler: ${it.javaClass.simpleName}”)

it.channelRead(ctx, msg)

} ?: logInfo(logger,“未找到响应指令的 Handler”)

}

@Throws(Exception::class)

override fun channelInactive(ctx: ChannelHandlerContext) {

val insocket = ctx.channel().remoteAddress() as InetSocketAddress

val clientIP = insocket.address.hostAddress

val clientPort = insocket.port

logError(logger,“客户端掉线: $clientIP : $clientPort”)

super.channelInactive(ctx)

}

}

四. TCP 客户端

==========================================================================

模拟一个客户端的实现

val topLevelClass = object : Any() {}.javaClass.enclosingClass

val logger: Logger = LoggerFactory.getLogger(topLevelClass)

fun main() {

val worker = NioEventLoopGroup()

val bootstrap = Bootstrap()

bootstrap.group(worker).channel(NioSocketChannel::class.java)

.handler(object : ChannelInitializer() {

@Throws(Exception::class)

override fun initChannel(channel: SocketChannel) {

channel.pipeline().addLast(PacketCodecHandler)

channel.pipeline().addLast(ClientIdleHandler())

channel.pipeline().addLast(ClientLogin())

}

})

val future: ChannelFuture = bootstrap.connect(“127.0.0.1”, TCP_PORT).addListener(object : ChannelFutureListener {

@Throws(Exception::class)

override fun operationComplete(channelFuture: ChannelFuture) {

if (channelFuture.isSuccess()) {

logInfo(logger,“connect to server success!”)

} else {

logger.info("failed to connect the server! ")

System.exit(0)

}

}

})

try {

future.channel().closeFuture().sync()

logInfo(logger,“与服务端断开连接！”)

} catch (e: InterruptedException) {

e.printStackTrace()

}

}

其中，PacketCodecHandler 跟服务端使用的解析报文的 Handler 是一样的。

ClientIdleHandler：客户端实现心跳，每隔 30 秒发送一次心跳。

class ClientIdleHandler : IdleStateHandler(0, 0, HEART_BEAT_TIME) {

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

@Throws(Exception::class)

override fun channelIdle(ctx: ChannelHandlerContext, evt: IdleStateEvent?) {

logInfo(logger,“发送心跳…”)

ctx.writeAndFlush(HeartBeatPacket())

}

companion object {

private const val HEART_BEAT_TIME = 30

}

}

ClientLogin：登录服务端的 Handler。

@ChannelHandler.Sharable

class ClientLogin: ChannelInboundHandlerAdapter() {

private val logger: Logger = LoggerFactory.getLogger(this.javaClass)

@Throws(Exception::class)

override fun channelActive(ctx: ChannelHandlerContext) {

val packet: LoginPacket = LoginPacket()

logInfo(logger,“packet = ${GsonUtils.toJson(packet)}”)

val byteBuf = PacketManager.encode(packet)

ctx.channel().writeAndFlush(byteBuf)

推荐学习资料

• Android进阶学习全套手册

  

• Android对标阿里P7学习视频

  

• BAT TMD大厂Android高频面试题

《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》，点击传送门，即可获取！
override fun channelActive(ctx: ChannelHandlerContext) {

val packet: LoginPacket = LoginPacket()

logInfo(logger,“packet = ${GsonUtils.toJson(packet)}”)

val byteBuf = PacketManager.encode(packet)

ctx.channel().writeAndFlush(byteBuf)

推荐学习资料

• Android进阶学习全套手册

  [外链图片转存中…(img-oZ6Hd6mg-1715027377199)]

• Android对标阿里P7学习视频

  [外链图片转存中…(img-WK2nS5y8-1715027377200)]

• BAT TMD大厂Android高频面试题

[外链图片转存中…(img-SFfKvesy-1715027377201)]
《Android学习笔记总结+移动架构视频+大厂面试真题+项目实战源码》，点击传送门，即可获取！