Netty

Serendipity900
791 阅读11分钟

一、Netty概述

Netty是一个异步事件驱动的网络应用程序框架，用于快速开发可维护的高性能协议服务器和客户端。

二、为什么使用Netty？

从官网上介绍，Netty是一个网络应用程序框架，开发服务端和客户端。也就是用于网络编程的一个框架。既然是网络框架，为什么不用NIO呢？

2.1 NIO的缺点

NIO的主要问题是：

  • NIO的类库和API繁杂，学习成本高，需要熟练掌握Selector、ServerSocketChannel、SocketChannel、ByteBuffer等。
  • 需要熟悉Java多线程编程。这是因为NIO编程涉及到Reactor模式，必须对多线程和网络编程非常熟悉，才能写出高质量的NIO程序。
  • 臭名昭著的epoll bug。它会导致Selector空轮询，最终导致CPU100%。直到JDK1.7版本依然没有得到根本性的解决。

2.2 Netty的优点

相对的，Netty的优点有很多：

  • API使用简单，学习成本低。
  • 功能强大，内置了多种解码编码器，支持多种协议。
  • 性能高，对比其它主流的NIO框架，Netty的性能最优。
  • 社区活跃，发现BUG会及时修复，版本迭代周期短，不断加入新的功能。
  • Dubbo、Elasticsearch都采用了Netty，质量得到验证。

三、架构图

上面这张图就是在官网首页的架构图，从上分析到下，绿色的部分Core核心模块，包括零拷贝、API库、可扩展的事件模型。橙色部分Protocol Support协议支持，包括Http协议、webSocket。SSL（安全套接字协议）、谷歌Protobuf协议、zlib/gzip压缩与解压缩、Large File Transfer大文件传输等等。红色部分Transport Services传输服务，包括Socket、Datagram、Http Tunnel等等。以上可以看出Netty的功能、协议、传输方式都比较全，比较强大。 

四、Netty的特性与重要组件

4.1 taskQueue任务队列

如果Handler处理器有一些长时间的业务处理，可以交给taskQueue异步处理。怎么用呢，请看代码演示：

public class MyServerHandler extends ChannelInboundHandlerAdapter {

    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
        //获取到线程池eventLoop，添加线程，执行
        ctx.channel().eventLoop().execute(new Runnable() {
            @Override
            public void run() {
                try {
                    //长时间操作，不至于长时间的业务操作导致Handler阻塞
                    Thread.sleep(1000);
                    System.out.println("长时间的业务处理");
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
        });
    }
}

打开一个debug调试，是可以看到添加进去的taskQueue有一个任务。

4.2 scheduleTaskQueue延时任务队列

延时任务队列和上面介绍的任务队列非常相似，只是多了一个可延迟一定时间再执行的设置，请看代码演示：

ctx.channel().eventLoop().schedule(new Runnable() {
    @Override
    public void run() {
        try {
            //长时间操作，不至于长时间的业务操作导致Handler阻塞
            Thread.sleep(1000);
            System.out.println("长时间的业务处理");
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
},5, TimeUnit.SECONDS);//5秒后执行

依然打开debug进行调试查看，可以看到有一个scheduleTaskQueue任务待执行中

4.3 Future异步机制

在搭建工程时，可以看到有一行这样的代码：

ChannelFuture channelFuture = bootstrap.connect("127.0.0.1", 6666);

 很多操作都返回这个ChannelFuture对象，究竟这个ChannelFuture对象是用来做什么的呢？

ChannelFuture提供操作完成时一种异步通知的方式。一般在Socket编程中，等待响应结果都是同步阻塞的，而Netty则不会造成阻塞，因为ChannelFuture是采用类似观察者模式的形式进行获取结果。请看一段代码演示：

//添加监听器
channelFuture.addListener(new ChannelFutureListener() {
    //使用匿名内部类，ChannelFutureListener接口
    //重写operationComplete方法
    @Override
    public void operationComplete(ChannelFuture future) throws Exception {
        //判断是否操作成功    
        if (future.isSuccess()) {
            System.out.println("连接成功");
        } else {
            System.out.println("连接失败");
        }
    }
});

3.4 Bootstrap和ServerBootstrap

Bootstrap和ServerBootstrap是Netty提供的一个创建客户端和服务端启动器的工厂类，使用这个工厂类非常便利地创建启动类，根据上面的一些例子，其实也能看得出来能大大地减少了开发的难度。首先看一个类图：

可以看出都是继承于AbstractBootstrap抽象类，所以大致上的配置方法都相同。

一般来说，使用Bootstrap创建启动器的步骤可以分为以下几步：

4.4.1 group()

服务端要使用两个线程组：

  • boosGroup用于监听客户端连接，专门负责与客户端创建连接，并把连接注册到workerGroup的Selector中。
  • workerGroup用于处理每一个连接发生的读写事件。

一般创建线程组直接使用以下new就可以了：

EventLoopGroup bossGroup = new NioEventLoopGroup();
EventLoopGroup workerGroup = new NioEventLoopGroup();

既然是线程组，那线程数默认是多少呢？深入源码：

//使用一个常量保存
    private static final int DEFAULT_EVENT_LOOP_THREADS;

    static {
        //NettyRuntime.availableProcessors() * 2，cpu核数的两倍赋值给常量
        DEFAULT_EVENT_LOOP_THREADS = Math.max(1, SystemPropertyUtil.getInt(
                "io.netty.eventLoopThreads", NettyRuntime.availableProcessors() * 2));

        if (logger.isDebugEnabled()) {
            logger.debug("-Dio.netty.eventLoopThreads: {}", DEFAULT_EVENT_LOOP_THREADS);
        }
    }
    
    protected MultithreadEventLoopGroup(int nThreads, Executor executor, Object... args) {
        //如果不传入，则使用常量的值，也就是cpu核数的两倍
        super(nThreads == 0 ? DEFAULT_EVENT_LOOP_THREADS : nThreads, executor, args);
    }

通过源码可以看到，默认的线程数是cpu核数的两倍。假设想自定义线程数，可以使用有参构造器：

//设置bossGroup线程数为1
EventLoopGroup bossGroup = new NioEventLoopGroup(1);
//设置workerGroup线程数为16
EventLoopGroup workerGroup = new NioEventLoopGroup(16);

4.4.2 channel()

这个方法用于设置通道类型，当建立连接后，会根据这个设置创建对应的channel实例。

使用debug模式可以看到：

通道类型有以下：

NioSocketChannel：异步非阻塞的客户端TCP Socket连接。

NioServerSocketChannel：异步非阻塞的服务端TCP Socket连接。

常用的就是这两个通道类型，因为是异步非阻塞的，所以是首选。

OioSocketChannel：同步阻塞的客户端TCP Socket连接。

OioServerSocketChannel：同步阻塞的服务端TCP Socket连接。

NioSctpChannel：异步的客户端Sctp（Stream Control Transmission Protocol，流控制传输协议）连接。

NioSctpServerChannel：异步的Sctp服务器端连接。

4.4.3 option()与childOption()

首先说一下这两个区别。

option()设置的是服务端用于接收进来的数据，也就是boosGroup线程。

childOption()是提供给父管道接收到的连接，也就是workerGroup线程。

搞清楚了之后，看一下常用的设置有哪些：

SocketChannel参数，也就是childOption()常用的参数：

SO_RCVBUF Socket参数，TCP数据接收缓冲区大小。

TCP_NODELAY TCP参数，立即发送数据，默认值为true。

SO_KEEPALIVE Socket参数，连接保活，默认值为false。启用该功能时，TCP会主动探测空闲连接的有效性。

ServerSocketChannel参数，也就是option()常用参数：

SO_BACKLOG Socket参数，服务端接受连接的队列长度，如果队列已满，客户端连接将被拒绝。默认值，Windows为200，其它为128.

4.4.4 设置流水线（重点）

ChannelPipeline是Netty处理请求的责任链，ChannelHandler则是具体处理请求的处理器。实际上每一个channel都有一个处理器的流水线。

在Bootstrap中childHandler()方法需要初始化通道，实例化一个ChannelInitializer，这时候需要重写initChannel()初始化通道的方法，装配流水线就是在这个地方进行。代码演示如下：

//使用匿名内部类的形式初始化通道对象
bootstrap.childHandler(new ChannelInitializer<SocketChannel>() {
    @Override
    protected void initChannel(SocketChannel socketChannel) throws Exception {
        //给pipeline管道设置自定义的处理器
        socketChannel.pipeline().addLast(new MyServerHandler());
    }
});

 处理器Handler主要分为两种：

ChannelInboundHandlerAdapter(入站处理器)、ChannelOutboundHandler(出站处理器)

入站指的是数据从底层java NIO Channel到Netty的Channel。

出站指的是通过Netty的Channel来操作底层的java NIO Channel。

ChannelInboundHandlerAdapter处理器常用的事件有：

1.注册事件 fireChannelRegistered。

2.连接建立事件 fireChannelActive。

3.读事件和读完成事件 fireChannelRead、fireChannelReadComplete。

4.异常通知事件 fireExceptionCaught。

5.用户自定义事件 fireUserEventTriggered。

6.Channel可写状态变化事件 fireChannelWritabilityChanged。

7.连接关闭事件 freeChannelInactive。

ChannelOutboundHandler处理器常用的事件有：

1.端口绑定 bind。

2.连接服务端 connect。

3.写事件 write。

4.刷新事件 flush。

5.读事件 read。

6.主动断开连接 disconnect。

7.关闭channel事件close。

4.4.5 bind()

提供用于服务端或者客户端绑定服务器地址和端口号，默认是异步启动。如果加上sync()方法则是同步。

4.4.6 优雅地关闭EventLoopGroup

//释放掉所有的资源，包括创建的线程
bossGroup.shutdownGracefully();
workerGroup.shutdownGracefully();

会关闭所有的childChannel。关闭之后，释放掉底层的资源。

4.5 Channel

Channel是一种连接到网络套接字或能进行读、写、连接和绑定等I/O操作的组件。

channel为用户提供：

1.通道当前的状态（例如它是打开？还是已连接？）

2.channel的配置参数（例如接收缓冲区的大小）

3.channel支持的IO操作（例如读、写、连接和绑定），以及处理与channel相关联的所有IO事件和请求的ChannelPipeline。

4.5.1 获取channel的状态

boolean isOpen(); //如果通道打开，则返回true
boolean isRegistered();//如果通道注册到EventLoop，则返回true
boolean isActive();//如果通道处于活动状态并且已连接，则返回true
boolean isWritable();//当且仅当I/O线程将立即执行请求的写入操作时，返回true。

以上就是获取channel的四种状态的方法。

4.5.2 获取channel的配置参数

获取单条配置信息，使用getOption()，代码演示：

ChannelConfig config = channel.config();//获取配置参数
//获取ChannelOption.SO_BACKLOG参数,
Integer soBackLogConfig = config.getOption(ChannelOption.SO_BACKLOG);
//因为我启动器配置的是128，所以我这里获取的soBackLogConfig=128

获取多条配置信息，使用getOptions()，代码演示：

ChannelConfig config = channel.config();
Map<ChannelOption<?>, Object> options = config.getOptions();
for (Map.Entry<ChannelOption<?>, Object> entry : options.entrySet()) {
    System.out.println(entry.getKey() + " : " + entry.getValue());
}
/**
SO_REUSEADDR : false
WRITE_BUFFER_LOW_WATER_MARK : 32768
WRITE_BUFFER_WATER_MARK : WriteBufferWaterMark(low: 32768, high: 65536)
SO_BACKLOG : 128
以下省略...
*/

4.5.3 channel支持的IO操作

写操作，这里演示从服务端写消息发送到客户端：

@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
    ctx.channel().writeAndFlush(Unpooled.copiedBuffer("这波啊，这波是肉蛋葱鸡~", CharsetUtil.UTF_8));
}

客户端控制台：

//收到服务端/127.0.0.1:6666的消息：这波啊，这波是肉蛋葱鸡~

连接操作channel获取ChannelPipeline，并做相关的处理：

//获取ChannelPipeline对象
ChannelPipeline pipeline = ctx.channel().pipeline();
//往pipeline中添加ChannelHandler处理器，装配流水线
pipeline.addLast(new MyServerHandler());

4.6 Selector

在NioEventLoop中，有一个成员变量selector，这是nio包的Selector。

Netty中的Selector也和NIO的Selector是一样的，就是用于监听事件，管理注册到Selector中的channel，实现多路复用器。

4.7 Pipeline和ChannelPipeline

在前面介绍Channel时，我们知道可以在channel中装配ChannelHandler流水线处理器，那一个channel不可能只有一个channelHandler处理器，肯定是有很多的，既然是很多channelHandler在一个流水线工作，肯定是有顺序的。

于是pipeline就出现了，pipeline相当于处理器的容器。初始化channel时，把channelHandler按顺序装在pipelin中，就可以实现按序执行channelHandler了。

在一个Channel中，只有一个ChannelPipeline。该pipeline在Channel被创建的时候创建。ChannelPipeline包含了一个ChannelHandler形成的列表，且所有ChannelHandler都会注册到ChannelPipeline中。

4.8 ChannelHandlerContext

在Netty中，Handler处理器是有我们定义的，上面讲过通过集成入站处理器或者出站处理器实现。这时如果我们想在Handler中获取pipeline对象，或者channel对象，怎么获取呢？

于是Netty设计了这个ChannelHandlerContext上下文对象，就可以拿到channel、pipeline等对象，就可以进行读写等操作。

实际上ChannelHandlerContext在pipeline中是一个链表的形式。

//ChannelPipeline实现类DefaultChannelPipeline的构造器方法
protected DefaultChannelPipeline(Channel channel) {
    this.channel = ObjectUtil.checkNotNull(channel, "channel");
    succeededFuture = new SucceededChannelFuture(channel, null);
    voidPromise =  new VoidChannelPromise(channel, true);
    //设置头结点head，尾结点tail
    tail = new TailContext(this);
    head = new HeadContext(this);
    
    head.next = tail;
    tail.prev = head;
}

 

4.9 EventLoopGroup

先看一下EventLoopGroup的类图

其中包括了常用的实现类NioEventLoopGroup。OioEventLoopGroup在前面的例子中也有使用过。

从Netty的架构图中，可以知道服务器是需要两个线程组进行配合工作的，而这个线程组的接口就是EventLoopGroup。

每个EventLoopGroup里包括一个或多个EventLoop，每个EventLoop中维护一个Selector实例。

4.9.1 轮询机制的实现原理

不妨看一段DefalutEventExecutorChooserFactory的源码：

private final AtomicInteger idx = new AtomicInteger();
private final EventExecutor[] executors;

@Override
public EventExecutor next() {
    //idx.getAndIncrement()相当于idx++，然后对任务长度取模
    return executors[idx.getAndIncrement() & executors.length - 1];
}

 这段代码可以确定执行的方式是轮询机制，接下来debug调试一下：

它这里还有一个判断，如果线程数不是2的N次方，则采用取模算法实现。

@Override
public EventExecutor next() {
    return executors[Math.abs(idx.getAndIncrement() % executors.length)];
}
avatar
文章
阅读
粉丝