Netty 常用Api简单梳理

Bootstrap，ServerBootStrap

1.引导

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

2.常见的方法有:

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

Future，ChannelFuture

1.引导

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

2.常见方法:

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

Channel

1.Netty网络通信的组件，能够执行网络IO操作
2.通过Channel 可获得当前网络连接的通道的状态
3.通过Channel 可获得网络连接的配置参数
4.Channel 提供异步的网络IO操作（如建立连接，读写，绑定端口），异步调用意味着任何IO调用都将立即返回，并且不保证在调用结束时所请求的IO操作都已完成
5.调用立即返回一个ChannelFuture实例，通过注册监听器到ChannelFuture上，可以IO操作成功，失败或取消时回调通知调用方
6.支持关联IO操作与对应的处理程序
7.不同协议，不同的阻塞类型的连接都有不同的Channel 类型与之对应
常用的Channel类型：
NioSocketChannel 异步客户端 TCP Socket连接
NioServerScoketChannel 异步的服务器端TCP Socket连接。
NioDataGramChannel 异步的UDP连接
NioSctpChannel 异步的客户端Sctp连接
NioSctpServerChannel 异步的Sctp服务器端连接，这些通道涵盖了UDP和TCP网络IO以及文件IO

Selector

1.Netty基于Selector对象实现IO多路复用，通过Selector一个线程可以监听多个连接的Channel事件
2.当向一个Selector中注册Channel后，Selector内部的机制就可以自动不断的查询（Select）这些注册的Channel是否有已就绪的IO时间，这样程序就可以很简单地使用一个线程高效的管理多个Channel

ChannelHandler以及实现类

1.是一个接口，处理IO事件或者拦截IO操作，并将其转发到其ChannelPipeline中的下一个处理程序
2.ChannelHandler 本身并没有提供很多方法，因为这个接口有许多的方法需要实现，方便使用期间，可以继承它的子类
3.ChannelHandler 及其实现类的图

ChannelInboundHandler 用于处理入站IO事件
ChannelOutboundHandler 处理出站的IO操作
适配器:
ChannelInboundHandlerAdapter 用于处理入站IO事件.
ChannelOutboundHandlerAdapter 用于处理出站IO操作.
ChannelDuplexHandler 用于处理入站和出站事件.
ChannelPipeline 提供了ChannelHandler链的容器，以客户端应用程序为例，如果事件的运动方向是从客户端到服务端的，那么我们称这些事件为出站的，即客户端发送给服务器的数据会通过pipeline中的一系列ChannelOutboundHandler，并被这些Handler处理，反之则成为入站
4.我们经常需要自定义handler类取继承 ChannelInboundHandlerAdapter，然后通过重写相应的方法实现业务逻辑，我们接下来看看一般都需要重写哪些方法:
channelActive 通道就绪事件
channelRead 通道读取事件
channelReadComplete 数据读取完毕事件.

Pipeline 和 ChannelPipeline

ChannelPipeline是一个重点:
1.ChannelPipeline 是一个handler的集合，它负责处理和拦截 inbound 或者outbound 的时间和操作，相当于一个贯穿netty的链。
2. ChannelPipeline 实现了一种高级形式的拦截过滤器模式，使用户可以完全控制事件的处理方式，以及Channel中各个的 ChannelHandler如何相互交互。
3. 在netty中，每个Channel都有且仅有一个ChannelPipeline 与之对应，它们的组成关系如下:
一个Channel包含了一个Channelpipeline，而Channnel中维护了一个由ChannelHandlerContext组成的双向链表，并且每个ChannelHandlerContext中又关联着一个ChannelHandler。
入站事件和出站事件在一个双向链表中，入站事件会从链表head往后传递到最后一个入站的handler，出站事件会从链表tail往前传递到最前一个出站的handler，两种类型的handler互不干扰。
关系图如下:

4.常用方法:
ChannelPipeline addFirst（ChannelHandler…handlers），把一个业务处理类添加到链中的第一个位置。
addLast（ChannelHandler…handlers）,把一个业务处理类添加到链中的最后一个位置。

ChannelHandlerContext

1.保存Channel相关的所有上下文信息，同时关联一个Channel对象
2.即ChannelHandlerContext 中包含一个具体的事件处理器 ChannelHandler，同时 ChannelHandlerContextv中也绑定了对应的 pipeline 和 channel信息，方便对 channelHandler 进行调用
3. 常用方法
ChannelFuture close（） 关闭通道
==ChannelOutboundInvoker flush（）==刷新
==ChannelFuture writeAndFlush() ==将数据写到ChannelPipeline中当前ChannelHandler 的下一个ChannelHandler 开始处理(出站)

ChannelOption

1.Netty 在创建 Channel实例后，一般都需要设置ChannelOption参数
ChannelOption.SO_BACKLOG
对应TCP/IP歇息listen 函数中的backlog参数，用来初始化服务器可连接队列大小。服务端处理客户端连接请求是顺序处理的，所以同一时间只能处理一个客户端连接，多个客户端来的时候，服务端将不能处理的客户端连接请求放在队列中等待处理，backlog参数指定了队列的大小
ChannelOption.SO_KEEPALIVE
一直保持连接活动状态

EventLoopGroup 和其实现类NioEventLoopGroup

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

Unpooled类

1 . Netty 提供一个专门用来操作缓冲区(即Netty的数据容器)的工具类
2 . 常用方法如下：
==static ByteBuf copiedBuffer(CharSequence string, Charset charset) == 通过给定的数据和字符编码返回一个ByteBuf对象（类似于NIO中的ByteBuffer，但有区别）

ByteBuf ：

ByteBuf 里维护着readerIndex和writeIndex，当往byteBuf里添加数据的时候，writeIndex的值就会加一
当ByteBuf调用readByte方法时，readIndex的坐标会加一，一直加到与writeIndex一样位置(没有可读数据的时候)

package com.jym.buf;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;

/**
 * @program: NettyPro
 * @description:
 * @author: jym
 * @create: 2020/02/09
 */
public class JymNettyByteBuf01 {
    public static void main(String[] args) {
        // 创建一个ByteBuf
        // 1.创建 对象，该对象包含一个数组arr，是一个byte[10]
        // 2.在netty 的byteBuf 中，不需要使用flip进行翻转，因为底层维护了 readerIndex和writeIndex
        ByteBuf byteBuf = Unpooled.buffer(10);

        for(int i =0; i < 10; i++){
            byteBuf.writeByte(i);
        }
        System.out.println("capacity = " + byteBuf.capacity());
        // 输入
        for(int i =0; i < byteBuf.capacity(); i++){
            System.out.println(byteBuf.getByte(i));

//            System.out.println(byteBuf.readByte());
        }

    }
}

package com.jym.buf;

import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.util.CharsetUtil;

import java.nio.charset.Charset;

/**
 * @program: NettyPro
 * @description:
 * @author: jym
 * @create: 2020/02/09
 */
public class JymNettyByteBuf02 {
    public static void main(String[] args) {
        ByteBuf byteBuf = Unpooled.copiedBuffer("hello,world", CharsetUtil.UTF_8);
        // 使用相关的Api
        if(byteBuf.hasArray()){
            byte[] bytes = byteBuf.array();
            // 将bytes 转成字符串
            System.out.println(new String(bytes, Charset.forName("utf-8")));
            System.out.println(byteBuf.arrayOffset());
            System.out.println(byteBuf.readerIndex());
            System.out.println(byteBuf.writerIndex());
            System.out.println(byteBuf.capacity());
            System.out.println(byteBuf.readableBytes());
            // 从哪读，读取几个，字符集
            System.out.println(byteBuf.getCharSequence(0, 4, Charset.forName("utf-8")));
        }
    }
}

调用getByte方法时，readIndex不会增加1
创建 对象，该对象包含一个数组arr，是一个byte[10]。
在netty 的byteBuf 中，不需要使用flip进行翻转，因为底层维护了 readerIndex和writeIndex

学习年限不足，知识过浅，说的不对请见谅。

世界上有10种人，一种是懂二进制的，一种是不懂二进制的。