Netty核心模块组件

Bootstrap、ServerBootstrap

介绍

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

常用方法

• public Server Bootstrap group(EventLoopGroup parentGroup,EventLoopGroup childGroup)，该方法用于服务器端，用来设置两个EventLoop
• public B group(EventLoop Groupgroup)，该方法用于客户端，用来设置一个EventLoop
• public B channel(Class channelClass)，该方法用来设置一个服务器端的通道实现、
• public B option(ChannelOption option,Tvalue)，用来给ServerChannel添加配置
• public Server Bootstrap childOption(ChannelOption childOption,T value)，用来给接收到的通道添加配置
• public ServerBootstrap childHandler(ChannelHandler childHandler)，该方法用来设置业务处理类（自定义的handler）
• public ChannelFuture bind(int inetPort)，该方法用于服务器端，用来设置占用的端口号
• public ChannelFuture connect(String inetHost,int inetPort)，该方法用于客户端，用来连接服务器端

EventLoopGroup

介绍

• EventLoopGroup是一组EventLoop的抽象，Netty为了更好的利用多核CPU资源，一般会有多个EventLoop同时工作，每个EventLoop维护着一个Selector实例。
• EventLoopGroup提供next接口，可以从组里面按照一定规则获取其中一个EventLoop来处理任务。在Netty服务器端编程中，我们一般都需要提供两个EventLoopGroup，例如：BossEventLoopGroup和WorkerEventLoopGroup。
• 通常一个服务端口即一个ServerSocketChannel对应一个Selector和一个EventLoop线程。BossEventLoop负责接收客户端的连接并将SocketChannel交给WorkerEventLoopGroup来进行IO处理
  • BossEventLoopGroup 通常是一个单线程的 EventLoop，EventLoop 维护着一个注册了ServerSocketChannel 的 Selector 实例，BossEventLoop不断轮询 Selector 将连接事件（通常是 OP_ACCEPT 事件），将接收到的 SocketChannel 交给 WorkerEventLoopGroup
  • WorkerEventLoopGroup 会由 next 选择其中一个 EventLoop来将这个 SocketChannel 注册到其维护的 Selector 并对其后续的 IO 事件进行处理

子类NioEventLoopGroup常用方法

• public NioEventLoopGroup()，构造方法
• public Future shutdownGracefully()，断开连接，关闭线程

Selector

介绍

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

Channel

介绍

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

常用的Channel类型

• NioSocketChannel，异步的客户端TCPSocket连接。
• NioServerSocketChannel，异步的服务器端TCPSocket连接。
• NioDatagramChannel，异步的UDP连接。
• NioSctpChannel，异步的客户端Sctp连接。
• NioSctpServerChannel，异步的Sctp服务器端连接，这些通道涵盖了UDP和TCP网络IO以及文件IO

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，两种类型的 handler 互不干扰

常用方法

• ChannelPipeline addFirst(ChannelHandler... handlers)，把一个业务处理类（handler）添加到链中的第一个位置
• ChannelPipeline addLast(ChannelHandler... handlers)，把一个业务处理类（handler）添加到链中的最后一个位置

ChannelHandlerContext

介绍

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

常用方法

• ChannelFuture close()，关闭通道
• ChannelOutboundInvoker flush()，刷新
• ChannelFuture writeAndFlush(Object msg)， 将 数 据 写 到 ChannelPipeline 中，当 ChannelHandler 的下一个 ChannelHandler 开始处理（出站）

ChannelHandler

介绍

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

常用子类

• ChannelInboundHandler 用于处理入站 I/O 事件。
• ChannelOutboundHandler 用于处理出站 I/O 操作。

适配器

• ChannelInboundHandlerAdapter（常用） 用于处理入站 I/O 事件。

  public class ChannelInboundHandlerAdapter extends ChannelHandlerAdapter implements ChannelInboundHandler {
     public ChannelInboundHandlerAdapter() { 
     }
     public void channelRegistered(ChannelHandlerContext ctx) throws Exception {
          ctx.fireChannelRegistered();
     }
     public void channelUnregistered(ChannelHandlerContext ctx) throws Exception {
          ctx.fireChannelUnregistered();
     }	   
     //通道就绪事件
     public void channelActive(ChannelHandlerContext ctx) throws Exception {
          ctx.fireChannelActive();
     }
      public void channelInactive(ChannelHandlerContext ctx) throws Exception {
          ctx.fireChannelInactive();
     }
     //通道读取数据事件
     public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
          ctx.fireChannelRead(msg);
     }
      //数据读取完毕事件
      public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
          ctx.fireChannelReadComplete();
     }
      public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception {
          ctx.fireUserEventTriggered(evt);
     }
     public void channelWritabilityChanged(ChannelHandlerContext ctx) throws Exception {
          ctx.fireChannelWritabilityChanged();
     }
     //通道发生异常事件
      public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
          ctx.fireExceptionCaught(cause);
      }
  }
  

• ChannelOutboundHandlerAdapter 用于处理出站 I/O 操作。
• ChannelDuplexHandler 用于处理入站和出站事件。

ChannelOption

介绍

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

ChannelOption 参数

• ChannelOption.SO_BACKLOG
  对应 TCP/IP 协议 listen 函数中的 backlog 参数，用来初始化服务器可连接队列大小。服
  务端处理客户端连接请求是顺序处理的，所以同一时间只能处理一个客户端连接。多个客户
  端来的时候，服务端将不能处理的客户端连接请求放在队列中等待处理，backlog 参数指定
  了队列的大小。
• ChannelOption.SO_KEEPALIVE
  一直保持连接活动状态

ChannelFuture

介绍

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

常用方法

• Channel channel()，返回当前正在进行IO操作的通道
• ChannelFuture sync()，等待异步操作执行完毕

ByteBfu与Unpooled

介绍

• Unpooled是Netty提供一个专门用来操作缓冲区ByteBfu的工具类

Unpooled常用方法

• public static ByteBuf copiedBuffer(CharSequence string, Charset charset)，通过给定的数据和字符编码返回一个 ByteBuf 对象（类似于 NIO 中的 ByteBuffer 但有区别）
• public static ByteBuf buffer(int initialCapacity)，开辟initialCapacity大小的bytebuffer

ByteBfu和ByteBuffer比较

• 共同点：
  • 都是包含一个数组arr , 是一个byte[]
• 不同点：
  • 在netty 的buffer中，不需要使用flip 进行反转
    • 底层维护了 readerindex 和 writerIndex
    • 通过 readerindex 和 writerIndex 和 capacity， 将buffer分成三个区域
      • 0—readerindex 已经读取的区域
      • readerindex—writerIndex ， 可读的区域
      • writerIndex – capacity, 可写的区域

案例

• 使用ByteBfu读写

   public static void main(String[] args) {
   
      //创建一个ByteBuf
      ByteBuf buffer = Unpooled.buffer(10);
  
      for(int i = 0; i < 10; i++) {
          buffer.writeByte(i);
      }
  
      System.out.println("capacity=" + buffer.capacity());//10
  
      for(int i = 0; i < buffer.capacity(); i++) {
      	//System.out.println(buffer.getByte(i));
      	//readByte会自动使readIndex后移
          System.out.println(buffer.readByte());
      }
  }
  

• Unpooled.copiedBuffer、ByteBfu常用属性及方法

  public static void main(String[] args) {
  
      //创建ByteBuf
      ByteBuf byteBuf = Unpooled.copiedBuffer("hello,world!", Charset.forName("utf-8"));
  
      //属性
      System.out.println(byteBuf.arrayOffset()); // 0
      System.out.println(byteBuf.readerIndex()); // 0
      System.out.println(byteBuf.writerIndex()); // 12
      System.out.println(byteBuf.capacity()); // 36
      //System.out.println(byteBuf.readByte()); //
      System.out.println(byteBuf.getByte(0)); // 104
      
      int len = byteBuf.readableBytes(); //可读的字节数  12
      System.out.println("len=" + len);
  
      //使用for取出各个字节
      for(int i = 0; i < len; i++) {
          System.out.println((char) byteBuf.getByte(i));
      }
  
      //按照某个范围读取
      System.out.println(byteBuf.getCharSequence(0, 4, Charset.forName("utf-8")));
      System.out.println(byteBuf.getCharSequence(4, 6, Charset.forName("utf-8")));
  
      //转为byte[]
      if(byteBuf.hasArray()) { // true
          byte[] content = byteBuf.array();
          //将 content 转成字符串
          System.out.println(new String(content, Charset.forName("utf-8")));
          System.out.println("byteBuf=" + byteBuf);
      }
  }
  

Netty心跳检测机制案例

添加方法

• 在ChannelPipeline里加入一个netty 提供 IdleStateHandler

  //IdleStateHandler 是netty 提供的处理空闲状态的处理器
  public IdleStateHandler(
              long readerIdleTime, //表示多长时间没有读, 就会发送一个心跳检测包检测是否连接
              long writerIdleTime, long allIdleTime, //表示多长时间没有写, 就会发送一个心跳检测包检测是否连接
              TimeUnit unit  //表示多长时间没有读写, 就会发送一个心跳检测包检测是否连接
   )
  

• 当 IdleStateEvent 触发后 , 就会传递给管道 的下一个handler去处理，通过调用(触发)下一个handler 的 userEventTiggered , 在该方法中去处理 IdleStateEvent(读空闲，写空闲，读写空闲)

案例

• HeartbeatServerHandler

  public class HeartbeatServerHandler extends ChannelInboundHandlerAdapter {
  
      /**
       *
       * @param ctx 上下文
       * @param evt 事件
       * @throws Exception
       */
      @Override
      public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception {
  
          if(evt instanceof IdleStateEvent) {
  
              //将  evt 向下转型 IdleStateEvent
              IdleStateEvent event = (IdleStateEvent) evt;
              String eventType = null;
              switch (event.state()) {
                  case READER_IDLE:
                    eventType = "读空闲";
                    break;
                  case WRITER_IDLE:
                      eventType = "写空闲";
                      break;
                  case ALL_IDLE:
                      eventType = "读写空闲";
                      break;
              }
              System.out.println(ctx.channel().remoteAddress() + "--超时时间--" + eventType);
              System.out.println("服务器做相应处理..");
  
              //如果发生空闲，我们关闭通道
             // ctx.channel().close();
          }
      }
  }
  

• YzxServer

  public class YzxServer {
      public static void main(String[] args) throws Exception{
  
  
          //创建两个线程组
          EventLoopGroup bossGroup = new NioEventLoopGroup(1);
          EventLoopGroup workerGroup = new NioEventLoopGroup(); //8个NioEventLoop
          try {
  
              ServerBootstrap serverBootstrap = new ServerBootstrap();
  
              serverBootstrap.group(bossGroup, workerGroup);
              serverBootstrap.channel(NioServerSocketChannel.class);
              serverBootstrap.handler(new LoggingHandler(LogLevel.INFO));
              serverBootstrap.childHandler(new ChannelInitializer() {
  
                  @Override
                  protected void initChannel(SocketChannel ch) throws Exception {
                      ChannelPipeline pipeline = ch.pipeline();
  					//TODO 加入其他handler
  					
  					//加入IdleStateHandler
                      pipeline.addLast(new IdleStateHandler(7000,7000,10, TimeUnit.SECONDS));
                      //加入一个对IdleStateHandler进一步处理的handler(自定义)
                      pipeline.addLast(new HeartbeatServerHandler());
                  }
              });
  
              //启动服务器
              ChannelFuture channelFuture = serverBootstrap.bind(7000).sync();
              channelFuture.channel().closeFuture().sync();
  
          }finally {
              bossGroup.shutdownGracefully();
              workerGroup.shutdownGracefully();
          }
      }
  }