0%

Netty-核心模块组件

Netty-核心模块组件

Bootstrap、ServerBootstrap

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

  2. 常见的方法有

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    // 该方法用于服务器端,用来设置两个EventLoopGroup
    public ServerBootstrap group(EventLoopGroup parentGroup, EventLoopGroup childGroup)
    // 该方法用于客户端,用来设置一个EventLoopGroup
    public ServerBootstrap group(EventLoopGroup group)
    // 该方法用来设置一个服务器端的通道实现
    public B channel(Class<? extends C> channelClass)
    // 用来给ServerChannel添加配置
    public <T> B option(ChannelOption<T> option, T value)
    // 用来给接收到的通道添加配置
    public <T> ServerBootstrap childOption(ChannelOption<T> childOption, T value)
    // handler对应bossGroup
    public B handler(ChannelHandler handler)
    // 用来设置业务处理类(自定义的handler),对应workerGroup
    public ServerBootstrap childHandler(ChannelHandler childHandler)
    // 用于服务器端,用来设置占用的端口号
    public ChannelFuture bind(int inetPort)
    // 用于客户端,用来连接服务器
    public ChannelFuture connect(String inetHost, int inetPort)

Future和ChannelFuture

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

  2. 常见的方法

    1
    2
    3
    4
    // 返回当前正在进行IO操作的通道
    Channel channel();
    // 等待异步操作执行完毕
    ChannelFuture sync();

Channel

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

Selector

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

ChannelHandler及其实现类

  1. ChannelHandler是一个接口,处理I/O事件或拦截I/O操作,并将其转发到其ChannelPipeline(业务处理链)中的下一个处理程序
  2. ChannelHandler本身并没有提供很多方法,因为这个接口有许多的方法需要实现,方便使用起见,可以继承它的子类
  3. 经常需要自定义一个Handler类去继承ChannelInboundHandlerAdapter,然后重写相应的方法实现业务逻辑
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
public class ChannelInboundHandlerAdapter extends ChannelHandlerAdapter implements ChannelInboundHandler {
...
// 通道就绪事件
public void channelActive(ChannelHandlerContext ctx) throws Exception {
ctx.fireChannelActive();
}
// 通道读取数据事件
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
ctx.fireChannelRead(msg);
}
// 数据读取完毕事件
public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
ctx.fireChannelReadComplete();
}
...
// 通道发生异常事件
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause)
throws Exception {
ctx.fireExceptionCaught(cause);
}
}

Pipeline和ChannelPipeline

ChannelPipeline是一个重点:

  1. ChannelPipeline是一个Handler的集合,它负责处理和拦截inbound或者outbound的事件和操作,相当于一个贯穿Netty的链(也可以这样理解:ChannelPipeline是保存ChannelHandler的List,用于处理器或拦截Channel的入站事件和出站操作)

  2. ChannelPipeline实现了一种高级形式的拦截过滤器模式,使用户可以完全控制事件的处理方式,以及Channel中各个的ChannelHandler如何相互交互

  3. 在Netty中每个Channel都有且仅有一个ChannelPipeline与之对应,它们的组成关系如下

    • 一个Channel包含了一个ChannelPipeline,而ChannelPipeline中又维护了一个由ChannelHandlerContext 组成的双向链表,并且每个ChannelHandlerContext中又关联着ChannelHandler
    • 入站事件和出站事件在一个双向链表中,入站事件会从链表head往后传递到最后一个入站的handler,出站事件会从链表tail往前传递到最前一个出站的handler,两种类型的handler互不干扰
  4. 常用方法

    1
    2
    3
    4
    // 把一个业务处理类(handler)添加到链中的第一个位置
    ChannelPipeline addFirst(ChannelHandler... handlers);
    // 把一个业务处理类(handler)添加到链中的最后一个位置
    ChannelPipeline addLast(ChannelHandler... handlers);

ChannelHandlerContext

  1. 保存Channel相关的所有上下文信息,同时关联一个ChannelHandler对象

  2. 即ChannelHandlerContext中包含一个具体的事件处理器ChannelHandler,同时ChannelHandlerContext中也绑定了对应的pipeline和Channel的信息,方便对ChannelHandler进行调用

  3. 常用方法

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

ChannelOption

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

  2. 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维护着一个注册了ServerSocketChannel的Selector实例BossEventLoop不断轮询Selector将连接事件分离出来
  • 通常是OP_ACCEPT事件,然后将接收到的SocketChannel交给WorkerEventLoopGroup
  • WorkerEventLoopGroup会由next选择其中一个EventLoopGroup来将这个SocketChannel注册到其维护的Selector并对其后续的IO事件进行处理
  1. 常用方法

    1
    2
    3
    4
    // 构造方法
    public NioEventLoopGroup()
    // 断开连接,关闭线程
    public Future<?> shutdownGracefully()

Unpooled类

  1. Netty提供一个专门用来操作缓冲区(即Netty的数据容器)的工具类

  2. 常用方法

    1
    2
    // 通过给定的数据和字符编码返回一个ByteBuf对象,与NIO中的ByteBuffer类似,但有区别
    public static ByteBuf copiedBuffer(CharSequence string, Charset charset)
  3. 举例说明Unpooled获取Netty的数据容器ByteBuf的基本使用

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    public class NettyByteBuf01 {
    public static void main(String[] args) {
    // 创建一个ByteBuf
    // 说明:
    // 1. 创建对象,该对象包含一个数组arr,是一个byte[10]
    // 2. 在netty的buffer中,不需要使用flip进行反转
    // 底层维护了readerIndex和writeIndex
    // 3. 通过readIndex和writeIndex和capacity,将buffer分成三个区域
    // 0 - readIndex:已读区
    // readIndex - writeIndex:可读区
    // writeIndex - capacity:可写区
    ByteBuf buf = Unpooled.buffer(10);
    for (int i = 0; i < 10; i++) {
    buf.writeByte(i);
    }
    for (int i = 0; i < buf.capacity(); i++) {
    System.out.println(buf.readByte());
    }
    }
    }