Netty10——Netty核心组件

一、Bootstrap、ServerBootstrap

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

// 该方法是在 ServerBootstrap 中定义的，用于服务器端，用来设置两个 EventLoopGroup，这两个 Group 中的线程分别用于接收客户端连接和用于处理客户端发送的数据
public ServerBootstrap group(EventLoopGroup parentGroup, EventLoopGroup childGroup);
// 该方法通常用于客户端，用来设置一个 EventLoopGroup 以处理服务端发送的数据，这里的返回值 B 是泛型类，且是 AbstractBootstrap 的子类，通常就是 Bootstrap，我们也可以自己继承和重写 AbstractBootstrap，但该方法并不是 Bootstrap 特有的，而是在 AbstractBootstrap 中定义的，对于服务端来说使用上面的 group() 还是这个取决于是否将处理客户端连接的操作使用单独的线程池组处理
public B group(EventLoopGroup group);
// 该方法用来设置通道的实现或者说类型，我们也可以自定义通道类型，是一个通用方法，但服务端和客户端的 SocketChannel 类型不同
public B channel(Class<? extends C> channelClass);
// 对于服务端是用来给 BossGroup 中的通道添加配置，对于客户端则是给 WorkerGroup 中的通道添加配置
public <T> B option(ChannelOption<T> option, T value);
// 该方法只在 ServerBootstrap 中有，Bootstrap 中没有，因为只有 ServerBootstrap 有 BossGroup，该方法是在 ServerBootstrap 有 BossGroup 时用来给 WorkerGroup 中的通道添加配置
public <T> ServerBootstrap childOption(ChannelOption<T> childOption, T value);
// 该方法用来给通道设置或者添加业务处理类，如自定义的 handler，在 ServerBootstrap 中和 BootStrap 中都有，是定义在父类 AbstractBootstrap 中的
public B handler(ChannelHandler handler);
// 该方法只在 ServerBootstrap 中有
public ServerBootstrap childHandler(ChannelHandler childHandler);
// 该方法通常用于服务器端，用来设置监听的端口号
public ChannelFuture bind(int inetPort);
// 该方法用于客户端，用来连接服务器端，是 Bootstrap 特有的方法
public ChannelFuture connect(String inetHost, int inetPort);

 注：
  ①ServerBootstrap 中有两个group()方法，对于服务端来说，可以将处理客户端连接的操作交由一个单独的线程池组(前面提到的 BossGroup)处理，但并非一定如此，也可以将处理客户端连接的操作和处理业务数据的操作一起交给同一个线程池组(WorkerGroup)处理
  ②ServerBootstrap 和 Bootstrap 都有channel()方法，但该方法的入参类型对于二者是不同的，通常 ServerBootstrap 对应 NioServerSocketChannel，BootStrap 对应 NioSocketChannel
  ③相对于 BootStrap，ServerBootStrap 中多了一些以 child 开头的方法，比如 childOption() 和 childHandler() 等，这是因为通常服务端会有两个线程池组，这些方法是为服务端中的 WorkerGroup 线程池组中的 Channel 提供的，因为 WorkerGroup 线程池组中的通道是通过 BossGroup 产生的，因此前缀为 child，如 childOption() 是为 WorkerGroup 中的 Channel 设置参数，childHandler() 是为 WorkerGroup 中的 Channel 设置或添加处理器 Handler 等，而服务端中非以 child 开头的方法如 option() 和 handler() 则是为 BossGroup 中的 Channel 提供的，简单地说就是这两类方法的作用对象不同；但是如果 ServerBootStrap 只有一个线程池组(WorkerGroup)，则起作用的就只有那些非以 child 开头的方法，这一点要特别注意

二、Future、ChannelFuture

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

Channel channel();// 返回当前正在进行 IO 操作的通道
ChannelFuture sync();// 等待异步操作执行完毕
Future addListener();// 注册监听

三、Channel

 Channel 是 Netty 网络通信的组件，能够用于执行网络 I/O 操作。通过 Channel 可获得当前网络连接的状态和网络连接的配置参数(例如接收缓冲区大小)等。Channel 提供异步的网络 I/O 操作(如建立连接，读写，绑定端口)，异步调用意味着任何 I/O 调用都将立即返回，并且不保证在调用结束时所请求的 I/O 操作已完成；调用立即返回的是一个 ChannelFuture 实例，可以注册监听器到 ChannelFuture 上，这样在 I/O 操作成功、失败或取消时会通过回调来通知调用方，支持关联 I/O 操作与对应的处理程序。不同协议、不同的阻塞类型的连接都有不同的 Channel 类型与之对应，常用的 Channel 类型如下：
  ①NioSocketChannel：异步的客户端 TCP Socket 连接
  ②NioServerSocketChannel：异步的服务器端 TCP Socket 连接
  ③NioDatagramChannel：异步的 UDP 连接
  ④NioSctpChannel：异步的客户端 Sctp 连接，参看SCTP详解
  ⑤NioSctpServerChannel：异步的 Sctp 服务器端连接

四、Selector

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

五、ChannelHandler 及其实现类

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

 这些子类的用法：
  ①ChannelInboundHandler 用于处理入站 I/O 事件；
  ②ChannelOutboundHandler 用于处理出站 I/O 操作；
  ③ChannelInboundHandlerAdapter 用于处理入站 I/O 事件；
  ④ChannelOutboundHandlerAdapter 用于处理出站 I/O 操作；
  ⑤ChannelDuplexHandler 用于处理入站和出站事件；
 我们经常需要自定义一 个 Handler 类去继承 ChannelInboundHandlerAdapter，然后通过重写相应方法实现业务逻辑， 一般需要重写的方法如下：

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();
    }
}

 ChannelInboundHandlerAdapter 中的事件方法触发的时机大致如下：

// 通道注册时调用
public void channelRegistered(ChannelHandlerContext ctx) throws Exception;
// 通道取消注册时调用，通常在channelInactive调用之后
public void channelUnregistered(ChannelHandlerContext ctx) throws Exception;
// 通道注册成功之后变为活跃状态时调用
public void channelActive(ChannelHandlerContext ctx) throws Exception;
// 通道处于非活跃状态时调用：如断开连接等
public void channelInactive(ChannelHandlerContext ctx) throws Exception;
// 通道中有可读数据时调用，通常会重写该方法进行业务处理
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception;
// 通道中的数据读取完毕之后调用
public void channelReadComplete(ChannelHandlerContext ctx) throws Exception;
// 有用户事件发生时调用
public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception;
// 通道变为可写状态时调用
public void channelWritabilityChanged(ChannelHandlerContext ctx) throws Exception;
// 异常时回调
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception;

 通常我们会在通道注册成功后将通道缓存起来，然后利用缓存的通道接收和发送消息。
 ChannelInboundHandlerAdapter 还有个抽象子类 SimpleChannelInboundHandler<I>，开发时继承 SimpleChannelInboundHandler<I> 更简便：重写

class NettyHttpServerHandler extends SimpleChannelInboundHandler<HttpObject> {

    @Override
    protected void channelRead0(ChannelHandlerContext ctx, HttpObject msg) throws Exception {
        if (msg instanceof HttpRequest) {// 判断是否为HttpRequest请求
            HttpRequest httpRequest = (HttpRequest) msg;
            // 获取请求头，可用于获取和校验token等
            HttpHeaders headers = httpRequest.headers();
            // 如果想获取请求参数等可将HttpRequest强转为FullHttpRequest，但仍需要自己封装
            FullHttpRequest fullHttpRequest = (FullHttpRequest) httpRequest;
            URI uri = new URI(httpRequest.uri());
            if ("/favicon.ico".equals(uri.getPath())) {
                System.out.println("请求 favicon.ico，不做响应");
                return;
            }
            // 构造响应
            ByteBuf content = Unpooled.copiedBuffer("Hello,我是服务器...", CharsetUtil.UTF_8);
            FullHttpResponse response = new DefaultFullHttpResponse(HttpVersion.HTTP_1_1, HttpResponseStatus.OK);
            response.headers().set(HttpHeaderNames.CONTENT_TYPE, "text/plain");
            response.headers().set(HttpHeaderNames.CONTENT_LENGTH, content.readableBytes());
            ctx.writeAndFlush(response);
        }
    }
}

六、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，两种类型的 handler 互不干扰。
 常用方法：

// 把一个或多个业务处理类（handler） 添加到链中的开始位置
ChannelPipeline addFirst(ChannelHandler... handlers);
// 把一个或多个业务处理类（handler） 添加到链中的末尾位置
ChannelPipeline addLast(ChannelHandler... handlers);

七、ChannelHandlerContext

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

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

八、ChannelOption

 Netty 在创建 Channel 实例后，一般都需要设置 ChannelOption 参数。ChannelOption 参数如下：
 ChannelOption.SO_BACKLOG：对应 TCP/IP 协议 listen 函数中的 backlog 参数，用来初始化服务器可连接队列大小。服务端处理客户端连接请求是顺序处理的，所以同一时间只能处理一个客户端连接。多个客户端来的时候，服务端将不能处理的客户端连接请求放在队列中等待处理，backlog 参数指定了队列的大小
 ChannelOption.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 处理，如下图所示：

 BossEventLoopGroup 通常是一个单线程的 EventLoop，EventLoop 维护着一个注册了 ServerSocketChannel 的 Selector 实例。BossEventLoop 不断轮询 Selector 将连接事件分离出来，连接事件通常是 OP_ACCEPT 事件，然后将接收到的 SocketChannel 交给 WorkerEventLoopGroup；WorkerEventLoopGroup 会由 next 选择其中一个 EventLoop 来将这个 SocketChannel 注册到其维护的 Selector 并对其后续的 IO 事件进行处理。
 常用方法：

// 构造方法
public NioEventLoopGroup(); 
// 断开连接，关闭线程
public Future<?> shutdownGracefully();

十、Unpooled

 Unpooled 是 Netty 提供的一个专门用来操作缓冲区(即Netty的数据容器)的工具类， 常用方法如下：

// 通过给定的数据和字符编码返回一个 ByteBuf 对象（类似于 NIO 中的 ByteBuffer 但有区别） 
public static ByteBuf copiedBuffer(CharSequence string, Charset charset);

 ByteBuf 通过两个 position(readerIndex 和 writerIndex) 将缓冲区分成了三段，一段是已经读过的(可忽略的)区域(0 - readerIndex)，一段是可读的区域(readerIndex - writerIndex)，还有一段是可写的区域(writerIndex - capacity)，这样就不必使用 flip() 方法进行读写转换。
 示例1：

public class NettyByteBuf {
    public static void main(String[] args) {
        // 创建一个ByteBuf,该对象包含一个数组,是一个 byte[10]
        ByteBuf buffer = Unpooled.buffer(10);
        for (int i = 0; i < 10; i++) {
            buffer.writeByte(i);
        }
        // 10
        System.out.println("capacity=" + buffer.capacity());
        // 输出
        for (int i = 0; i < 5; i++) {
            // 0 1 2 3 4
            System.out.println(buffer.readByte());
        }
        for (int i = 0; i < 5; i++) {
            // 5 6 7 8 9
            System.out.println(buffer.readByte());
        }
        for (int i = 0; i < buffer.capacity(); i++) {
            // 0 1 2 3 4 5 6 7 8 9
            System.out.println(buffer.getByte(i));
        }
        System.out.println("执行完毕");
    }
}

 根据示例的输出结果可以看出来：ByteBuf 通过 readerIndex 将已经写入的数据分成了两部分，一部分是未读取的，一部分是可读取的。ByteBuf 中的数据可以通过 getByte(index) 重复读取。
 示例2：

public class NettyByteBuf {

    public static void main(String[] args) {
        ByteBuf byteBuf = Unpooled.copiedBuffer("hello,world!", Charset.forName("utf-8"));
        if (byteBuf.hasArray()) {
            byte[] content = byteBuf.array();
            System.out.println(new String(content, Charset.forName("utf-8")));
//            System.out.println("byteBuf=" + byteBuf);
            System.out.println(byteBuf.arrayOffset());// 0
            System.out.println(byteBuf.readerIndex());//0,因为还没开始读
            System.out.println(byteBuf.writerIndex());//12,因为已经写了12个字符,可写的下一个索引位置为12
            System.out.println(byteBuf.capacity());// 64,和操作系统有关

            System.out.println(byteBuf.getByte(0));//104
            System.out.println(byteBuf.readByte());// 104,h的ascii码
            int len = byteBuf.readableBytes();// 可读的字节数,因为上面调用了readByte()已经读取了 1 位
            System.out.println("len=" + len);// 11
            for (int i = 0; i < len; i++) {
                // hello,world
                System.out.print((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")));
        }
    }
}

 注意调用 readByte() 会使 readerIndex 移动，而调用 getByte(index) 则不会。