文章目录
本文档整理并出自尚硅谷韩顺平Netty教程
https://www.bilibili.com/video/BV1DJ411m7NR
1、Netty出现的原因
1.1、原生NIO存在的问题
- NIO 的类库和 API 繁杂,使用麻烦:需要熟练掌握
Selector
、ServerSocketChannel
、SocketChannel
、ByteBuffer
等。 - 需要具备其他的额外技能:要熟悉
Java
多线程编程,因为NIO
编程涉及到Reactor
模式,你必须对多线程和网络编程非常熟悉,才能编写出高质量的 NIO 程序。 - 开发工作量和难度都非常大:例如客户端面临断连重连、网络闪断、半包读写、失败缓存、网络拥塞和异常流的处理等等。
- JDK NIO 的 Bug:例如臭名昭著的
Epoll Bug
,它会导致Selector
空轮询,最终导致CPU
100%。直到 JDK 1.7 版本该问题仍旧存在,没有被根本解决。
1.2、Netty优点
Netty
对JDK
自带的NIO
的API
进行了封装,解决了上述问题。- 设计优雅:适用于各种传输类型的统一
API
阻塞和非阻塞Socket
;基于灵活且可扩展的事件模型,可以清晰地分离关注点;高度可定制的线程模型 - 单线程,一个或多个线程池. - 安全:完整的
SSL/TLS
和StartTLS
支持 - 高性能、吞吐量更高:延迟更低;减少资源消耗;最小化不必要的内存复制。
2、I/O线程模型
目前存在的线程模型主要有:传统阻塞I/O服务模型,Reactor模型,根据Reactor
的数量和处理资源池线程的数量不同,有如下3
种典型的实现:
- 单
Reactor
单线程 - 单
Reactor
多线程 - 主从
Reactor
多线程
Netty
线程模型主要基于主从Reactor多线程模型做了一定的改进,其中主从Reactor
多线程模型有多个Reactor
。
2.1、传统阻塞I/O服务模型
图解说明:黄色的框表示对象,蓝色的框表示线程、白色的框表示方法(API)。之后的图相同。
2.1.1、模型分析
模型特点:
- 采用阻塞
IO
模式获取输入的数据 - 每个连接都需要独立的线程完成数据的输入,业务处理、数据返回。
问题分析:
- 当并发数很大,就会创建大量的线程,占用很大系统资源
- 连接创建后,如果当前线程暂时没有数据可读,该线程会阻塞在
read
操作,造成线程资源浪费
2.1.2、模型实现代码示例
由于模型的逻辑主要集中在服务端,所以所有模型代码示例基本上都是服务端的示例
public static void main(String[] args) throws IOException {
//1、创建一个线程池
//2、如果有客户端连接,就创建一个线程,与之通讯(单独写一个方法)
ExecutorService executorService = Executors.newCachedThreadPool();
//创建ServerSocket
ServerSocket serverSocket = new ServerSocket(6666);
System.out.println("服务器启动了");
while (true) {
//监听,等待客户端连接
final Socket socket = serverSocket.accept();
System.out.println("连接到一个客户端");
//创建一个线程,与之通讯
executorService.execute(() -> {
//重写Runnable方法,与客户端进行通讯
handler(socket);
});
}
}
//编写一个Handler方法,和客户端通讯。主要进行数据的读取和业务处理。
public static void handler(Socket socket) {
try {
byte[] bytes = new byte[1024];
//通过socket获取输入流
InputStream inputStream = socket.getInputStream();
//循环的读取客户端发送的数据
while (true){
int read = inputStream.read(bytes);
if (read != -1){
System.out.println(new String(bytes, 0, read));//输出客户端发送的数据
} else {
break;
}
}
} catch (IOException e) {
e.printStackTrace();
} finally {
System.out.println("关闭和client的连接");
try {
socket.close();
} catch (IOException e) {
e.printStackTrace();
}
}
}
2.2、Reactor模型概述
针对传统阻塞I/O服务模型的2个缺点,解决方案如下:
- 基于
I/O
复用模型:多个连接共用一个阻塞对象,应用程序只需要在一个阻塞对象等待,无需阻塞等待所有连接。当某个连接有新的数据可以处理时,操作系统通知应用程序,线程从阻塞状态返回,开始进行业务处理。Reactor
对应的叫法: 1. 反应器模式 2. 分发者模式(Dispatcher
) 3. 通知者模式(notifier
) - 基于线程池复用线程资源:不必再为每个连接创建线程,将连接完成后的业务处理任务分配给线程进行处理,一个线程可以处理多个连接的业务.
I/O复用结合线程池,就是Reactor模式基本设计思想,如图所示:
Reactor
模式,通过一个或多个输入同时传递给服务处理器的模式(基于事件驱动)- 服务器端程序处理传入的多个请求,并将它们同步分派到响应的处理线程,因此
Reactor
模式也叫Dispatcher
模式。 Reactor
模式使用IO
复用监听事件,收到事件后,分发的某个线程(进程),这点就是网络服务高并发处理的关键。
Reactor模式中的核心组成部分:
Reactor
:Reactor
在一个单独的线程中运行,负责监听和分发事件,分发给适当的处理程序来对IO
事件作出反应。Handlers
:处理程序执行I/O
事件要完成的实际事件,类似于客户想要与之交谈的公司中的实际官员。Reactor
通过调度适当的处理程序来响应I/O
事件,处理程序执行非阻塞操作。
2.3、单Reactor单线程模式
方案说明:
select
是前面I/O
复用模型介绍的标准网络编程 API,可以实现应用程序通过一个阻塞对象监听多路连接请求Reactor
对象通过select
监控客户端请求事件,收到事件后通过dispatch
进行分发- 如果是建立连接请求事件,则由
Acceptor
通过accept
处理连接请求,然后创建一个Handler
对象处理连接完成后的后续业务处理 - 如果不是建立连接事件,则
Reactor
会分发调用连接对应的Handler
来响应 Handler
会完成Read
→业务处理→Send
的完整业务流程
结合实例:服务器端用一个线程通过多路复用搞定所有的 IO
操作(包括连接,读、写等),编码简单,清晰明了,但是如果客户端连接数量较多,将无法支撑,前面的 NIO
案例就属于这种模型。
2.3.1、模型分析
- 优点:模型简单,没有多线程、进程通信、竞争的问题,全部都在一个线程中完成
- 缺点:性能问题,只有一个线程,无法完全发挥多核
CPU
的性能。Handler
在处理某个连接上的业务时,整个进程无法处理其他连接事件,很容易导致性能瓶颈 - 缺点:可靠性问题,线程意外终止,或者进入死循环,会导致整个系统通信模块不可用,不能接收和处理外部消息,造成节点故障
- 使用场景:客户端的数量有限,业务处理非常快速,比如
Redis
在业务处理的时间复杂度O(1)
的情况
2.4、单Reactor多线程模型
方案说明:
Reactor
对象通过select
监控客户端请求事件, 收到事件后,通过dispatch
进行分发- 如果建立连接请求, 则右
Acceptor
通过accept
处理连接请求, 然后创建一个Handler
对象处理完成连接后的各种事件 - 如果不是连接请求,则由
Reactor
分发调用连接对应的Handler
来处理 Handler
只负责响应事件,不做具体的业务处理, 通过read
读取数据后,会分发给后面的Worker
线程池的某个线程处理业务Worker
线程池会分配独立线程完成真正的业务,并将结果返回给Handler
Handler
收到响应后,通过send
将结果返回给client
2.4.1、模型分析
- 优点:可以充分的利用多核
cpu
的处理能力 - 缺点:多线程数据共享和访问比较复杂,
reactor
处理所有的事件的监听和响应,在单线程运行, 在高并发场景容易出现性能瓶颈
2.5、主从Reactor多线程
方案说明:
Reactor
主线程MainReactor
对象就只注册一个用于监听连接请求的ServerSocketChannel
,通过select
监听连接事件, 收到事件后,通过Acceptor
处理连接事件- 当
Acceptor
处理连接事件后,MainReactor
通过accept
获取新的连接,并将连接注册到SubReactor
Subreactor
将连接加入到连接队列进行监听,并创建Handler
进行各种事件处理- 当有新事件发生时,
subreactor
就会调用对应的handler
处理 Handler
通过read
读取数据,分发给后面的Worker
线程池处理Worker
线程池分配独立的worker
线程进行业务处理,并返回结果Handler
收到响应的结果后,再通过send
将结果返回给client
Reactor
主线程可以对应多个Reactor
子线程, 即MainRecator
可以关联多个SubReactor
2.5.1、模型分析
- 优点:父线程与子线程的数据交互简单职责明确,父线程只需要接收新连接,子线程完成后续的业务处理。
- 优点:父线程与子线程的数据交互简单,
Reactor
主线程只需要把新连接传给子线程,子线程无需返回数据 - 缺点:编程复杂度较高
- 结合实例:这种模型在许多项目中广泛使用,包括
Nginx
主从Reactor
多进程模型,Memcached
主从多线程,Netty
主从多线程模型的支持
3、Netty模型
3.1、主从Reactor进阶
Netty
主要是基于主从Reactor
多线程模式做了一定的改进,其中主从Reactor
都由单一的一个变成了多个。下面是简单的改进图。
- 如图所示,增加了
BossGroup
来维护多个主Reactor
,主Reactor
还是只关注连接的Accept
;增加了WorkGroup
来维护多个从Reactor
,从Reactor
将接收到的请求交给Handler
进行处理。 - 在主
Reactor
中接收到Accept
事件,获取到对应的SocketChannel
,Netty
会将它进一步封装成NIOSocketChannel
对象,这个封装后的对象还包含了该Channel
对应的SelectionKey
、通信地址等详细信息 Netty
会将装个封装后的Channel
对象注册到WorkerGroup
中的从Reactor
中。- 当
WorkerGroup
中的从Reactor
监听到事件后,就会将之交给与此Reactor
对应的Handler
进行处理。
3.2、再进阶版
Netty
将Selector
以及Selector
相关的事件及任务封装了NioEventLoop
,这样BossGroup
就可以通过管理NioEventLoop
去管理各个Selector
。- 同时,
Netty
模型中主要存在两个大的线程池组BossGroup
和WorkerGroup
,用于管理主Reactor
线程和从Reactor
线程。
3.3、Netty模型
-
Netty
抽象出两组线程池,BossGroup
专门负责接收客户端的连接,WorkerGroup
专门负责网络的读写 -
BossGroup
和WorkerGroup
类型的本质都是NioEventLoopGroup
类型。 -
NioEventLoopGroup
相当于一个线程管理器(类似于ExecutorServevice
),它下面维护很多个NioEventLoop
线程。- 在初始化这两个
Group
线程组时,默认会在每个Group
中生成CPU*2
个NioEventLoop
线程 - 当
n
个连接来了,Group
默认会按照连接请求的顺序分别将这些连接分给各个NioEventLoop
去处理。 - 同时
Group
还负责管理EventLoop
的生命周期。
- 在初始化这两个
-
NioEventLoop
表示一个不断循环的执行处理任务的线程- 它维护了一个线程和任务队列。
- 每个
NioEventLoop
都包含一个Selector
,用于监听绑定在它上面的socket
通讯。 - 每个
NioEventLoop
相当于Selector
,负责处理多个Channel
上的事件 - 每增加一个请求连接,
NioEventLoopGroup
就将这个请求依次分发给它下面的NioEventLoop
处理。
-
每个
Boss NioEventLoop
循环执行的步骤有3步:- 轮询
accept
事件 - 处理
accept
事件,与client
建立连接,生成NioSocketChannel
,并将其注册到某个Worker NioEventLoop
的selector
上。 - 处理任务队列到任务,即
runAllTasks
- 轮询
-
每个
Worker NioEventLoop
循环执行的步骤:- 轮询
read
,write
事件 - 处理
I/O
事件,即read
,write
事件,在对应的NioSocketChannel
中进行处理 - 处理任务队列的任务,即
runAllTasks
- 轮询
-
每个
Worker NioEventLoop
处理业务时,会使用pipeline
(管道),pipeline
中维护了一个ChannelHandlerContext
链表,而ChannelHandlerContext
则保存了Channel
相关的所有上下文信息,同时关联一个ChannelHandler
对象。如图所示,Channel
和pipeline
一一对应,ChannelHandler
和ChannelHandlerContext
一一对应。 -
ChannelHandler
是一个接口,负责处理或拦截I/O
操作,并将其转发到Pipeline
中的下一个处理Handler
进行处理。
3.4、代码示例
服务端代码:
public class NettyServer {
public static void main(String[] args) throws InterruptedException {
//创建BossGroup 和 WorkerGroup
//1、创建两个线程组,bossGroup 和 workerGroup
//2、bossGroup 只是处理连接请求,真正的和客户端业务处理,会交给 workerGroup 完成
//3、两个都是无限循环
//4、bossGroup 和 workerGroup 含有的子线程(NioEventLoop)个数为实际 cpu 核数 * 2
EventLoopGroup bossGroup = new NioEventLoopGroup();
EventLoopGroup workerGroup = new NioEventLoopGroup();
try {
//创建服务器端的启动对象,配置参数
ServerBootstrap bootstrap = new ServerBootstrap();
//使用链式编程来进行设置,配置
bootstrap.group(bossGroup, workerGroup) //设置两个线程组
.channel(NioServerSocketChannel.class) //使用 NioServerSocketChannel 作为服务器的通道实现
.option(ChannelOption.SO_BACKLOG, 128) //设置线程队列得到连接个数
.childOption(ChannelOption.SO_KEEPALIVE, true) //设置保持活动连接状态
.childHandler(new ChannelInitializer<SocketChannel>() { //为accept channel的pipeline预添加的handler
//给 pipeline 添加处理器,每当有连接accept时,就会运行到此处。
@Override
protected void initChannel(SocketChannel socketChannel) throws Exception {
socketChannel.pipeline().addLast(new NettyServerHandler());
}
}); //给我们的 workerGroup 的 EventLoop 对应的管道设置处理器
System.out.println("........服务器 is ready...");
//绑定一个端口并且同步,生成了一个ChannelFuture 对象
//启动服务器(并绑定端口)
ChannelFuture future = bootstrap.bind(6668).sync();
//对关闭通道进行监听
future.channel().closeFuture().sync();
} finally {
bossGroup.shutdownGracefully();
workerGroup.shutdownGracefully();
}
}
}
服务端Handler处理:
public class NettyServerHandler extends ChannelInboundHandlerAdapter {
/**
*读取客户端发送过来的消息
* @param ctx 上下文对象,含有 管道pipeline,通道channel,地址
* @param msg 就是客户端发送的数据,默认Object
* @throws Exception
*/
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
System.out.println("服务器读取线程:" + Thread.currentThread().getName());
System.out.println("server ctx = " + ctx);
//看看Channel和Pipeline的关系
Channel channel = ctx.channel();
ChannelPipeline pipeline = ctx.pipeline(); //本质是个双向链表,出栈入栈
//将msg转成一个ByteBuf,比NIO的ByteBuffer性能更高
ByteBuf buf = (ByteBuf)msg;
System.out.println("客户端发送的消息是:" + buf.toString(CharsetUtil.UTF_8));
System.out.println("客户端地址:" + ctx.channel().remoteAddress());
}
//数据读取完毕
@Override
public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
//它是 write + flush,将数据写入到缓存buffer,并将buffer中的数据flush进通道
//一般讲,我们对这个发送的数据进行编码
ctx.writeAndFlush(Unpooled.copiedBuffer("hello, 客户端~", CharsetUtil.UTF_8));
}
//处理异常,一般是关闭通道
@Override
public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
ctx.close();
}
}
客户端:
public class NettyClient {
public static void main(String[] args) throws InterruptedException {
//客户端需要一个事件循环组
EventLoopGroup group = new NioEventLoopGroup();
try {
//创建客户端启动对象
//注意:客户端使用的不是 ServerBootStrap 而是 Bootstrap
Bootstrap bootstrap = new Bootstrap();
//设置相关参数
bootstrap.group(group) //设置线程组
.channel(NioSocketChannel.class) //设置客户端通道的实现类(使用反射)
.handler(new ChannelInitializer<SocketChannel>() {
@Override
protected void initChannel(SocketChannel socketChannel) throws Exception {
socketChannel.pipeline().addLast(new NettyClientHandler()); //加入自己的处理器
}
});
System.out.println("客户端 OK...");
//启动客户端去连接服务器端
//关于 channelFuture 涉及到 netty 的异步模型
ChannelFuture channelFuture = bootstrap.connect("127.0.0.1", 6668).sync();
//给关闭通道进行监听
channelFuture.channel().closeFuture().sync();
} finally {
group.shutdownGracefully();
}
}
}
客户端Handler处理:
public class NettyClientHandler extends ChannelInboundHandlerAdapter {
/**
* 当通道就绪就会触发
* @param ctx
* @throws Exception
*/
@Override
public void channelActive(ChannelHandlerContext ctx) throws Exception {
System.out.println("client: " + ctx);
ctx.writeAndFlush(Unpooled.copiedBuffer("hello, server", CharsetUtil.UTF_8));
}
/**
* 当通道有读取事件时,会触发
* @param ctx
* @param msg
* @throws Exception
*/
@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();
}
}
3.5、任务队列
任务队列由NioEventLoop
维护并不断执行。当我们就收到请求之后,在当前channel
对应的pipeline
中的各个Handler
里面进行业务处理和请求过滤。当某些业务需要耗费大量时间的时候,我们可以将任务提交到由NioEventLoop
维护的taskQueue
或scheduleTaskQueue
中,让当前的NioEventLoop
线程在空闲时间去执行这些任务。下面将介绍提交任务的3种方式:
-
用户程序自定义的普通任务:
该方式会将任务提交到
taskQueue
队列中。提交到该队列中的任务会按照提交顺序依次执行。channelHandlerContext.channel().eventLoop().execute(new Runnable(){ @Override public void run() { //... } });
-
用户自定义的定时任务:
该方式会将任务提交到
scheduleTaskQueue
定时任务队列中。该队列是底层是优先队列PriorityQueue
实现的,固该队列中的任务会按照时间的先后顺序定时执行。channelHandlerContext.channel().eventLoop().schedule(new Runnable() { @Override public void run() { } }, 60, TimeUnit.SECONDS);
-
其他EventLoop线程对应的Channel添加任务:
可以在
ChannelInitializer
中,将刚创建的各个Channel
以及对应的标识加入到统一的集合中去,然后可以根据标识获取Channel
以及其对应的NioEventLoop
,然后就可调用execute()
或者schedule()
方法。
3.6、异步模型
基本介绍
- 异步的概念和同步相对。当一个异步过程调用发出后,调用者不能立刻得到结果。实际处理这个调用的组件在完成后,通过状态、通知和回调来通知调用者。
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<Void>
。我们可以添加监听器,当监听的事件发生时,就会通知到监听器
Future-Listener机制
-
当
Future
对象刚刚创建时,处于非完成状态,调用者可以通过返回的ChannelFuture
来获取操作执行的状态,注册监听函数来执行完成后的操作。 -
常用方法如下:
方法名称 方法作用 isDone() 判断当前操作是否完成 isSuccess() 判断已完成的当前操作是否成功 getCause() 获取已完成当前操作失败的原因 isCancelled() 判断已完成的当前操作是否被取消 addListener() 注册监听器,当前操作(Future)已完成,将会通知指定的监听器
举例说明
绑定端口操作时异步操作,当绑定操作处理完,将会调用相应的监听器处理逻辑。
serverBootstrap.bind(port).addListener(future -> {
if(future.isSuccess()) {
System.out.println(newDate() + ": 端口["+ port + "]绑定成功!");
} else{
System.err.println("端口["+ port + "]绑定失败!");
}
});
3.7、快速入门实例-HTTP HelloWorld
浏览器访问Netty
服务器后,返回HelloWorld
服务端
public class HttpServer {
public static void main(String[] args) {
NioEventLoopGroup bossGroup = new NioEventLoopGroup();
NioEventLoopGroup workerGroup = new NioEventLoopGroup();
try {
ServerBootstrap bootstrap = new ServerBootstrap();
bootstrap.group(bossGroup,workerGroup)
.channel(NioServerSocketChannel.class)
.childHandler(new HttpServerInitializer());
ChannelFuture channelFuture = bootstrap.bind(8080).sync();
channelFuture.channel().closeFuture().sync();
}catch (Exception e){
e.printStackTrace();
}finally {
bossGroup.shutdownGracefully();
workerGroup.shutdownGracefully();
}
}
}
定义ChannelInitializer
用于给Channel
对应的pipeline
添加handler
。该ChannelInitializer
中的代码在SocketChannel
被创建时都会执行
public class HttpServerInitializer extends ChannelInitializer<SocketChannel> {
@Override
protected void initChannel(SocketChannel ch) throws Exception {
//向管道加入处理器
//得到管道
ChannelPipeline pipeline = ch.pipeline();
//加入一个netty提供的httpServerCodec(编解码器)
pipeline.addLast("MyHttpServerCodec",new HttpServerCodec());
//增加自定义的Handler
pipeline.addLast("MyHttpServerHandler",new HttpServerHandler());
}
}
自定义Handler
public class HttpServerHandler extends SimpleChannelInboundHandler<HttpObject> {
/**
* 读取客户端数据
*
* @param ctx
* @param msg
* @throws Exception
*/
@Override
protected void channelRead0(ChannelHandlerContext ctx, HttpObject msg) throws Exception {
//判断msg是不是HttpRequest请求
if(msg instanceof HttpRequest){
System.out.println("msg类型:"+msg.getClass());
System.out.println("客户端地址:"+ctx.channel().remoteAddress());
HttpRequest request = (HttpRequest) msg;
//获取uri,进行路径过滤
URI uri = new URI(request.uri());
if("/favicon.ico".equals(uri.getPath())){
System.out.println("请求了favicon.ico,不作响应");
}
//回复信息给浏览器
ByteBuf content = Unpooled.copiedBuffer("Hello,客户端!!", CharsetUtil.UTF_8);
//构造一个HttpResponse
DefaultFullHttpResponse 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);
}
}
}