netty-核心API

netty-核心API

起男 130 2024-03-25

netty-核心API

Bootstrap、ServerBootstrap

bootstrap意思是引导,一个netty应用通常由一个bootstrap开始,主要作用是配置整个netty程序,串联各个组件,netty中Bootstrap类是客户端程序的启动引导类,ServerBootstrap是服务端启动引导类

常用方法

  • group:服务端设置两个EventLoop,客户端设置一个EventLoop
  • channel:设置一个服务端的通道实现
  • option:给ServerChannel添加配置
  • childOption:给接受到的通道添加配置
  • childHandler:为workerGroup,设置业务处理类(自定义的handler)
  • handler:为bossGroup,设置业务处理类(自定义的handler)
  • bind:服务端用来设置端口号
  • connect:客户端用来连接服务器

Future、ChannelFuture

netty中所有的io操作都是异步的,不能立刻得知消息是否被正确处理。但是可以过一会等它执行完成或者直接注册一个监听,具体的实现就是通过Future和ChannelFutures,他们可以注册一个监听,当操作执行成功或失败时监听会自动触发注册的监听事件

常用方法

  • channel:返回当前正在执行io操作的通道
  • sync:等待异步操作执行完毕

Channel

  • netty网络通信的组件,能够用于执行网络io操作
  • 通过Channel可获得当前网络连接的通道的状态
  • 通过Channel可获得网络连接的配置参数(例如接收缓冲区大小)
  • Channel提供异步的网络io操作(如建立连接、读写、绑定端口),异步调用意味着任何io调用都将立即返回,并且不保证在调用结束时所请求的io操作已完成
  • 调用立即返回一个ChannelFuture实力,通过注册监听器到ChannelFuture上,可以io操作成功、失败或取消时回调通知调用方
  • 支持关联io操作与对应的处理程序
  • 不同协议、不同的阻塞类型的连接都有不同的Channel类型与之对应,常用的Channel类型有:
    • NioSocketChannel:异步的客户端tcp socket连接
    • NioServerSocketChannel:异步的服务器端tcp socket连接
    • NioDatagramChannel:异步的udp连接
    • NioSctpChannel,异步的客户端sctp连接
    • NioSctpServerChannel:异步的sctp服务器端连接

Selector

  • netty基于Selector对象实现io多路复用,通过Selector一个线程可以监听多个连接的Channel事件
  • 当向一个Selector中注册Channel后,Selector内部的机制就可以自动不断的查询这些注册的Channel是否有已就绪的io事件(例如:可读、可写、网络连接完成等),这样程序就可以很简单的使用一个线程高效的管理多个Channel

ChannelHandler

  • ChannelHandler是一个接口,处理io事件或者拦截io操作,并将其转发到其ChannelPipeline(业务处理链)中的下一个处理程序
  • ChannelHandler本身并没有提供很多方法,因为这个接口有许多的方法要实现,为方便使用,可以继承它的子类

子类

  • ChannelInboundHandler:处理入站io事件
  • ChannelOutboundHandler:处理出站io事件

适配器:

  • ChannelInboundHandlerAdapter:处理入站io事件
  • ChannelOutboundHandlerAdapter:处理出站io事件
  • ChannelDuplexHandler:用于处理入站和出站事件

ChannelPipeline提供了ChannelHandler链的容器。以客户端应用程序为例,如果事件的运动方向是从客户端到服务端的,那么我们称之为出站,即客户端发送给服务端的数据会通过pipeline中的一系列ChannelOutboundHandler,并被这些Handler处理,反之则为入站

常用方法

  • channelActive:通道就绪事件
  • chanelInactive:通道非活动
  • channelRead:通道读取数据事件
  • channelReadComplete:数据读取完毕事件
  • exceptionCaught:通道发生异常事件
  • handlerAdded:处理器被加入事件

Pipeline、ChannelPipeline

  • ChannelPipeline是一个handler的集合,它负责处理和拦截inbound或outbound的事件和操作,相当于一个贯穿netty的链(也可以这样理解:ChannelPipeline是保存ChannelHandler的list,用于处理或拦截Channel的入站和出站事件)
  • ChannelPipeline实现了一种高级形式的拦截过滤器模式,使用户可以完全控制事件的处理方式,以及Channel中各个的ChannelHandler如何相互交互
  • 在netty中每个Channel都有且仅有一个ChannelPipeline与之对应
  • 一个Channel包含了一个ChannelPipeline,而ChannelPipeline中又维护了一个由ChannelHandlerContext组成的双向链表,并且每个ChannelHandlerContext中又关联着一个ChannelHandler
  • 入站事件和出站事件在一个双向链表中,入站事件会从链表head往后传递到最后一个入站的handler;出站事件会从链表tail往前传递到最前一个出站的handler,两种类型的hander互不干扰

常用方法

  • addFirst:把一个handler添加到链表的第一个位置
  • addLast:把一个handler添加奥链表的最后一个位置

ChannelHandlerContext

  • 保存Channel相关的所有上下文信息,同时关联一个ChannelHandler对象
  • 即ChannelHandlerContext中包含一个具体的事件处理器ChannelHandler,同时ChannelHandlerContext中也绑定了对应的pipeline和Channel的信息,方便对ChannelHandler进行调用

常用方法

  • close:关闭通道
  • flush:刷新
  • writeAndFlush:将数据写到ChannelPipeline中当前ChannelHandler的下一个ChannelHandler开始处理(出站)

ChannelOptoin

  • netty在创建Channel实例后,一般都需要设置ChannelOption参数

常用参数

  • SO_BACKLOG:对应tcp/ip协议listen函数中的backlog参数,用来初始化服务器可连接队列大小
  • SO_KEEPALIVE::一直保存连接活动状态

EventLoopGroup、NioEventLoopGroup

  • EventLoopGroup是一组EventLoop的抽象,Netty为了更好的利用多核cpu资源,一般会有多个EventLoop同时工作,每个EventLoop维护者一个Selector实例
  • EventLoopGroup接口提供了next方法,可以从组里按照一定规则获取其中一个EventLoop来处理任务。在Netty服务器端编程中,我们一般都需要提供两个EventLoopGroup(BossEventLoopGroup和WorkerEventLoopGroup)
  • 通常一个服务端口即一个ServerSocketChannel对应一个Selector和一个EventLoop线程。BossEventLoop负责接收客户端的连接并将SocketChannel交给WorkerEventLoopGroup来进行io处理

常用方法

  • shutdownGracefully:断开连接,关闭线程

Unpooled

  • netty提供的一个专门用来操作缓冲区的工具类

常用方法

  • copiedBuffer:通过给定的数据和字符编码返回一个ByteBuf对象(类似于nio中的ByteBuffer但有区别)

案例

        //创建一个ByteBuf
        //包含一个数组arr,是一个byte[10]
        ByteBuf buffer = Unpooled.buffer(10);

        for (int i = 0; i < 10; i++) {
            buffer.writeByte(i);
        }
        //输出
        for (int i = 0; i < buffer.capacity(); i++) {
            //在netty的buf中不需要使用flip进行反转
            //底层分别维护了readindex和writerindex
            System.out.println(buffer.readByte());
//            System.out.println(buffer.getByte(i));//获取指定索引的数据
        }