目录
ChannelHandler
ChannelHandler 接口
ChannelInboundHandler 接口
ChannelHandler 的适配器
Handler 的共享和并发安全性
资源管理和 SimpleChannelInboundHandler
Bootstrap
ChannelInitializer
ChannelOption
ChannelHandler
ChannelHandler 接口
从开发人员的角度来看,Netty 的主要组件是 ChannelHandler,它充当了所有处理入站和出站数据的应用程序逻辑的容器。ChannelHandler 的方法是由网络事件触发的。事实上,ChannelHandler 可专门用于几乎任何类型的动作,例如将数据从一种格式转换为另外一种格式,例如各种编解码,或者处理转换过程中所抛出的异常。
Netty 定义了下面两个重要的 ChannelHandler 子接口:
ChannelInboundHandler——处理入站数据以及各种状态变化。
ChannelOutboundHandler——处理出站数据并且允许拦截所有的操作。
ChannelInboundHandler 接口
ChannelInboundHandler 接口方法:
channelRegistered
当 Channel 已经注册到它的 EventLoop 并且能够处理 I/O 时被调用。
channelUnregistered
当 Channel 从它的 EventLoop 注销并且无法处理任何 I/O 时被调用。
channelActive
当 Channel 处于活动状态时被调用;Channel 已经连接/绑定并且已经就绪。
channelInactive
当 Channel 离开活动状态并且不再连接它的远程节点时被调用。
channelReadComplete
当 Channel 上的一个读操作完成时被调用。
channelRead
当从 Channel 读取数据时被调用。
ChannelWritabilityChanged
当 Channel 的可写状态发生改变时被调用。可以通过调用 Channel 的 isWritable()方法
来检测 Channel 的可写性。与可写性相关的阈值可以通过Channel.config().setWriteHighWaterMark()和 Channel.config().setWriteLowWaterMark()方法来设置。
userEventTriggered
当ChannelnboundHandler.fireUserEventTriggered()方法被调用时被调用。
ChannelOutboundHandler 接口方法:
bind(ChannelHandlerContext,SocketAddress,ChannelPromise)
当请求将 Channel 绑定到本地地址时被调用
connect(ChannelHandlerContext,SocketAddress,SocketAddress,ChannelPromise)
当请求将 Channel 连接到远程节点时被调用
disconnect(ChannelHandlerContext,ChannelPromise)
当请求将 Channel 从远程节点断开时被调用
close(ChannelHandlerContext,ChannelPromise)
当请求关闭 Channel 时被调用
deregister(ChannelHandlerContext,ChannelPromise)
当请求将 Channel 从它的 EventLoop 注销时被调用
read(ChannelHandlerContext)
当请求从 Channel 读取更多的数据时被调用
flush(ChannelHandlerContext)
当请求通过 Channel 将入队数据冲刷到远程节点时被调用
write(ChannelHandlerContext,Object,ChannelPromise)
当请求通过 Channel 将数据写到远程节点时被调用
ChannelHandler 的适配器
有一些适配器类可以将编写自定义的 ChannelHandler 所需要的工作降到最低限度,因为它们提供了定义在对应接口中的所有方法的默认实现。Netty 提供了抽象基类 ChannelInboundHandlerAdapter(处理入站) 和 ChannelOutboundHandlerAdapter(处理出站)。
可以使用 ChannelInboundHandlerAdapter 和 ChannelOutboundHandlerAdapter 类作为自己的 ChannelHandler 的起始点。这两个适配器分别提供了 ChannelInboundHandler 和 ChannelOutboundHandler 的基本实现。通过扩展抽象类 ChannelHandlerAdapter,它们获得了它们共同的超接口 ChannelHandler 的方法。
ChannelOutboundHandler 有个非常让人迷惑的 read 方法,这个 read 方法不是表示读数据,而是表示业务发出了读(read)数据的要求,这个要求也会封装为一个事件进行传播,这个事件 因为是业务发出到网络的,自然就是个出站事件,而且这个事件触发的就是 ChannelOutboundHandler 中 read 方法。
如果我们的 Handler 既要处理入站又要处理出站可以使用类 ChannelDuplexHandler,也可以同时实现 ChannelOutboundHandler,ChannelInboundHandler 这两个接口。
Handler 的共享和并发安全性
ChannelHandlerAdapter 还提供了实用方法 isSharable()。如果其对应的实现被标注为 Sharable,那么这个方法将返回 true,表示它可以被添加到多个 ChannelPipeline。
@ChannelHandler.Sharable
//在具体的处理器上打上该注解,在服务端引用的时候提前创建一个实例,可以在多个channel中引用该共享处理器
资源管理和 SimpleChannelInboundHandler
Netty 在处理网络数据时,需要 Buffer,在 Read 网络数据时由 Netty 创建 Buffer,Write 网络数据时 Buffer 往往是由业务方创建的。不管是读和写,Buffer 用完后都必须进行释放,否则可能会造成内存泄露。
在 Write 网络数据时,可以确保数据被写往网络了,Netty 会自动进行 Buffer 的释放,但是如果 Write 网络数据时,我们有 outBoundHandler 处理了 write()操作并丢弃了数据,没有继续往下写,要由我们负责释放这个 Buffer,就必须调用 ReferenceCountUtil.release 方法,否则就可能会造成内存泄露。所以 Netty 提供了一个特殊的被 称为 SimpleChannelInboundHandler 的 ChannelInboundHandler 实现。这个实现会在数据被 channelRead0()方法消费之后自动释放数据。
同时系统为我们提供的各种预定义 Handler 实现,都实现了数据的正确处理,当我们自行编写业务 Handler 时,需要注意:数据要么继续传递,要么自行释放。
Bootstrap
网络编程里,“服务器”和“客户端”实际上表示了不同的网络行为。换句话说,是监听传入的连接还是建立到一个或者多个进程的连接。因此,有两种类型的引导:一种用于客户端(简单地称为 Bootstrap),而另一种(ServerBootstrap)用于服务器。无论你的应用程序使用哪种协议或者处理哪种类型的数据,唯一决定它使用哪种引导类的是它是作为一个客户端还是作为一个服务器。
Bootstrap和ServerBootstrap区别:
1. ServerBootstrap 将绑定到一个端口,因为服务器必须要监听连接,而 Bootstrap 则是由想要连接到远程节点的客户端应用程序所使用的。
2. 引导一个客户端只需要一个 EventLoopGroup,但是一个 ServerBootstrap 则需要两个(也可以是同一个实例)。
因为服务器需要两组不同的 Channel。第一组将只包含一个 ServerChannel,代表服务器自身的已绑定到某个本地端口的正在监听的套接字。而第二组将包含所有已创建的用来处理传入客户端连接(对于每个服务器已经接受的连接都有一个)的 Channel。
与 ServerChannel 相关联的 EventLoopGroup 将分配一个负责为传入连接请求创建 Channel 的 EventLoop。一旦连接被接受,第二个 EventLoopGroup 就会给它的 Channel 分配一个 EventLoop。
ChannelInitializer
//Netty 提供了一个特殊的 ChannelInboundHandlerAdapter 子类
public abstract class ChannelInitializer<C extends Channel> ext ends
ChannelInboundHandlerAdapter
//定义了下面的方法:
protect ed abstract void initChannel(C ch) throws Exception;
这个方法提供了一种将多个 ChannelHandler 添加到一个 ChannelPipeline 中的简便方法。你只需要简单地向 Bootstrap 或 ServerBootstrap 的实例提供你的 ChannelInitializer 实现即可,并且一旦 Channel 被注册到了它的 EventLoop 之后,就会调用你的initChannel()版本。在该方法返回之后,ChannelInitializer 的实例将会从 ChannelPipeline 中移除它自己。
之前案例中的:
ChannelOption
//通用 TCP 参数:
ChannelOption.SO_KEEPALIVE: 保持长连接,定期发送TCP保活包。
ChannelOption.TCP_NODELAY: 禁用 Nagle 算法,即禁用延迟发送。
//接收缓冲区和发送缓冲区大小:
ChannelOption.SO_RCVBUF: 设置接收缓冲区大小。
ChannelOption.SO_SNDBUF: 设置发送缓冲区大小。
//连接相关参数:
ChannelOption.CONNECT_TIMEOUT_MILLIS: 连接超时时间。
ChannelOption.SO_LINGER: 设置延迟关闭的时间,单位为秒。
//多路复用相关参数:
ChannelOption.SO_BACKLOG: 设置等待接受的连接队列大小。
ChannelOption.SO_REUSEADDR: 允许重用地址。
ChannelOption.SO_REUSEPORT: 允许多个Socket绑定到同一端口,一般用于实现负载均衡。
//其他:
ChannelOption.AUTO_READ: 如果为 true,则注册Channel的时候会自动创建并注册一个关联的ChannelHandlerContext,并调用 ChannelHandlerContext.read() 来开始读取数据。