Netty系列（3）Netty核心模块、Future-Listener

最新推荐文章于 2024-04-19 09:32:43 发布

warybee

最新推荐文章于 2024-04-19 09:32:43 发布

阅读量205

点赞数

分类专栏： Netty 文章标签： netty 事件监听 Future-Listener

欢迎各位转载，转载请在文章页面中给出作者和原文链接！谢谢您配合

本文链接：https://blog.csdn.net/warybee/article/details/120875398

版权

Netty 专栏收录该内容

5 篇文章 2 订阅

订阅专栏

文章目录

1 Netty核心API
2 Netty异步模型
- 2.1 Future
- 2.2 Future-Listener 机制

1 Netty核心API

1.1 ChannelHandler

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

ChannelHandler 及其实现类关系

在这里插入图片描述

ChannelOutboundHandler 处理IO出站事件
ChannelInboundHandler ChannelHandlerAdapter处理IO入站事件
ChannelDuplexHandler 处理入站和出站事件

我们经常需要自定义一个 Handler 类去继承 ChannelInboundHandlerAdapter，然后通过重写相应方法实现业务逻辑，一般需要重新以下方法：

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

1.2 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互不干扰。

常用方法：

ChannelPipeline addFirst(ChannelHandler... handlers)，把一个业务处理类（handler）添加到链中的第一个位置
ChannelPipeline addLast(ChannelHandler... handlers)，把一个业务处理类（handler）添加到链中的最后一个位置

1.3 ChannelHandlerContext

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

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

1.4 ChannelOption

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

ChannelOption.SO_BACKLOG对应 TCP/IP 协议 listen 函数中的 backlog 参数，用来初始化服务器可连接队列大小。服务端处理客户端连接请求是顺序处理的，所以同一时间只能处理一个客户端连接。多个客户端来的时候，服务端将不能处理的客户端连接请求放在队列中等待处理，backlog 参数指定了队列的大小。
ChannelOption.SO_KEEPALIVE ，一直保持连接活动状态。该参数用于设置TCP连接，当设置该选项以后，连接会测试链接的状态，这个选项用于可能长时间没有数据交流的连接。当设置该选项以后，如果在两小时内没有数据的通信时，TCP会自动发送一个活动探测数据报文。

..................省略其他代码......................
bootstrap.group(bossGroup,workerGroup)
        .channel(NioServerSocketChannel.class)
        //参数设置-设置线程队列中等待连接个数
        .option(ChannelOption.SO_BACKLOG,128)
        //参数设置-设置活跃状态,child是设置workerGroup
        .childOption(ChannelOption.SO_KEEPALIVE,true)
      
..................省略其他代码......................

1.5 ChannelFuture

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

常见的方法有

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

//启动服务端并绑定端口,同时将异步改为同步
ChannelFuture channelFuture = bootstrap.bind(9999).sync();
//关闭通道(并不是真正意义上的关闭,而是监听通道关闭状态)和关闭连接池
channelFuture.channel().closeFuture().sync();

1.6 EventLoopGroup和实现类NioEventLoopGroup

EventLoopGroup 是一组 EventLoop 的抽象，Netty 为了更好的利用多核 CPU 资源，一般会有多个 EventLoop 同时工作，每个 EventLoop 维护着一个 Selector 实例。
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-yDs89udK-1634735986681)(G:\学习资料\java高级开发学习笔记\03 NIO Netty Zookeeper Spring Cloud\nettyImages\eventloopgroup.png)]
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()，断开连接，关闭线

1.7 ServerBootstrap和Bootstrap

Bootstrap 意思是引导，一个 Netty 应用通常由一个 Bootstrap 开始，主要作用是配置整个 Netty 程序，串联各个组件，
Netty 中 Bootstrap 类是客户端程序的启动引导类，ServerBootstrap 是服务端启动引导类，
常见的方法有
- public ServerBootstrap group(EventLoopGroup parentGroup, EventLoopGroup childGroup)，该方法用于服务器端，用来设置两个 EventLoop
- public B group(EventLoopGroup group)，该方法用于客户端，用来设置一个 EventLoop
- public B channel(Class<? extends C> channelClass)，该方法用来设置一个服务器端的通道实现
- public <T> B option(ChannelOption<T> option, T value)，用来给 ServerChannel 添加配置
- public <T> ServerBootstrap childOption(ChannelOption<T> childOption, T value)，用来给接收到的通道添加配置
- public ServerBootstrap childHandler(ChannelHandler childHandler)，该方法用来设置业务处理类（自定义的handler）
- public ChannelFuture bind(int inetPort)，该方法用于服务器端，用来设置占用的端口号
- public ChannelFuture connect(String inetHost, int inetPort)，该方法用于客户端，用来连接服务器端

1.8 Unpooled类

Netty 提供一个专门用来操作缓冲区（即 Netty 的数据容器）的工具类，常用方法：

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

2 Netty异步模型

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

在这里插入图片描述

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

2.1 Future

表示异步的执行结果, 可以通过它提供的方法来检测执行是否完成，ChannelFuture 是他的一个子接口. ChannelFuture 是一个接口 ,可以添加监听器，当监听的事件发生时，就会通知到监听器
当 Future 对象刚刚创建时，处于非完成状态，调用者可以通过返回的 ChannelFuture 来获取操作执行的状态，注册监听函数来执行完成后的操作。

常用方法:

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

2.2 Future-Listener 机制

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

//..................省略其他代码......................
//启动服务端并绑定端口,同时将异步改为同步
ChannelFuture channelFuture = bootstrap.bind(9999).sync();

channelFuture.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 channelReadComplete(ChannelHandlerContext ctx) throws Exception {
    //发送消息给客户端
    ChannelFuture channelFuture = ctx.writeAndFlush(Unpooled.copiedBuffer("hello 客户端", StandardCharsets.UTF_8));

    channelFuture.addListener(new ChannelFutureListener() {
        @Override
        public void operationComplete(ChannelFuture future) throws Exception {
              if (future.isSuccess()){
                  System.out.println("消息发送成功");
              }else {
                  System.out.println("消息发送失败");
              }
        }
    });
}

warybee

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
打赏
0
评论
Netty系列（3）Netty核心模块、Future-Listener

这里写目录标题1 Netty核心API1.1 ChannelHandler1.2 ChannelPipeline1.3 ChannelHandlerContext1.4 ChannelOption1.5 ChannelFuture1.6 EventLoopGroup和实现类NioEventLoopGroup1.7 ServerBootstrap和Bootstrap1.8 Unpooled类2 Netty异步模型2.1 Future2.2 Future-Listener 机制1 Netty核心API1.
复制链接

扫一扫