Netty核心原理

Netty 是由 JBOSS 提供的一个 Java 开源框架。Netty 提供异步的、基于事件驱动的网络应用程序框 架，用以快速开发高性能、高可靠性的网络 IO 程序。 Netty 是一个基于 NIO 的网络编程框架，使用 Netty 可以帮助你快速、简单的开发出一 个网络应用，相当于简化和流程化了 NIO 的开发过程。 作为 当前最流行的 NIO 框架，Netty 在互联网领域、大数据分布式计算领域、游戏行业、 通信行业等获得了 广泛的应用，知名的 Elasticsearch 、Dubbo 框架内部都采用了 Netty。

Netty 的强大之处：零拷贝、可拓展事件模型；支持 TCP、UDP、HTTP、 WebSocket 等协议；提供安全传输、压缩、大文件传输、编解码支持等等

具备如下优点:
1. 设计优雅，提供阻塞和非阻塞的 Socket；提供灵活可拓展的事件模型；提供高度可定制的线程模 型。
2. 具备更高的性能和更大的吞吐量，使用零拷贝技术最小化不必要的内存复制，减少资源的消耗。
3. 提供安全传输特性。
4. 支持多种主流协议；预置多种编解码功能，支持用户开发私有协议

线程模型

线程模型基本介绍

不同的线程模式，对程序的性能有很大影响，在学习Netty线程模式之前，首先讲解下 各个线程模 式， 最后看看 Netty 线程模型有什么优越性.目前存在的线程模型有：
1、传统阻塞 I/O 服务模型
2、Reactor 模型
根据 Reactor 的数量和处理资源池线程的数量不同，有 3 种典型的实现
1. 单 Reactor 单线程
2. 单 Reactor 多线程
3. 主从 Reactor 多线程

Netty线程模型

Netty 的设计主要基于主从 Reactor 多线程模式，并做了一定的改进

详细版Netty模型

1、Netty 抽象出两组线程池：BossGroup 和 WorkerGroup，也可以叫做 BossNioEventLoopGroup 和 WorkerNioEventLoopGroup。每个线程池中都有 NioEventLoop 线程。BossGroup 中的线程专门负责和客户端建立连接，WorkerGroup 中的 线程专门负责处理连接上的读写。BossGroup 和 WorkerGroup 的类型都是 NioEventLoopGroup
2、NioEventLoopGroup 相当于一个事件循环组，这个组中含有多个事件循环，每个事件循环就 是一个 NioEventLoop
3、NioEventLoop 表示一个不断循环的执行事件处理的线程，每个 NioEventLoop 都包含一个 Selector，用于监听注册在其上的 Socket 网络连接（Channel）
4、NioEventLoopGroup 可以含有多个线程，即可以含有多个 NioEventLoop

每个 BossNioEventLoop 中循环执行以下三个步骤
1、select：轮训注册在其上的 ServerSocketChannel 的 accept 事件（OP_ACCEPT 事件）
2、processSelectedKeys：处理 accept 事件，与客户端建立连接，生成一个 NioSocketChannel，并将其注册到某
个 WorkerNioEventLoop 上的 Selector 上
3、runAllTasks：再去以此循环处理任务队列中的其他任务

每个 WorkerNioEventLoop 中循环执行以下三个步骤
1、select：轮训注册在其上的 NioSocketChannel 的 read/write 事件 （OP_READ/OP_WRITE 事件）
2、processSelectedKeys：在对应的 NioSocketChannel 上处理 read/write 事件
3、runAllTasks：再去以此循环处理任务队列中的其他任务

在以上两个processSelectedKeys步骤中，会使用 Pipeline（管道），Pipeline 中引用了 Channel，即通过 Pipeline 可以获取到对应的 Channel，Pipeline 中维护了很多的处理器 （拦截处理器、过滤处理器、自定义处理器等）。

核心API介绍

ChannelHandler及其实现类

ChannelHandler 接口定义了许多事件处理的方法，可以通过重写这些方法去实现具体的业务逻辑。
API 关系如下图所示

Netty开发中需要自定义一个 Handler 类去实现 ChannelHandle接口或其子接口或其实现类，然后 通过重写相应方法实现业务逻辑，我们接下来看看一般都需要重写哪些方法

public void channelActive(ChannelHandlerContext ctx)//通道就绪事件 
public void channelRead(ChannelHandlerContext ctx, Object msg)//通道读取数据事件 
public void channelReadComplete(ChannelHandlerContext ctx) //数据读取完毕事件 
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause)//通道发生异常事 件

ChannelPipeline

ChannelPipeline 是一个 Handler 的集合（很多Handler 在一起称为ChannelPipeline ），它负责处理和拦截 inbound(消息入站) 或者 outbound(消息出站) 的事件和 操作，相当于一个贯穿 Netty 的责任链

如果客户端和服务器的Handler是一样的，消息从客户端到服务端或者反过来，每个Inbound类型 或Outbound类型的Handler只会经过一次，混合类型的Handler（实现了Inbound和Outbound的 Handler）会经过两次。准确的说ChannelPipeline中是一个ChannelHandlerContext,每个上下文对象 中有ChannelHandler. InboundHandler是按照Pipleline的加载顺序的顺序执行, OutboundHandler 是按照Pipeline的加载顺序，逆序执行
入站按：顺序找处理器（越在左边越先找到）
出站按：逆序找处理器（越在右边越先找到）

ChannelHandlerContext

这 是 事 件 处 理 器 上 下 文 对 象 ， Pipeline 链 中 的 实 际 处 理 节 点 。 每 个 处 理 节 点 ChannelHandlerContext 中 包 含 一 个 具 体 的 事 件 处 理 器 ChannelHandler ,同时 ChannelHandlerContext 中也绑定了对应的 ChannelPipeline和 Channel 的信息，方便对 ChannelHandler 进行调用。
常用方法如下所示：

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

ChannelOption

Netty 在创建 Channel 实例后,一般都需要设置 ChannelOption 参数。ChannelOption 是 Socket 的标 准参数，而非 Netty 独创的。常用的参数配置有：

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

ChannelOption.SO_KEEPALIVE
一直保持连接活动状态。该参数用于设置TCP连接，当设置该选 项以后，连接会测试链接的状态，这个选项用于可能长时间没有数据交流的连接。当设置该选项以 后，如果在两小时内没有数据的通信时，TCP会自动发送一个活动探测数据报文。

ChannelFuture

表示 Channel 中异步 I/O 操作的结果，在 Netty 中所有的 I/O 操作都是异步的，I/O 的调用会直接返回，调用者并不能立刻获得结果，但是可以通过 ChannelFuture 来获取 I/O 操作 的处理状态。

常用方法如下所示：

Channel channel()  //返回当前正在进行 IO 操作的通道
ChannelFuture sync()  //等待异步操作执行完毕,将异步改为同步

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 选择其中一个 EventLoopGroup 来将这个 SocketChannel 注 册到其维护的 Selector 并对其后续的 IO 事件进行处理。
一般情况下我们都是用实现类NioEventLoopGroup. 常用方法如下所示：

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

ServerBootstrap和Bootstrap

ServerBootstrap 是 Netty 中的服务器端启动助手，通过它可以完成服务器端的各种配置；
Bootstrap 是 Netty 中的客户端启动助手，通过它可以完成客户端的各种配置。
常用方法如下 所示：

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

Unpooled类

这是 Netty 提供的一个专门用来操作缓冲区的工具类，常用方法如下所示：

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

Netty入门案例

1、导入Netty的maven坐标

Netty 是由 JBOSS 提供的一个 Java 开源框架,所以在使用得时候首先得导入Netty的maven坐标

<dependency>
    <groupId>io.netty</groupId>
    <artifactId>netty-all</artifactId>
    <version>4.1.42.Final</version>
</dependency>

2、Netty服务端编写

服务端实现步骤:
1. 创建bossGroup线程组: 处理网络事件—连接事件
2. 创建workerGroup线程组: 处理网络事件—读写事件
3. 创建服务端启动助手
4. 设置bossGroup线程组和workerGroup线程组
5. 设置服务端通道实现为NIO
6. 通道参数设置
7. 创建一个通道初始化对象
8. 向pipeline中添加自定义业务处理handler
9. 启动服务端并绑定端口,同时将异步改为同步 （只有在同步时，确认连接成功才有意义）
10. 关闭通道和关闭连接池

public class NettyServer {
    public static void main(String[] args) throws InterruptedException {
        //1. 创建bossGroup线程组: 处理网络事件--连接事件 (如果不写默认就是 2*处理器线程数)
        // 一般设置1个就OK了，因为处理连接事件的
        EventLoopGroup bossGroup = new NioEventLoopGroup(1);
        //2. 创建workerGroup线程组: 处理网络事件--读写事件 2*处理器线程数
        EventLoopGroup workerGroup = new NioEventLoopGroup();
        //3. 创建服务端启动助手
        ServerBootstrap serverBootstrap = new ServerBootstrap();
        //4. 给启动助手 设置bossGroup线程组和workerGroup线程组
        serverBootstrap.group(bossGroup, workerGroup) // 因为支持链式变成所以设置后续的实现
                .channel(NioServerSocketChannel.class) //5. 设置服务端通道实现为NIO
                .option(ChannelOption.SO_BACKLOG, 128)//6. 参数设置（针对于bossGroup设置连接等待的个数）
                .childOption(ChannelOption.SO_KEEPALIVE, Boolean.TRUE)//6. 参数设置（设置通道的活跃状态）
                .childHandler(new ChannelInitializer<SocketChannel>() { //7. 创建一个通道初始化对象
                  // 不能直接添加，而是借助通道初始化对象来添加
                    @Override
                    protected void initChannel(SocketChannel ch) throws Exception { // 7.创建一个通道初始化对象
                        //8. 向pipeline中添加自定义业务处理handler
                        ch.pipeline().addLast(new NettyServerHandler());
                    }
                });
        //9. 启动服务端并绑定端口,同时将异步改为同步
        ChannelFuture future = serverBootstrap.bind(9999).sync();

        System.out.println("服务端启动成功.");
        //10. 关闭通道(并不是真正意义上关闭,而是监听通道关闭的状态)和关闭连接池
        future.channel().closeFuture().sync();
        // 关闭连接池// 当监听到关闭的时候才会去触发真正的关闭，才往下走
        bossGroup.shutdownGracefully();
        workerGroup.shutdownGracefully();
    }
}

自定义服务端handle

继承ChannelInboundHandler实现消息进站

public class NettyServerHandler implements ChannelInboundHandler {

    /**
     * 通道读取事件
     * @param ctx
     * @param msg  就是客户端发给服务端的消息
     * @throws Exception
     */
    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
        // netty 中的ByteBuf 和nio 的buffer
        ByteBuf byteBuf = (ByteBuf) msg;
        System.out.println("客户端发送过来的消息:" + byteBuf.toString(CharsetUtil.UTF_8));
    }


    /**
     * 通道读取完毕事件(要给客户端一个响应)
     * @param ctx 通过上下文的writeAndFlush进行响应，来对客户端进行发数据，不用出站处理
     * @throws Exception
     */
    @Override
    public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
        ctx.writeAndFlush(Unpooled.copiedBuffer("你好.我是Netty服务端",
                CharsetUtil.UTF_8));//消息出站
    }

    /**
     * 通道异常事件（如果抛出异常，就会跳到这个方法里面）
     * @param ctx
     * @param cause 将线程打印出来，然后再将上下文关闭
     * @throws Exception
     */
    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
        cause.printStackTrace();
        ctx.close();
    }

    @Override
    public void channelRegistered(ChannelHandlerContext ctx) throws Exception {

    }

    @Override
    public void channelUnregistered(ChannelHandlerContext ctx) throws Exception {

    }

    @Override
    public void channelActive(ChannelHandlerContext ctx) throws Exception {

    }

    @Override
    public void channelInactive(ChannelHandlerContext ctx) throws Exception {

    }


    @Override
    public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception {

    }

    @Override
    public void channelWritabilityChanged(ChannelHandlerContext ctx) throws Exception {

    }

    @Override
    public void handlerAdded(ChannelHandlerContext ctx) throws Exception {

    }

    @Override
    public void handlerRemoved(ChannelHandlerContext ctx) throws Exception {

    }
}

3、Netty客户端编写

客户端实现步骤:
1. 创建线程组
2. 创建客户端启动助手
3. 设置线程组
4. 设置客户端通道实现为NIO
5. 创建一个通道初始化对象
6. 向pipeline中添加自定义业务处理handler
7. 启动客户端,等待连接服务端,同时将异步改为同步
8. 关闭通道和关闭连接池

public class NettyClient {
    public static void main(String[] args) throws InterruptedException {
        //1. 创建线程组
        EventLoopGroup group = new NioEventLoopGroup();
        //2. 创建客户端启动助手
        Bootstrap bootstrap = new Bootstrap();
        //3. 设置线程组
        bootstrap.group(group)
                .channel(NioSocketChannel.class)//4. 设置客户端通道实现为NIO
                .handler(new ChannelInitializer<SocketChannel>() { //5. 创建一个通道初始化对象
                    @Override
                    protected void initChannel(SocketChannel ch) throws Exception {
                        //6. 向pipeline中添加自定义业务处理handler
                        ch.pipeline().addLast(new NettyClientHandler());
                    }
                });
        //7. 启动客户端,等待连接服务端,同时将异步改为同步
        ChannelFuture channelFuture = bootstrap.connect("127.0.0.1", 9999).sync();
        //8. 关闭通道和关闭连接池
        channelFuture.channel().closeFuture().sync();
        group.shutdownGracefully();
    }
}

自定义客户端handle

public class NettyClientHandler implements ChannelInboundHandler {

    /**
     * 通道就绪事件
     *
     * @param ctx
     * @throws Exception
     */
    @Override
    public void channelActive(ChannelHandlerContext ctx) throws Exception {
        ctx.writeAndFlush(Unpooled.copiedBuffer("你好呀.我是Netty客户端",
                CharsetUtil.UTF_8)); 
    }

    /**
     * 通道读就绪事件
     *
     * @param ctx
     * @param msg
     * @throws Exception
     */
    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
        ByteBuf byteBuf = (ByteBuf) msg;
        System.out.println("服务端发送的消息:" + byteBuf.toString(CharsetUtil.UTF_8));
    }


    @Override
    public void channelRegistered(ChannelHandlerContext ctx) throws Exception {

    }

    @Override
    public void channelUnregistered(ChannelHandlerContext ctx) throws Exception {

    }


    @Override
    public void channelInactive(ChannelHandlerContext ctx) throws Exception {

    }


    @Override
    public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {

    }

    @Override
    public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception {

    }

    @Override
    public void channelWritabilityChanged(ChannelHandlerContext ctx) throws Exception {

    }

    @Override
    public void handlerAdded(ChannelHandlerContext ctx) throws Exception {

    }

    @Override
    public void handlerRemoved(ChannelHandlerContext ctx) throws Exception {

    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {

    }
}

Netty异步模型

异步的概念和同步相对。当一个异步过程调用发出后，调用者不能立刻得到结果。实际处理这个调 用的组件在完成后，通过状态、通知和回调来通知调用者

Netty 中的 I/O 操作都是异步的，包括 Bind、Write、Connect 等操作会简单的返回一个 ChannelFuture。调用者并不能立刻获得结果，而是通过 Future-Listener 机制，用户可以方便的主动获 取或者通过通知机制获得IO 操作结果. Netty 的异步模型是建立在 future 和 callback 的之上的。 callback 就是回调。重点说 Future，它的核心思想是：假设一个方法 fun，计算过程可能非常耗时，等 待 fun 返回显然不合适。那么可以在调用 fun 的时候，立马返回一个 Future，后续可以通过 Future 去 监控方法 fun 的处理过程(即 ： Future-Listener 机制)

Future

表示异步的执行结果, 可以通过它提供的方法来检测执行是否完成，ChannelFuture 是他的一 个子接口. ChannelFuture 是一个接口 ,可以添加监听器，当监听的事件发生时，就会通知到监听器

当 Future 对象刚刚创建时，处于非完成状态，调用者可以通过返回的 ChannelFuture 来获取 操作执行的状态， 注册监听函数来执行完成后的操作。

常用方法有:
sync 方法, 阻塞等待程序结果反回
isDone 方法来判断当前操作是否完成；
isSuccess 方法来判断已完成的当前操作是否成功；
getCause 方法来获取已完成的当前操作失败的原因；
isCancelled 方法来判断已完成的当前操作是否被取消；
addListener 方法来添加注册监听器，当操作已完成(isDone 方法返回完成)，将会通知指定的监听器；如果Future 对象已完成，则通知指定的监听器

Future-Listener 机制

给Future添加监听器,监听操作结果

服务端添监听器

//9. 启动服务端并绑定端口,同时将异步改为同步
        ChannelFuture future = serverBootstrap.bind(9999);
        //通过future的addListener添加监听器， 开启一个ChannelFutureListener
        future.addListener(new ChannelFutureListener() {
            @Override
            public void operationComplete(ChannelFuture future) throws Exception {
                // 通过方法去判断
                if (future.isSuccess()) {
                    System.out.println("端口绑定成功!");
                } else {
                    System.out.println("端口绑定失败!");
                }
            }
        });

客户端的消息也可以添加监听器

 /**
     * 通道就绪事件
     *
     * @param ctx
     * @throws Exception
     */
    @Override
    public void channelActive(ChannelHandlerContext ctx) throws Exception {
        ChannelFuture future = ctx.writeAndFlush(Unpooled.copiedBuffer("你好呀.我是Netty客户端",
                CharsetUtil.UTF_8));
        future.addListener(new ChannelFutureListener() {
            @Override
            public void operationComplete(ChannelFuture future) throws Exception {
                if (future.isSuccess()) {
                    System.out.println("数据发送成功!");
                } else {
                    System.out.println("数据发送失败!");
                }
            }
        });
    }