Netty核心模块API说明及其使用

it2023-07-18  73

前言

建议先去看看https://github.com/Coderxiangyang/NettyExercise/tree/master/NettySimple这个案例,在阅读下面的文章,理解效果会更好。此文主要记录Netty常用的模块以及API。 梳理一下代码顺序,先使用引导器,加载各种配置,然后加载各种handler(业务处理类),然后客户端去连接服务端的IP地址以及端口,服务端监听端口即可。然后获取通道,将数据写入通道即完事。

Bootstrap ServerBootstrap

解释

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

常见的方法

public ServerBootstrap group(EventLoopGroup parentGroup, EventLoopGroup childGroup)该方法用于服务器端,用来设置两个 EventLooppublic B group(EventLoopGroup group) ,该方法用于客户端,用来设置一个 EventLooppublic B channel(Class<? extends C> channelClass),该方法用来设置一个服务器端的通道实现,即你是用TCP还是UDP的通道,TCP用NioServerSocketChannel(服务端)NioSocketChannel(客户端),UDP用NioDatagramChannel,等public B option(ChannelOption option, T value),用来给 ServerChannel 添加配置public ServerBootstrap childOption(ChannelOption childOption, T value),用来给接收到的通道添加配置public ServerBootstrap childHandler(ChannelHandler childHandler),该方法用来设置业务处理类(自定义的handler)public ChannelFuture bind(int inetPort) ,该方法用于服务器端,用来设置占用的端口号public ChannelFuture connect(String inetHost, int inetPort) ,该方法用于客户端,用来连接服务器端

Future、ChannelFuture

解释

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

常见方法

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

Channel

解释

Netty 网络通信的组件,能够用于执行网络 I/O 操作。通过 Channel 可获得当前网络连接的通道的状态通过 Channel 可获得 网络连接的配置参数 (例如接收缓冲区大小)Channel 提供异步的网络 I/O 操作(如建立连接,读写,绑定端口),异步调用意味着任何 I/O 调用都将立即返 回,并且不保证在调用结束时所请求的 I/O 操作已完成调用立即返回一个 ChannelFuture 实例,通过注册监听器到 ChannelFuture 上,可以 I/O 操作成功、失败或取 消时回调通知调用方支持关联 I/O 操作与对应的处理程序不同协议、不同的阻塞类型的连接都有不同的 Channel 类型与之对应,常用的 Channel 类型: NioSocketChannel,异步的客户端 TCP Socket 连接。 NioServerSocketChannel,异步的服务器端 TCP Socket 连接。 NioDatagramChannel,异步的 UDP 连接。 NioSctpChannel,异步的客户端 Sctp 连接。 NioSctpServerChannel,异步的 Sctp 服务器端连接,这些通道涵盖了 UDP 和 TCP 网络 IO 以及文件 IO。 主要用处: netty中主要用来设置数据通讯方式,这里是服务器端,tcp通信方式

Selector

解释

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

ChannelHandler

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

1.ChannelInboundHandlerAdapter(实现类)用于处理入站IO事件 2. ChannelOutboundHandlerAdapter(实现类)用于处理出站IO事件 3. ChannelInboundHandler(接口)用于处理入站IO事件 4. ChannelOutboundHandler(接口)用于处理出站IO事件 5. ChannelDuplexHandler (实现类)用于处理入站和出站事件

我们经常需要自定义一个 Handler 类去继承 ChannelInboundHandlerAdapter,然后通过重写相应方法实现业务逻辑,我们接下来看看一般都需要重写哪些方法

这里的方法比较齐全,看方法名字也基本明白其用法,这里不在详解

Pipeline() 、 ChannelPipeline

解释

1、ChannelPipeline 是一个 Handler 的集合,它负责处理和拦截 inbound 或者 outbound 的事件和操作,相当于一个贯穿 Netty 的链。(也可以这样理解:ChannelPipeline 是 保存 ChannelHandler 的 List,用于处理或拦截Channel 的入站事件和出站操作),即一个channel对应一个 ChannelPipeline,对应多个handler、 2、Pipeline() 是一个获取ChannelPipeline 的方法,可以在channel拿到,可以在ChannelHandlerContext拿到。

常见用法

1、ChannelPipeline addFirst(ChannelHandler… handlers),把一个业务处理类(handler)添加到链中的第一个位置 2、ChannelPipeline addLast(ChannelHandler… handlers),把一个业务处理类(handler)添加到链中的最后一个位置

ChannelHandlerContext

解释

ChannelHandlerContext中保存 Channel 相关的所有上下文信息,同时关联一个 ChannelHandler 对象,同时ChannelHandlerContext 中也绑定了对应的 pipeline 和 Channel 的信息,方便对 ChannelHandler 进行调用.

常用方法

ChannelFuture返回值 close() 方法,关闭通道ChannelOutboundInvoker返回值 flush()方法,刷新ChannelFuture 返回值 writeAndFlush(Object msg)方法 , 将 数 据 写 到 ChannelPipelinefireChannelRead()方法 当前channelHandler处理完,交给下一个handler处理,并将处理完的值传过去

ChannelOption

解释

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

常用

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

EventLoopGroup 和其实现类 NioEventLoopGroup

解释

1、这两个就是服务端最开始声明的bossGroup,主要维护连接事件,workerGroup主要处理业务事件。通常为多个EventLoopGroup同时工作 ,这样可以充分利用CPU,每个 EventLoop 维护着一个 Selector 实例 2、EventLoopGroup 提供 next 接口,可以从组里面按照一定规则获取其中一个 EventLoop 来处理任务。在Netty服务器端编程中 3、通常一个服务端口即一个 ServerSocketChannel 对应一个 Selector 和一个 EventLoop 线程。BossEventLoop 负责 接收客户端的连接并将 SocketChannel 交给 WorkerEventLoopGroup 来进行 IO 处理,如下图所示

常用方法

1、EventLoopGroup workerGroup = new NioEventLoopGroup(); //声明8个NioEventLoop 2、workerGroup.shutdownGracefully();断开连接,关闭线程

Unpooled 类

解释

一个专门用来操作缓冲区(即 Netty 的数据容器)的工具类,与NIO中的ByteBuffer类似但是有区别。 具体的按案例吧, github地址:https://github.com/Coderxiangyang/NettyExercise/tree/master/NettyBuf

以上都看完了,如果还是有不理解的话,可以看看另一个聊天室案例。地址https://github.com/Coderxiangyang/NettyExercise/tree/master/NettyGroupChat

IdleStateHandler心跳检测

解释

Netty自带心跳检测机制,分为三种,分别是 1、 long readerIdleTime : 表示多长时间没有读, 就会发送一个心跳检测包检测是否连接 2、 long writerIdleTime : 表示多长时间没有写, 就会发送一个心跳检测包检测是否连接 3、 long allIdleTime : 表示多长时间没有读写, 就会发送一个心跳检测包检测是否连接

用法

然后通过IdleStateEvent获取心跳连接状态

最新回复(0)