一、Bootstrap、ServerBootstrap
- Bootstrap 意思是引导,一个 Netty 应用通常由一个 Bootstrap 开始,主要作用是配置整个 Netty 程序,串联各个组件,Netty 中 Bootstrap 类是客户端程序的启动引导类,ServerBootstrap 是服务端启动引导类。
- 常见的方法有
- public ServerBootstrap group(EventLoopGroup parentGroup, EventLoopGroup childGroup),该方法用于服务器端,用来设置两个 EventLoop
- public B group(EventLoopGroup group),该方法用于客户端,用来设置一个 EventLoopGroup
- public B channel(Class<? extends C> channelClass),该方法用来设置一个服务器端的通道实现
- public
B option(ChannelOption option, T value),用来给 ServerChannel 添加配置 - public
ServerBootstrap childOption(ChannelOption childOption, T value),用来给接收到的通道添加配置 - public ServerBootstrap childHandler(ChannelHandler childHandler),该方法用来给workGroup设置业务处理类(自定义的handler)
- public ServerBootstrap handler(ChannelHandler childHandler),对 bossGroup 设置业务处理类
- public ChannelFuture bind(int inetPort),该方法用于服务器端,用来设置占用的端口号
- public ChannelFuture connect(String inetHost, int inetPort),该方法用于客户端,用来连接服务器端
二、Future、ChannelFuture
Netty 中所有的 IO 操作都是异步的,不能立刻得知消息是否被正确处理。但是可以过一会等它执行完成或者直接注册一个监听,具体的实现就是通过 Future 和 ChannelFutures,他们可以注册一个监听,当操作执行成功或失败时监听会自动触发注册的监听事件
常见的方法有
- Netty 网络通信的组件,能够用于执行网络 I/O 操作。
- 通过 Channel 可获得当前网络连接的通道的状态
- 通过 Channel 可获得网络连接的配置参数(例如接收缓冲区大小)
- Channel 提供异步的网络 I/O 操作(如建立连接,读写,绑定端口),异步调用意味着任何 I/O 调用都将立即返回,并且不保证在调用结束时所请求的 I/O 操作已完成
- 调用立即返回一个 ChannelFuture 实例,通过注册监听器到 ChannelFuture 上,可以 I/O 操作成功、失败或取消时回调通知调用方
- 支持关联 I/O 操作与对应的处理程序
不同协议、不同的阻塞类型的连接都有不同的 Channel 类型与之对应,常用的 Channel 类型:
Netty 基于 Selector 对象实现 I/O 多路复用,通过 Selector 一个线程可以监听多个连接的 Channel 事件。
当向一个 Selector 中注册 Channel 后,Selector 内部的机制就可以自动不断地查询(Select)这些注册的 Channel 是否有已就绪的 I/O 事件(例如可读,可写,网络连接完成等),这样程序就可以很简单地使用一个线程高效地管理多个 Channel
五、ChannelHandler 及其实现类
ChannelHandler 是一个接口,处理 I/O 事件或拦截 I/O 操作,并将其转发到其 ChannelPipeline(业务处理链)中的下一个处理程序。
- ChannelHandler 本身并没有提供很多方法,因为这个接口有许多的方法需要实现,方便使用期间,可以继承它的子类
- ChannelHandler 及其实现类一览图(后)
- 我们经常需要自定义一个 Handler 类去继承 ChannelInboundHandlerAdapter,然后通过重写相应方法实现业务逻辑,我们接下来看看一般都需要重写哪些方法
- channelActive:通道就绪事件
- channelRead:通道读取数据事件
- channelReadComplete:数据读取完毕事件
- exceptionCaught:通道发生异常事件
六、Pipeline 和 ChannelPipeline
�ChannelPipeline 是一个重点:
- ChannelPipeline 是一个 Handler 的集合,它负责处理和拦截 inbound 或者 outbound 的事件和操作,相当于一个贯穿 Netty 的链。(也可以这样理解:ChannelPipeline 是保存 ChannelHandler 的 List,用于处理或拦截 Channel 的入站事件和出站操作)
- ChannelPipeline 实现了一种高级形式的拦截过滤器模式,使用户可以完全控制事件的处理方式,以及 Channel 中各个的 ChannelHandler 如何相互交互
在 Netty 中每个 Channel 都有且仅有一个 ChannelPipeline 与之对应,它们的组成关系如下
注意,pipeline 中 也有 channel
- 一个 channel 包含了一个 ChannelPipeline,而且 ChannelPipeline 中又维护了一个由 ChannelHandlerContext 组成的双向链表,并且每个 ChannelHandlerContext 中又关联着一个 ChannelHandler。
- 入栈时间和出栈时间在一个双向链表中,入栈事件会从链表 head 往后传递到最后一个入栈的 handler,出栈事件会从链表 tail 往前传递到最前一个出栈的 handler,两种类型的 handler 互不干扰。
参考代码:6- 快速入门之HTTP服务
channel里面有 ChannelPipeline,ChannelPipeline里面的链式顺序是 ServerInitializer—>HttpServerCodec—>HttpServerHandler
- ServerInitializer 和 HttpServerCodec 这些东西本身也是 handler。
- 一般来说事件从客户端往服务器走我们称为出栈,反之则是入栈。
- 可以看到 ChannelPipeline 实际上是 DefaultChannelPipeline,next类型是ChannelHandlerContext,所以整个pipeline是靠 ChannelHandlerContext 链接起来的,而这里 ChannelHandlerContext 的类型是 DefaultChannelHandlerContext。
常用方法 ChannelPipeline addFirst(ChannelHandler… handlers),把一个业务处理类(handler)添加到链中的第一个位置ChannelPipeline addLast(ChannelHandler… handlers),把一个业务处理类(handler)添加到链中的最后一个位置。
七、ChannelHandlerContext
保存 Channel 相关的所有上下文信息,同时关联一个 ChannelHandler 对象
- 即 ChannelHandlerContext 中包含一个具体的事件处理器 ChannelHandler,同时 ChannelHandlerContext 中也绑定了对应的 pipeline 和 Channel 的信息,方便对 ChannelHandler 进行调用。
还是用 这段代码 6- 快速入门之HTTP服务
可以看到,这里的next已经没有了,因为 HttpServerHandler 是我们最后一个加入的 ChannelHandler。
所以看 prev 可以发现是 HttpServerCodec ,因为我们往 ChannelPipeline 里放入的顺序就是先HttpServerCodec,然后HttpServerHandler。
- 常用方法
- ChannelFuture close(),关闭通道
- ChannelOutboundInvoker flush(),刷新
- ChannelFuture writeAndFlush(Object msg),将数据写到
- ChannelPipeline 中当前 ChannelHandler 的下一个 ChannelHandler 开始处理(出站)
八、ChannelOption
- Netty 在创建 Channel 实例后,一般都需要设置 ChannelOption 参数。
- ChannelOption 参数如下:
九、EventLoopGroup 和其实现类 NioEventLoopGroup
这节可以先回顾下 4-Netty 快速入门实例之TCP服务 中的分析部分
- EventLoopGroup 是一组 EventLoop 的抽象,Netty 为了更好的利用多核 CPU 资源,一般会有多个 EventLoop 同时工作,每个 EventLoop 维护着一个 Selector 实例。
- EventLoopGroup 提供 next 接口,可以从组里面按照一定规则获取其中一个 EventLoop 来处理任务。在 Netty 服务器端编程中,我们一般都需要提供两个 EventLoopGroup,例如:BossEventLoopGroup 和 WorkerEventLoopGroup。
- 通常一个服务端口即一个 ServerSocketChannel 对应一个 Selector 和一个 EventLoop 线程。BossEventLoop 负责接收客户端的连接并将 SocketChannel 交给 WorkerEventLoopGroup 来进行 IO 处理,如下图所示。
4. 常用方法 public NioEventLoopGroup(),构造方法 public Future<?> shutdownGracefully(),断开连接,关闭线程
十、Unpooled
描述
- Netty 提供一个专门用来操作缓冲区(即 Netty 的数据容器)的工具类
- 常用方法如下所示
3. 举例说明 Unpooled 获取 Netty 的数据容器 ByteBuf 的基本使用
可以联想都 NIO 的原生 ByteBuffer(1-NIO 初识) 和 Netty 的 ByteBuf 区别: 在 netty 的 buffer 中不需要使用 flip 进行反转,底层维护了一个 readerindex 和 writerIndex 和 capacity 将 buffer分成三个区
- 0—-readerindex 已经读取的区域
- readerindex—-writerIndex , 可读的区域
- writerIndex — capacity, 可写的区域
每次 write 操作,writerIndex都会加1,每次的 read操作,readerindex都会加1
代码如下1
public class NettyByteBuf01 {
public static void main(String[] args) {
// 创建一个ByteBuf
// 说明 1、对象,该对象包含一个数组 arr,是一个byte[10]
// 在 netty 的 buffer 中不需要使用 flip 进行反转
// 底层维护了一个 readerindex 和 writerIndex 和 capacity 将 buffer分成三个区
// 0---readerindex 已经读取的区域
// readerindex---writerIndex , 可读的区域
// writerIndex -- capacity, 可写的区域
ByteBuf buffer = Unpooled.buffer(10);
for (int i = 0; i < 10; i++) {
buffer.writeByte(i);
}
System.out.println("capacity=" + buffer.capacity());
// 输出
for (int i = 0; i < buffer.capacity(); i++) {
System.out.println(buffer.getByte(i));
}
System.out.println("----");
for (int i = 0; i < buffer.capacity(); i++) {
System.out.println(buffer.readByte());
}
}
}
代码如下2
public class NettyByteBuf02 {
public static void main(String[] args) {
// 创建ByteBuf
ByteBuf byteBuf = Unpooled.copiedBuffer("hello,world!", StandardCharsets.UTF_8);
// 使用相关的方法
if (byteBuf.hasArray()) { // true
byte[] content = byteBuf.array();
// 将 content 转成字符串
System.out.println(new String(content, StandardCharsets.UTF_8));
System.out.println("byteBuf=" + byteBuf);
System.out.println(byteBuf.arrayOffset()); // 0
System.out.println(byteBuf.readerIndex()); // 0
System.out.println(byteBuf.writerIndex()); // 12
System.out.println(byteBuf.capacity()); // 36
System.out.println(byteBuf.readByte());
System.out.println(byteBuf.getByte(0));
int len = byteBuf.readableBytes();
System.out.println("len = " + len); // 可读取的字节数
for (int i = 0; i < len; i++) {
System.out.print((char) byteBuf.getByte(i));
}
System.out.println();
System.out.println(byteBuf.getCharSequence(0, 4, StandardCharsets.UTF_8));
}
}
}