本文是Netty文集中“Netty in action”系列的文章。主要是对Norman Maurer and Marvin Allen Wolfthal 的 《Netty in action》一书简要翻译,同时对重要点加上一些自己补充和扩展。
概要
- 引导客户端和服务器端
- 从一个Channel里的引导客户端
- 添加ChannelHandlers
- 使用ChannelOptions 和 属性
Netty使用引导的方式来使得你的应用(无论是客户端还是服务器端)同网络层隔离。
Bootstrap 类
一个服务器致力于通过一个parent channel用于接收客户端的连接并且创建child channel用于和对应的客户端的通信。然后一个客户端很可能只需要一个channel,在整个网络交互中是没有parent channel 的。正如我们所看到,这也适用于无连接的传输,如UDP,因为它们不需要一个channel在每次连接时。
AbstractBoostrap处理两个种类应用的共同引导步骤,然后特定的步骤客户端由Bootstrap、服务端有ServerBootstrap分别处理。
为什么bootstrap类是可克隆的?
在某些时候你需要创建许多相似或完全相同设置的channels。为了支持在无需创建一个新的bootstrap实例并能配置每个channel的模式,AbstractBootstrap被标志为Cloneable。在一个已经配置好的bootstrap上调用clone()方法将返回另一个可立即使用的boostrap实例。
注意,这里创建的只是一个bootstrap的EventLoopGroup的浅拷贝,所以这个EventLoopGroup会被所有拷贝生成的channels共享。这是可以理解的,作为拷贝而来的channel经常都是短暂的,一个典型的场景是一个channel的创建用于生成一个HTTP请求。
AbstractBootstrap的完整描述:
public abstract class AbstractBootstrap<B extends AbstractBootstrap<B, C>, C extends Channel> implements Cloneable
子类B是父类的一个类型参数,所以一个运行时期的实例引用能被返回用于支持方法链(流式语法)。如:
Bootstrap bootstrap = new Bootstrap();
bootstrap.group(workerGroup).channel(NioSocketChannel.class).handler(new MyClientInitializer());
引导一个客户端
Bootstrap负责创建客户端或使用无连接协议应用的channels。
代码示例:
Channel 和 EventLoopGroup 的兼容性
EventLoopGroup 和 Channel 都实现了 NIO 和 OIO 的传输。这个兼容性是需要维护的,你不能够混合不同前缀(nio or oio)的组件使用,比如像NioEventLoopGroup 和 OioSocketChannel,否则将会触发IllegalStateException异常。
更多关于 IllegalStateException
** 在你调用bing()或connect()方法前下面的方法必须被调用,以是设置必要的组件(下面组件的设置并没有任何顺序要求)。**
① group()
② channel() or channelFactory()
③ handler() or childHandler()
handler()方法的调用特别重要,因为它需要去配置ChannelPipeline。
引导一个服务端
ServerChannel的实现负责创建child Channels,这些child Channels代表了接收的连接。
下图展示了一个ServerBootstrap在bind()时会创建一个ServerChannel,并且这个ServerChannel管理着若干child Channels。
代码示例:
通过一个Channel去引导一个客户端
假设你的服务端正在处理一个客户端请求,该请求要求你(即,服务端)作为第三个系统的客户端。这将发生在一个如代理服务器的应用上。在这种情况,你需要从一个ServerChannel去引导一个客户端channel。
你能够创建一个新的Bootstrap,但这不是最高效的解决方法,因为它将要求你去声明另一个EventLoop用于新的客户端Channel。这将产生附加线程,并且在从接收的channel交换数据到新的客户端channel的时候需要上下文切换。
一个比较好的解决方法是共享接收channel的EventLoop,通过传递该EventLoop给Bootstrap的group()方法来实现共享。因为所有分配给一个EventLoop的Channels都是用相同的线程,这避免了额外的线程创建和上下文切换。
代码示例:
添加多个ChannelHandlers在一个引导程序期间
Netty提供了一个ChannelInboundHandlerAdapter的特殊子类:
public abstract class ChannelInitializer<C extends Channel> extends ChannelInboundHandlerAdapter
该类定义了如下方法:
protected abstract void initChannel(C ch) throws Exception
该方法提供了一个简单的方式去添加多个ChannelHandlers到一个ChannelPipeline中。你只要简单提供ChannelInitializer实现给引导程序,一旦Channel注册到EventLoop,initChannel()方法就会被调用。在该方法返回后,ChannelInitializer实例将从ChannelPipeline中移除它自己。
代码示例:
使用Netty 的 ChannelOptions 和 attributes
你能通过option()去使用ChannelOptions到一个引导程序中。你提供的值将被自动引用于该引导程序创建的所有Channel上。ChannelOptions的可用性包括了底层连接的细节,比如keep-alive或超时属性和缓存设置。
在某些常规属性和数据不可用的情况下,Netty提供AttributeMap抽象概念,一个由通道和引导类提供的集合,以及AttributeKey <T>,用于插入和检索属性值的通用类。通过这些工具,你能够安全的关联任何类型的数据项到服务端或客户端的Channels。
考虑一种情况,一个服务端应用它追踪用户和channels间的关系。这能够通过存储用户ID为一个Channel的attribute来实现。一个类似的技术,基于用户ID来路由消息到相关用户或关闭一个低活跃度的channel。
示例代码:
引导一个数据报通道
Netty提供了多种DatagramChannel的实现用于无连接协议的引导程序。它和基于TCP的SocketChannel的不同仅在于,你不需要调用connect() 只需要调用bind()即可。
代码示例:
关闭
优雅的关闭你的Netty应用,你需要记住下面几点。
首先,你需要关闭EventLoopGroup,这将处理所有等待执行的事件和任务,随后释放所有的活跃线程。这是一个调用EventLoopGroup.shutdownGracefully()的问题。该调用将返回一个Future,该future在关闭完成是会进行通知。注意,shutdownGracefully()也是一个异步的操作,所以你要么去阻塞直到它完成,要么注册一个事件到future用于在完成时得到通知。
代码示例:
或者,你可以在调用EventLoopGroup.shutdownGracefully()方法前对所有活动的channel显示的调用Channel.close()方法来释放channel的资源。但是在所有情况下,记得要关闭EventLoopGroup本身。
后记
本文主要对Netty的引导概念进行了介绍,包括对NIO IO的服务端、客户端的启动引导,以及通过一个Channel去引导启动一个客户端,和如果引导一个无连接的数据报服务等等。
若文章有任何错误,望大家不吝指教:)