- 原生 NIO 存在的问题:
- NIO 的类库和 API 繁杂,使用麻烦:需要熟练掌握 Selector、ServerSocketChannel、SocketChannel、ByteBuffer等。
- 需要具备其他的额外技能:要熟悉 Java 多线程编程,因为 NIO 编程涉及到 Reactor 模式,你必须对多线程和网络编程非常熟悉,才能编写出高质量的 NIO 程序。
- 开发工作量和难度都非常大:例如客户端面临断连重连、网络闪断、半包读写、失败缓存、网络拥塞和异常流的处理等等。
- JDK NIO 的 Bug:例如臭名昭著的 Epoll Bug,它会导致 Selector 空轮询,最终导致 CPU100%。直到 JDK1.7 版本该问题仍旧存在,没有被根本解决。
- Netty的优点:Netty 对 JDK 自带的 NIO 的 API 进行了封装,解决了上述问题。
- 设计优雅:适用于各种传输类型的统一 API 阻塞和非阻塞 Socket;基于灵活且可扩展的事件模型,可以清晰地分离关注点;高度可定制的线程模型-单线程,一个或多个线程池。
- 使用方便:详细记录的 Javadoc,用户指南和示例;没有其他依赖项,JDK5(Netty3.x)或 6(Netty4.x)就足够了。
- 高性能、吞吐量更高:延迟更低;减少资源消耗;最小化不必要的内存复制。
- 安全:完整的 SSL/TLS 和 StartTLS 支持。
- 社区活跃、不断更新:社区活跃,版本迭代周期短,发现的 Bug 可以被及时修复,同时更多的新功能会被加入。
- 目前存在的线程模型有:
传统阻塞I/O服务模型
和Reactor模式
。
- 传统阻塞I/O服务模型的特点:
- 采用阻塞 IO 的模式获取输入的数据;
- 每个连接都需要独立的线程完成数据的输入,业务处理,数据返回。
- 上图反应的问题分析:
- 当并发数很大,就会创建大量的线程,占用很大的系统资源;
- 连接创建后,若当前线程暂时没有数据可读,则该线程会阻塞在 read 操作,造成线程资源浪费。
- 针对传统阻塞 I/O 服务模型的缺点,给出以下解决方案:
-
基于 I/O 复用模型
:多个连接共用一个阻塞对象,应用程序只需要在一个阻塞对象等待,无需阻塞等待所有连接。当某个连接有新的数据可以处理时,操作系统通知应用程序,线程从阻塞状态返回,开始进行业务处理。
-
基于线程池复用线程资源
:不必再为每个连接创建线程,将连接完成后的业务处理任务分配给线程进行处理,一个线程可以处理多个连接的业务。
- Reactor模式有3钟叫法:①
反应器模式
;②分发者模式(Dispatcher)
;③通知者模式(notifier)
。
- 对上图的说明:
-
Reactor模式
:通过一个或多个输入同时传递给服务处理器的模式(基于事件驱动)。
- 服务器端程序处理传入的多个请求,并将它们同步分派到相应的处理线程,因此 Reactor 模式也叫
Dispatcher模式
。
- Reactor 模式使用 IO 复用监听事件,收到事件后,分发给某个线程(进程),这点就是网络服务器高并发的处理关键。
- 根据 Reactor 的数量和处理资源池线程的数量不同,有 3 种典型的实现:①
单Reactor单线程
;②单Reactor多线程
;③主从Reactor多线程
。Netty 主要基于主从Reactor多线程
模型做了一定的改进,其中主从 Reactor 多线程模型有多个 Reactor。
- 对上图的说明:
-
select
是前面 I/O 复用模型介绍的标准网络编程 API,可以实现应用程序通过一个阻塞对象监听多路连接请求;
- Reactor 对象通过 Select 监控客户端请求事件,收到事件后
Dispatch
分发给处理进程;
- 若是
建立连接请求事件
,则由 Acceptor 通过 Accept 处理连接请求,然后创建一个 Handler 对象处理连接完成后的后续业务处理;
- 若不是建立连接事件,则 Reactor 会分发调用连接对应的 Handler 来响应
Handler,会完成 Read → 业务处理 → Send 的完整业务流程。
- 优点:模型简单,没有多线程、进程通信、竞争的问题,全部都在一个线程中完成;
- 缺点:性能问题,只有一个线程,
无法完全发挥多核CPU的性能
。Handler在处理某个连接上的业务时,整个进程无法处理其他连接事件,很容易导致性能瓶颈。可靠性问题:线程意外终止,或者进入死循环,会导致整个系统通信模块不可用,不能接收和处理外部消息,造成节点故障。
- 使用场景:客户端的数量有限,业务处理非常快速,比如 Redis 在业务处理方面的时间复杂度为 的情况。
- 对上图的说明:
- Reactor 对象通过 Select 监控客户端请求事件,收到事件后,通过 Dispatch 进行分发;
- 若建立连接请求,则由 Acceptor 通过 accept 处理连接请求,然后创建一个 Handler 对象处理完成连接后的各种事件;
- 若不是连接请求,则由 Reactor 分发调用连接对应的 handler 来处理;
- handler 只负责响应事件,不做具体的业务处理,通过 read 读取数据后,会分发给后面的 worker 线程池的某个线程处理业务;
- worker 线程池会分配独立的线程完成真正的业务,并将结果返回给 handler;
- handler 收到响应后,通过 send 将结果返回给 client。
- 优点:可以充分的利用多核 cpu 的处理能力;
- 缺点:多线程数据共享和访问比较复杂,Reactor 处理所有的事件的监听和响应,在单线程中运行,在高并发场景时运行容易出现性能瓶颈。
- 对上图的说明:
- Reactor 主线程 MainReactor 对象通过 select 监听连接事件,收到事件后,通过 Acceptor 处理连接事件;
- 当 Acceptor 处理连接事件后,MainReactor 将连接分配给 SubReactor;
- Subreactor 将连接加入到连接队列进行监听,并创建 handler 进行各种事件处理,当有新事件发生时,Subreactor 就会调用对应的 handler 处理;
- handler 通过 read 读取数据,分发给后面的 worker 线程处理,worker 线程池分配独立的 worker 线程进行业务处理,并返回结果;
- handler 收到响应的结果后,再通过 send 将结果返回给 client;
- Reactor 主线程可以对应多个 Reactor 子线程,即 MainRecator 可以关联多个 SubReactor。
- 优点:父线程与子线程的数据交互简单职责明确,父线程只需要接收新连接,子线程完成后续的业务处理。父线程与子线程的数据交互简单,Reactor 主线程只需要把新连接传给子线程,子线程无需返回数据。
- 缺点:编程复杂度较高。
- 应用场景:这种模型在许多项目中广泛使用,包括 Nginx 主从 Reactor 多进程模型,Memcached 主从多线程,Netty 主从多线程模型的支持。
- Reactor模式的优点:①响应快,不必为单个同步时间所阻塞,虽然 Reactor 本身依然是同步的;②可以最大程度地避免复杂的多线程及同步问题、多线程/进程的切换带来的开销;③扩展性好,可以方便的通过增加 Reactor 实例个数来充分利用 CPU 资源;④复用性好,Reactor 模型本身与具体事件处理逻辑无关,具有很高的复用性。
- 对上图的说明:
- BossGroup 线程维护 Selector,只关注 Accecpt;
- 当接收到 Accept 事件,获取到对应的 SocketChannel,封装成 NIOScoketChannel,并注册到 Worker 线程(事件循环)进行维护;
- 当 Worker 线程监听到 Selector 中注册的通道发生自己感兴趣的事件后,就进行处理(由 handler来完成)。注意: handler 已经加入到通道。
- 对上图的说明:
- Netty 抽象出两组线程池:BossGroup 专门负责接收客户端的连接,WorkerGroup 专门负责网络的读写;
- BossGroup 和 WorkerGroup 类型都是 NioEventLoopGroup;
- NioEventLoopGroup 相当于一个事件循环组,这个组中含有多个事件循环,每一个事件循环是 NioEventLoop;
- NioEventLoop 表示一个不断循环的执行处理任务的线程,每个 NioEventLoop 都有一个 Selector,用于监听绑定在其上的 socket 的网络通讯;
- NioEventLoopGroup 可以有多个线程,即可以含有多个 NioEventLoop;
- 每个 BossNioEventLoop 循环执行的步骤有 3 步:
- 轮询 accept 事件;
- 处理 accept 事件,与 client 建立连接,生成 NioScocketChannel,并将其注册到某个 worker NIOEventLoop 上的 Selector;
- 处理任务队列的任务,即 runAllTasks;
- 每个 Worker NIOEventLoop 循环执行的步骤:
- 轮询 read,write 事件;
- 处理 I/O 事件,即 read,write 事件,在对应 NioScocketChannel 处理;
- 处理任务队列的任务,即 runAllTasks;
- 每个 Worker NIOEventLoop 处理业务时,会使用 pipeline(管道),pipeline 中包含了 channel,即通过 pipeline 可以获取到对应通道,管道中维护了很多的处理器。
- Netty入门案例:TCP通信。
- 导入maven依赖:
io.netty
netty-all
4.1.54.Final
import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.*;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.SocketChannel;
import io.netty.channel.socket.nio.NioServerSocketChannel;
public class NettyServer {
public static void main(String[] args) throws Exception {
//创建BossGroup 和 WorkerGroup
//说明
//1、创建两个线程组 bossGroup 和 workerGroup
//2、bossGroup 只是处理连接请求,真正的客户端业务处理是会交给 workerGroup 完成
//3、两个都是无限循环
//4、bossGroup 和 workerGroup 含有的子线程(NioEventLoop)的个数:默认值为 cpu核数 * 2
EventLoopGroup bossGroup = new NioEventLoopGroup(1);
EventLoopGroup workerGroup = new NioEventLoopGroup(); //8个
try {
//创建服务器端的启动对象,配置参数
ServerBootstrap bootstrap = new ServerBootstrap();
//使用链式编程来进行设置
bootstrap.group(bossGroup, workerGroup) //设置两个线程组
.channel(NioServerSocketChannel.class) //使用 NioSocketChannel 作为服务器的通道实现
.option(ChannelOption.SO_BACKLOG, 128) //设置线程队列等待连接的个数
.childOption(ChannelOption.SO_KEEPALIVE, true) //设置保持活动连接状态
//.handler(null) // 该 handler对应 bossGroup , childHandler 对应 workerGroup
.childHandler(new ChannelInitializer() { //创建一个通道初始化对象(匿名对象)
//给 pipeline 设置处理器
@Override
protected void initChannel(SocketChannel ch) throws Exception {
//可以使用一个集合管理 SocketChannel,在推送消息时,可以将业务加入到各个channel 对应的 NIOEventLoop 的 taskQueue 或者 scheduleTaskQueue 中
System.out.println("客户socketChannel hashcode=" + ch.hashCode());
ch.pipeline().addLast(new NettyServerHandler()); //给 workerGroup 的 EventLoop 对应的管道设置处理器
}
});
System.out.println(".....服务器 is ready...");
//绑定一个端口并且同步处理,生成了一个 ChannelFuture 对象
//启动服务器(并绑定端口)
ChannelFuture cf = bootstrap.bind(6668).sync();
//给 cf 注册监听器,监控我们关心的事件
//绑定端口是异步操作,当绑定操作处理完,将会调用相应的监听器处理逻辑
cf.addListener(new ChannelFutureListener() {
@Override
public void operationComplete(ChannelFuture future) throws Exception {
if (cf.isSuccess()) {
System.out.println("监听端口 6668 成功");
} else {
System.out.println("监听端口 6668 失败");
}
}
});
//对关闭通道进行监听
cf.channel().closeFuture().sync();
} finally {
bossGroup.shutdownGracefully();
workerGroup.shutdownGracefully();
}
}
}
import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.Channel;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;
import io.netty.util.CharsetUtil;
/**
* 说明:自定义一个Handler 需要继承 netty 规定好的某个HandlerAdapter(规范)
*/
public class NettyServerHandler extends ChannelInboundHandlerAdapter {
//读取数据实际(这里我们可以读取客户端发送的消息)
/**
* 1、ChannelHandlerContext ctx:上下文对象,含有管道 pipeline,通道channel,地址
* 2、Object msg:客户端发送的数据,默认是 Object
*/
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
System.out.println("服务器读取线程:" + Thread.currentThread().getName() + ",channel=" + ctx.channel());
System.out.println("server ctx:" + ctx);
System.out.println("看看channel 和 pipeline的关系");
Channel channel = ctx.channel();
//本质是一个双向链接, 出站入站
ctx.pipeline();
//将 msg 转成一个 ByteBuf
//ByteBuf 是 Netty 提供的,不是 NIO 的 ByteBuffer。
ByteBuf buf = (ByteBuf) msg;
System.out.println("客户端发送消息是:" + buf.toString(CharsetUtil.UTF_8));
System.out.println("客户端地址:" + channel.remoteAddress());
}
//数据读取完毕
@Override
public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
//writeAndFlush:write + flush
//将数据写入到缓存,并刷新
//一般需要对发送的数据进行编码
ctx.writeAndFlush(Unpooled.copiedBuffer("hello,客户端~(>^ω^<)喵1", CharsetUtil.UTF_8));
}
//发生异常时,需要关闭通道
@Override
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
ctx.close();
}
}
import io.netty.bootstrap.Bootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelInitializer;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.SocketChannel;
import io.netty.channel.socket.nio.NioSocketChannel;
public class NettyClient {
public static void main(String[] args) throws Exception {
//客户端需要一个事件循环组
EventLoopGroup group = new NioEventLoopGroup();
try {
//创建客户端启动对象
//注意客户端使用的不是 ServerBootstrap 而是 Bootstrap
Bootstrap bootstrap = new Bootstrap();
//设置相关参数
bootstrap.group(group) //设置线程组
.channel(NioSocketChannel.class) // 设置客户端通道的实现类(反射)
.handler(new ChannelInitializer() {
@Override
protected void initChannel(SocketChannel ch) throws Exception {
ch.pipeline().addLast(new NettyClientHandler()); //加入自定义的处理器
}
});
System.out.println("...客户端 is ok...");
//启动客户端去连接服务器端
//关于ChannelFuture 涉及到netty的异步模型
ChannelFuture channelFuture = bootstrap.connect("127.0.0.1", 6668).sync();
//给关闭通道进行监听
channelFuture.channel().closeFuture().sync();
} finally {
group.shutdownGracefully();
}
}
}
import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;
import io.netty.util.CharsetUtil;
public class NettyClientHandler extends ChannelInboundHandlerAdapter {
//当通道就绪就会触发该方法
@Override
public void channelActive(ChannelHandlerContext ctx) throws Exception {
System.out.println("client:" + ctx);
ctx.writeAndFlush(Unpooled.copiedBuffer("hello,server: (>^ω^<)喵", CharsetUtil.UTF_8));
}
//当通道有读取事件时,会触发
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
ByteBuf buf = (ByteBuf) msg;
System.out.println("服务器回复的消息:" + buf.toString(CharsetUtil.UTF_8));
System.out.println("服务器的地址:" + ctx.channel().remoteAddress());
}
//发生异常时,需要关闭通道
@Override
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
cause.printStackTrace();
ctx.close();
}
}
- 任务队列中的 Task 有 3 种典型使用场景:
- 用户程序自定义的普通任务;
- 用户自定义定时任务;
- 非当前 Reactor 线程调用 Channel 的各种方法:例如在推送系统的业务线程里面,根据用户的标识,找到对应的 Channel 引用,然后调用 Write 类方法向该用户推送消息,就会进入到这种场景,最终的 Write 会提交到任务队列中后被异步消费。
import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.Channel;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelInboundHandlerAdapter;
import io.netty.util.CharsetUtil;
import java.util.concurrent.TimeUnit;
/**
* 说明:自定义一个Handler 需要继承 netty 规定好的某个HandlerAdapter(规范)
*/
public class NettyServerHandler extends ChannelInboundHandlerAdapter {
//读取数据实际(这里我们可以读取客户端发送的消息)
/**
* 1、ChannelHandlerContext ctx:上下文对象,含有管道 pipeline,通道channel,地址
* 2、Object msg:客户端发送的数据,默认是 Object
* 假设这里有一个非常耗时长的业务 -> 异步执行 -> 提交该channel 对应的 NIOEventLoop 的 taskQueue中
*/
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
System.out.println("服务器读取线程:" + Thread.currentThread().getName() + ",channel=" + ctx.channel());
System.out.println("server ctx:" + ctx);
System.out.println("看看channel 和 pipeline的关系");
Channel channel = ctx.channel();
//本质是一个双向链接, 出站入站
ctx.pipeline();
//将 msg 转成一个 ByteBuf
//ByteBuf 是 Netty 提供的,不是 NIO 的 ByteBuffer。
ByteBuf buf = (ByteBuf) msg;
System.out.println("客户端发送消息是:" + buf.toString(CharsetUtil.UTF_8));
System.out.println("客户端地址:" + channel.remoteAddress());
//解决方案1:用户程序自定义的普通任务
ctx.channel().eventLoop().execute(new Runnable() {
@Override
public void run() {
try {
Thread.sleep(5 * 1000);
ctx.writeAndFlush(Unpooled.copiedBuffer("hello,客户端~(>^ω^<)喵2", CharsetUtil.UTF_8));
System.out.println("channel code:" + ctx.channel().hashCode());
} catch (Exception ex) {
System.out.println("发生异常" + ex.getMessage());
}
}
});
ctx.channel().eventLoop().execute(new Runnable() {
@Override
public void run() {
try {
Thread.sleep(5 * 1000);
ctx.writeAndFlush(Unpooled.copiedBuffer("hello,客户端~(>^ω^<)喵3", CharsetUtil.UTF_8));
System.out.println("channel code=" + ctx.channel().hashCode());
} catch (Exception ex) {
System.out.println("发生异常" + ex.getMessage());
}
}
});
//解决方案2 : 用户自定义定时任务 -> 该任务是提交到 scheduleTaskQueue中
ctx.channel().eventLoop().schedule(new Runnable() {
@Override
public void run() {
try {
Thread.sleep(5 * 1000);
ctx.writeAndFlush(Unpooled.copiedBuffer("hello,客户端~(>^ω^<)喵4", CharsetUtil.UTF_8));
System.out.println("channel code=" + ctx.channel().hashCode());
} catch (Exception ex) {
System.out.println("发生异常" + ex.getMessage());
}
}
}, 5, TimeUnit.SECONDS);
System.out.println("go on ...");
}
//数据读取完毕
@Override
public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
//writeAndFlush:write + flush
//将数据写入到缓存,并刷新
//一般需要对发送的数据进行编码
ctx.writeAndFlush(Unpooled.copiedBuffer("hello,客户端~(>^ω^<)喵1", CharsetUtil.UTF_8));
}
//发生异常时,需要关闭通道
@Override
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
ctx.close();
}
}
- 每个 NioEventLoop 中包含有一个 Selector,一个 taskQueue;每个 NioEventLoop 的 Selector 上可以注册监听多个 NioChannel;每个 NioChannel 只会绑定在唯一的 NioEventLoop 上;每个 NioChannel 都绑定有一个自己的 ChannelPipeline。
- 异步模型:当一个异步过程调用发出后,调用者不能立刻得到结果。实际处理这个调用的组件在完成后,通过状态、通知和回调来通知调用者。
- Netty 中的 I/O 操作是异步的,包括 Bind、Write、Connect 等操作会简单的返回一个 ChannelFuture。调用者并不能立刻获得结果,而是通过
Future-Listener
机制,用户可以方便地主动获取或者通过通知机制获得 IO 操作结果。
- Netty 的异步模型是建立在 future 和 callback 的之上的。callback 就是回调。重点说 Future,它的核心思想是:假设一个方法 fun,计算过程可能非常耗时,等待 fun 返回显然不合适。那么可以在调用 fun 的时候,立马返回一个 Future,后续可以通过 Future 去监控方法 fun 的处理过程(即:Future-Listener 机制)。
- Future说明:表示异步的执行结果,可以通过它提供的方法来检测执行是否完成,比如检索计算等等。
ChannelFuture
是一个接口:public interface ChannelFuture extends Future
,可以添加自己的监听器,当监听的事件发生时,就会通知到监听器。
- Future-Listener机制:当 Future 对象刚刚创建时,处于非完成状态,调用者可以通过返回的 ChannelFuture 来获取操作执行的状态,注册监听函数来执行完成后的操作。常见的操作如下:
- 通过
isDone
方法来判断当前操作是否完成;
- 通过
isSuccess
方法来判断已完成的当前操作是否成功;
- 通过
getCause
方法来获取已完成的当前操作失败的原因;
- 通过
isCancelled
方法来判断已完成的当前操作是否被取消;
- 通过
addListener
方法来注册监听器,当操作已完成(isDone方法返回完成),将会通知指定的监听器;若 Future 对象已完成,则通知指定的监听器。
- Netty入门案例:HTTP服务。
- TestServer.java
import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioServerSocketChannel;
public class TestServer {
public static void main(String[] args) throws Exception {
EventLoopGroup bossGroup = new NioEventLoopGroup(1);
EventLoopGroup workerGroup = new NioEventLoopGroup();
try {
ServerBootstrap serverBootstrap = new ServerBootstrap();
serverBootstrap.group(bossGroup, workerGroup).channel(NioServerSocketChannel.class).childHandler(new TestServerInitializer());
ChannelFuture channelFuture = serverBootstrap.bind(23333).sync();
channelFuture.channel().closeFuture().sync();
} finally {
bossGroup.shutdownGracefully();
workerGroup.shutdownGracefully();
}
}
}
- TestServerInitializer.java
import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.socket.SocketChannel;
import io.netty.handler.codec.http.HttpServerCodec;
public class TestServerInitializer extends ChannelInitializer {
@Override
protected void initChannel(SocketChannel ch) throws Exception {
//向管道加入处理器
//获取管道
ChannelPipeline pipeline = ch.pipeline();
//加入一个netty 提供的httpServerCodec codec =>[coder - decoder]
//HttpServerCodec 说明
//1、HttpServerCodec 是netty提供的处理http的编-解码器
pipeline.addLast("MyHttpServerCodec", new HttpServerCodec());
//2、增加一个自定义的handler
pipeline.addLast("MyTestHttpServerHandler", new TestHttpServerHandler());
System.out.println("ok~~~~");
}
}
- TestHttpServerHandler.java
import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.SimpleChannelInboundHandler;
import io.netty.handler.codec.http.*;
import io.netty.util.CharsetUtil;
import java.net.URI;
/**
* 1、SimpleChannelInboundHandler 是 ChannelInboundHandlerAdapter 的抽象子类
* 2、HttpObject 客户端和服务器端相互通讯的数据被封装成 HttpObject
*/
public class TestHttpServerHandler extends SimpleChannelInboundHandler {
//读取客户端数据
@Override
protected void channelRead0(ChannelHandlerContext ctx, HttpObject msg) throws Exception {
System.out.println("对应的channel=" + ctx.channel() + ",pipeline=" + ctx
.pipeline() + ",通过pipeline获取channel" + ctx.pipeline().channel());
System.out.println("当前ctx的handler=" + ctx.handler());
//判断 msg 是不是 http request请求
if (msg instanceof HttpRequest) {
System.out.println("ctx 类型=" + ctx.getClass());
System.out.println("pipeline hashcode" + ctx.pipeline().hashCode() + ",TestHttpServerHandler hash=" + this.hashCode());
System.out.println("msg 类型=" + msg.getClass());
System.out.println("客户端地址" + ctx.channel().remoteAddress());
HttpRequest httpRequest = (HttpRequest) msg;
//获取uri,过滤指定的资源
URI uri = new URI(httpRequest.uri());
if ("/favicon.ico".equals(uri.getPath())) {
System.out.println("请求了 favicon.ico,不做响应");
return;
}
//回复信息给浏览器 [http协议]
ByteBuf content = Unpooled.copiedBuffer("hello,我是服务器", CharsetUtil.UTF_8);
//构造一个http的响应,即 http response
FullHttpResponse response = new DefaultFullHttpResponse(HttpVersion.HTTP_1_1, HttpResponseStatus.OK, content);
response.headers().set(HttpHeaderNames.CONTENT_TYPE, "text/plain");
response.headers().set(HttpHeaderNames.CONTENT_LENGTH, content.readableBytes());
//将构建好 response 并返回
ctx.writeAndFlush(response);
}
}
}
- Netty 中 Bootstrap 类是客户端程序的启动引导类,ServerBootstrap 是服务端启动引导类。常见的方法有:
-
public ServerBootstrap group(EventLoopGroup parentGroup, EventLoopGroup childGroup)
:该方法用于服务器端,用来设置两个 EventLoop。
-
public B group(EventLoopGroup group)
:该方法用于客户端,用来设置一个 EventLoop。
-
public B channel(Class channelClass)
:该方法用来设置一个服务器端的通道实现。
-
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)
:该方法用于客户端,用来连接服务器端。
- 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 操作成功、失败或取消时回调通知调用方。Channel 支持关联 I/O 操作与对应的处理程序。不同协议、不同的阻塞类型的连接都有不同的 Channel 类型与之对应,常用的 Channel 类型:
-
NioSocketChannel
:异步的客户端 TCP Socket 连接。
-
NioServerSocketChannel
:异步的服务器端 TCP Socket 连接。
-
NioDatagramChannel
:异步的 UDP 连接。
-
NioSctpChannel
:异步的客户端 Sctp 连接。
-
NioSctpServerChannel
:异步的 Sctp 服务器端连接,这些通道涵盖了 UDP 和 TCP 网络 IO 以及文件 IO。
- Netty 基于 Selector 对象实现 I/O 多路复用,通过 Selector 一个线程可以监听多个连接的 Channel 事件。
- 当向一个 Selector 中注册 Channel 后,Selector 内部的机制就可以自动不断地查询(Select)这些注册的 Channel 是否有已就绪的 I/O 事件(例如可读,可写,网络连接完成等),这样程序就可以很简单地使用一个线程高效地管理多个 Channel。
- ChannelHandler 是一个接口,用于处理 I/O 事件或拦截 I/O 操作,并将其转发到其 ChannelPipeline(业务处理链)中的下一个处理程序。
- ChannelHandler 本身并没有提供很多方法,因为这个接口有许多的方法需要实现,方便使用期间,可以继承它的子类。
- 我们经常需要自定义一个 Handler 类去继承 ChannelInboundHandlerAdapter,然后通过重写相应方法实现业务逻辑,接下来看看一般都需要重写哪些方法:
- ChannelPipeline 是一个 Handler 的集合,它负责处理和拦截 inbound 或者 outbound 的事件和操作,相当于一个贯穿 Netty 的链。(也可以这样理解:ChannelPipeline 是保存 ChannelHandler 的 List,用于处理或拦截 Channel 的入站事件和出站操作)
- ChannelPipeline 实现了一种高级形式的拦截过滤器模式,使用户可以完全控制事件的处理方式,以及 Channel 中各个的 ChannelHandler 如何相互交互。
- 在 Netty 中每个 Channel 都有且仅有一个 ChannelPipeline 与之对应,它们的组成关系如下:
- ChannelPipeline 常用的相关方法:
ChannelPipeline addFirst(ChannelHandler... handlers)
:把一个业务处理类(handler)添加到链中的第一个位置;ChannelPipeline addLast(ChannelHandler... handlers)
:把一个业务处理类(handler)添加到链中的最后一个位置。
- ChannelHandlerContext 中包含一个具体的事件处理器 ChannelHandler,同时 ChannelHandlerContext 中也绑定了对应的 pipeline 和 Channel 的信息,方便对 ChannelHandler 进行调用。常用的方法如下:
-
ChannelFuture close()
:关闭通道。
-
ChannelOutboundInvoker flush()
:刷新。
-
ChannelFuture writeAndFlush(Object msg)
:将数据写到ChannelPipeline 中当前 ChannelHandler 的下一个 ChannelHandler 开始处理(出站)。
- Netty 在创建 Channel 实例后,一般都需要设置
ChannelOption
参数。
ChannelOption 参数如下:
-
ChannelOption.SO_BACKLOG
:对应 TCP/IP 协议 listen 函数中的 backlog 参数,用来初始化服务器可连接队列大小。因为服务端处理客户端连接请求是顺序处理的,所以同一时间只能处理一个客户端连接,多个客户端来的时候,服务端将不能处理的客户端连接请求放在队列中等待处理,backlog 参数指定了队列的大小。
-
ChannelOption.SO_KEEPALIVE
:一直保持连接活动状态。
-
EventLoopGroup
是一组 EventLoop 的抽象,Netty 为了更好地利用多核 CPU 资源,一般会有多个 EventLoop 同时工作,每个 EventLoop 维护着一个 Selector 实例。
-
EventLoopGroup
提供 next 接口,可以从组里面按照一定规则获取其中一个 EventLoop 来处理任务。在 Netty 服务器端编程中,一般都需要提供两个 EventLoopGroup,例如:BossEventLoopGroup 和 WorkerEventLoopGroup。常用的方法如下:
-
public NioEventLoopGroup()
:构造方法。
-
public Future shutdownGracefully()
:断开连接,关闭线程。
- 通常一个服务端口即一个 ServerSocketChannel 对应一个 Selector 和一个 EventLoop 线程。BossEventLoop 负责接收客户端的连接并将 SocketChannel 交给 WorkerEventLoopGroup 来进行 IO 处理,如下图所示:
- Netty 提供一个专门用来操作缓冲区(即 Netty 的数据容器)的工具类,常用的方法:
public static ByteBuf copiedBuffer(CharSequence string, Charset charset)
,类似于 NIO 中的 ByteBuffer 但有区别。
import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
public class NettyByteBuf01 {
public static void main(String[] args) {
//创建一个ByteBuf
//1、创建 ByteBuf 对象,该对象包含一个数组,是一个byte[10]
//2、在netty的buffer中,不需要使用flip进行反转,其底层维护了 readerIndex 和 writerIndex
//3、通过 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());//10
/*for (int i = 0; i < buffer.capacity(); i++) {
System.out.println(buffer.getByte(i));
}*/
for (int i = 0; i < buffer.capacity(); i++) {
System.out.println(buffer.readByte());
}
System.out.println("执行完毕");
}
}
import io.netty.buffer.ByteBuf;
import io.netty.buffer.Unpooled;
import java.nio.charset.StandardCharsets;
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()); // 64
//System.out.println(byteBuf.readByte()); //注意:若读取一个,则下面可读取的字节数将减1
System.out.println(byteBuf.getByte(0)); // 104
int len = byteBuf.readableBytes(); //返回可读的字节数 :12
System.out.println("len=" + len);
//使用for取出各个字节,注意:不会改变readerIndex的值
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));
System.out.println(byteBuf.getCharSequence(4, 6, StandardCharsets.UTF_8));
}
}
}