Kotlin + Netty 在 Android 上实现 Socket 的服务端

一. 背景

最近的一个项目：需要使用 Android App 作为 Socket 的服务端，并且一个端口能够同时监听 TCP/Web Socket 协议。

自然而然，项目决定采用 Netty 框架。Netty 服务端在收到客户端发来的消息后，能够做出相应的业务处理。在某些场景下，服务端也需要给客户端 App/网页发送消息。

二. Netty 的使用

2.1 Netty 服务端

首先，定义好 NettyServer，它使用 object声明表示是一个单例。用于 Netty 服务端的启动、关闭以及发送消息。

   
   
   

    
object NettyServer {
       
    

    
 private val TAG = "NettyServer"
    

    
 private var channel: Channel?=null
    
 private lateinit var listener: NettyServerListener<String>
    
 private lateinit var bossGroup: EventLoopGroup
    
 private lateinit var workerGroup: EventLoopGroup
    

    
 var port = 8888
    
 set(value) {
       
    
 field = value
    
 }
    

    
 var webSocketPath = "/ws"
    
 set(value) {
       
    
 field = value
    
 }
    

    
 var isServerStart: Boolean = false
    
 private set
    

    
 fun start() {
       
    
 object : Thread() {
       
    
 override fun run() {
       
    
 super.run()
    
 bossGroup = NioEventLoopGroup(1)
    
 workerGroup = NioEventLoopGroup()
    
 try {
       
    
 val b = ServerBootstrap()
    
 b.group(bossGroup, workerGroup)
    
 .channel(NioServerSocketChannel::class.java)
    
 .localAddress(InetSocketAddress(port))
    
 .childOption(ChannelOption.SO_KEEPALIVE, true)
    
 .childOption(ChannelOption.SO_REUSEADDR, true)
    
 .childOption(ChannelOption.TCP_NODELAY, true)
    
 .childHandler(NettyServerInitializer(listener,webSocketPath))
    

    
 // Bind and start to accept incoming connections.
    
 val f = b.bind().sync()
    
 Log.i(TAG, NettyServer::class.java.name + " started and listen on " + f.channel().localAddress())
    

    
 isServerStart = true
    
 listener.onStartServer()
    
 f.channel().closeFuture().sync()
    
 } catch (e: Exception) {
       
    
 Log.e(TAG, e.localizedMessage)
    
 e.printStackTrace()
    
 } finally {
       
    
 isServerStart = false
    
 listener.onStopServer()
    

    
 disconnect()
    
 }
    
 }
    
 }.start()
    

    
 }
    

    
 fun disconnect() {
       
    
 workerGroup.shutdownGracefully()
    
 bossGroup.shutdownGracefully()
    
 }
    

    
 fun setListener(listener: NettyServerListener<String>) {
       
    
 this.listener = listener
    
 }
    

    
 // 异步发送TCP消息
    
 fun sendMsgToClient(data: String, listener: ChannelFutureListener) = channel?.run {
       
    

    
 val flag = this.isActive
    

    
 if (flag) {
       
    

    
 this.writeAndFlush(data + System.getProperty("line.separator")).addListener(listener)
    
 }
    

    
 flag
    
 } ?: false
    

    
 // 同步发送TCP消息
    
 fun sendMsgToClient(data: String) = channel?.run {
       
    

    
 if (this.isActive) {
       
    

    
 return this.writeAndFlush(data + System.getProperty("line.separator")).awaitUninterruptibly().isSuccess
    
 }
    

    
 false
    
 } ?: false
    

    
 // 异步发送WebSocket消息
    
 fun sendMsgToWS(data: String,listener: ChannelFutureListener) = channel?.run {
       
    

    
 val flag = this.isActive
    

    
 if (flag) {
       
    

    
 this.writeAndFlush(TextWebSocketFrame(data)).addListener(listener)
    
 }
    

    
 flag
    
 } ?: false
    

    
 // 同步发送TCP消息
    
 fun sendMsgToWS(data: String) = channel?.run {
       
    

    
 if (this.isActive) {
       
    

    
 return this.writeAndFlush(TextWebSocketFrame(data)).awaitUninterruptibly().isSuccess
    
 }
    

    
 false
    
 } ?: false
    

    
 /**
    
 * 切换通道
    
 * 设置服务端，与哪个客户端通信
    
 * @param channel
    
 */
    
 fun selectorChannel(channel: Channel?) {
       
    
 this.channel = channel
    
 }
    
}
   

NettyServerInitializer 是服务端跟客户端连接之后使用的 childHandler：

   
   
   

    
class NettyServerInitializer(private val mListener: NettyServerListener<String>,private val webSocketPath:String) : ChannelInitializer<SocketChannel>() {
       
    

    
 @Throws(Exception::class)
    
 public override fun initChannel(ch: SocketChannel) {
       
    

    
 val pipeline = ch.pipeline()
    

    
 pipeline.addLast("active",ChannelActiveHandler(mListener))
    
 pipeline.addLast("socketChoose", SocketChooseHandler(webSocketPath))
    

    
 pipeline.addLast("string_encoder",StringEncoder(CharsetUtil.UTF_8))
    
 pipeline.addLast("linebased",LineBasedFrameDecoder(1024))
    
 pipeline.addLast("string_decoder",StringDecoder(CharsetUtil.UTF_8))
    
 pipeline.addLast("commonhandler", CustomerServerHandler(mListener))
    
 }
    
}
   

NettyServerInitializer 包含了多个 Handler：连接使用的ChannelActiveHandler，协议选择使用的 SocketChooseHandler，TCP 消息使用的 StringEncoder、LineBasedFrameDecoder、StringDecoder&#