netty服务端向客户端发送数据_Netty-Pipeline组件知识点

首先我们知道,在NIO网络编程模型中,IO操作直接和channel相关,比如客户端的请求连接,或者向服务端发送数据, 服务端都要从客户端的channel获取这个数据

那么channelPipeline是什么?

其实,这个channelPepiline是Netty增加给原生的channel的组件,在ChannelPipeline接口的上的注解阐述了channelPipeline的作用,这个channelPipeline是高级过滤器的实现,netty将chanenl中数据导向channelPipeline,进而给了用户对channel中数据的百分百的控制权, 此外,channelPipeline数据结构是双向链表,每一个节点都是channelContext,channelContext里面维护了对应的handler和pipeline的引用, 大概总结一下: 通过chanelPipeline,用户客户轻松的往channel写数据,从channel读数据

创建pipeline#

通过前面几篇博客的追踪,我们知道无论我们是通过反射创建出服务端的channel也好,还是直接new创建客户端的channel也好,随着父类构造函数的逐层调用,最终我们都会在Channel体系的顶级抽象类AbstractChannel中,创建出Channel的一大组件 channelPipeline

于是我们程序的入口,AbstractChannel的pipeline = newChannelPipeline(); ,跟进去,看到他的源码如下:

Copyprotected DefaultChannelPipeline newChannelPipeline() { // todo 跟进去 return new DefaultChannelPipeline(this);}

可以看到,它创建了一个DefaultChannelPipeline(thisChannel)

DefaultChannelPipeline是channelPipeline的默认实现,他有着举足轻重的作用,我们看一下下面的 Channel ChannelContext ChannelPipeline的继承体系图,我们可以看到图中两个类,其实都很重要,

他们之间有什么关系呢?

当我们看完了DefaultChannelPipeline()构造中做了什么自然就知道了

Copy// todo 来到这里protected DefaultChannelPipeline(Channel channel) { this.channel = ObjectUtil.checkNotNull(channel, "channel"); // todo 把当前的Channel 保存起来 succeededFuture = new SucceededChannelFuture(channel, null); voidPromise = new VoidChannelPromise(channel, true); // todo 这两方法很重要 // todo 设置尾 tail = new TailContext(this); // todo 设置头 head = new HeadContext(this); // todo 双向链表关联 head.next = tail; tail.prev = head;}

主要做了如下几件事:

• 初始化succeededFuture
• 初始化voidPromise
• 创建尾节点
• 创建头节点
• 关联头尾节点

其实,到现在为止,pipiline的初始化已经完成了,我们接着往下看

此外,我们看一下DefaultChannelPipeline的内部类和方法,如下图()

我们关注我圈出来的几部分

• 两个重要的内部类
• 头结点 HeaderContext
• 尾节点 TailContext
• PendingHandlerAddedTask 添加完handler之后处理的任务
• PendingHandlerCallBack 添加完handler的回调
• PengdingHandlerRemovedTask 移除Handler之后的任务
• 大量的addXXX方法,

Copy final AbstractChannelHandlerContext head; final AbstractChannelHandlerContext tail;

跟进它的封装方法:

CopyTailContext(DefaultChannelPipeline pipeline) { super(pipeline, null, TAIL_NAME, true, false); setAddComplete(); }// todo 来到这里AbstractChannelHandlerContext(DefaultChannelPipeline pipeline, EventExecutor executor, String name, boolean inbound, boolean outbound) { this.name = ObjectUtil.checkNotNull(name, "name"); // todo 为ChannelContext的pipeline附上值了 this.pipeline = pipeline; this.executor = executor; this.inbound = inbound; this.outbound = outbound; // Its ordered if its driven by the EventLoop or the given Executor is an instanceof OrderedEventExecutor. ordered = executor == null || executor instanceof OrderedEventExecutor;}

我们可以看到,这个tail节点是inbound类型的处理器,一开始确实很纳闷,难道header不应该是Inbound类型的吗? 我也不买关子了,直接说为啥,

因为,对netty来说用发送过来的数据,要就从header节点开始往后传播,怎么传播呢? 因为是双向链表,直接找后一个节点,什么类型的节点呢? inbound类型的,于是数据msg就从header之后的第一个结点往后传播,如果说,一直到最后,都只是传播数据而没有任何处理就会传播到tail节点,因为tail也是inbound类型的, tail节点会替我们释放掉这个msg,防止内存泄露,当然如果我们自己使用了msg,而没往后传播,也没有释放,内存泄露是早晚的时,这就是为啥tail是Inbound类型的, header节点和它相反,在下面说

ok,现在知道了ChannelPipeline的创建了吧

Channelpipeline与ChannelHandler和ChannelHandlerContext之间的关系#

它三者的关系也直接说了, 在上面pipeline的创建的过程中, DefaultChannelPipeline中的头尾节点都是ChannelHandlerContext, 这就意味着, 在pipeline双向链表的结构中,每一个节点都是一个ChannelHandlerContext, 而且每一个 ChannelHandlerContext维护一个handler,这一点不信可以看上图,ChannelHandlerContext的实现类DefaultChannelHandlerContext的实现类, 源码如下:

Copyfinal class DefaultChannelHandlerContext extends AbstractChannelHandlerContext {// todo Context里面有了 handler的引用private final ChannelHandler handler;// todo 创建默认的 ChannelHandlerContext,DefaultChannelHandlerContext( DefaultChannelPipeline pipeline, EventExecutor executor, String name, ChannelHandler handler) { super(pipeline, executor, name, isInbound(handler), isOutbound(handler)); if (handler == null) { throw new NullPointerException("handler"); } this.handler = handler;

ChannelHandlerContext 接口同时继承ChannelOutBoundInvoker和和ChannelInBoundInvoker使得他同时拥有了传播入站事件和出站事件的能力, ChannelHandlerContext把事件传播之后,是谁处理的呢? 当然是handler 下面给出ChannelHandler的继承体系图,可以看到针对入站出来和出站处理ChannelHandler有不同的继承分支应对

添加一个新的节点:#

一般我们都是通过ChanelInitialezer动态的一次性添加多个handler, 下面就去看看,在服务端启动过程中,ServerBootStrap的init(),如下源码:解析我写在代码下面

Copy// todo 这是ServerBootStrapt对 他父类初始化 channel的实现, 用于初始化 NioServerSocketChannel@Overridevoid init(Channel channel) throws Exception {// todo ChannelOption 是在配置 Channel 的 ChannelConfig 的信息final Map, Object> options = options0();synchronized (options) { // todo 把 NioserverSocketChannel 和 options Map传递进去, 给Channel里面的属性赋值 // todo 这些常量值全是关于和诸如TCP协议相关的信息 setChannelOptions(channel, options, logger);} // todo 再次一波 给Channel里面的属性赋值 attrs0()是获取到用户自定义的业务逻辑属性 -- AttributeKeyfinal Map, Object> attrs = attrs0();// todo 这个map中维护的是 程序运行时的 动态的 业务数据 , 可以实现让业务数据随着netty的运行原来存进去的数据还能取出来synchronized (attrs) { for (Entry, Object> e : attrs.entrySet()) { @SuppressWarnings("unchecked") AttributeKey key = (AttributeKey) e.getKey(); channel.attr(key).set(e.getValue()); }}// todo------- options attrs : 都可以在创建BootStrap时动态的传递进去// todo ChannelPipeline 本身 就是一个重要的组件, 他里面是一个一个的处理器, 说他是高级过滤器,交互的数据 会一层一层经过它// todo 下面直接就调用了 p , 说明,在channel调用pipeline方法之前, pipeline已经被创建出来了!,// todo 到底是什么时候创建出来的 ? 其实是在创建NioServerSocketChannel这个通道对象时,在他的顶级抽象父类(AbstractChannel)中创建了一个默认的pipeline对象/// todo 补充: ChannelHandlerContext 是 ChannelHandler和Pipeline 交互的桥梁ChannelPipeline p = channel.pipeline();// todo workerGroup 处理IO线程final EventLoopGroup currentChildGroup = childGroup;// todo 我们自己添加的 Initializerfinal ChannelHandler currentChildHandler = childHandler;final Entry, Object>[] currentChildOptions;final Entry, Object>[] currentChildAttrs;// todo 这里是我们在Server类中添加的一些针对新连接channel的属性设置, 这两者属性被acceptor使用到!!!synchronized (childOptions) { currentChildOptions = childOptions.entrySet().toArray(newOptionArray(childOptions.size()));}synchronized (childAttrs) { currentChildAttrs = childAttrs.entrySet().toArray(newAttrArray(childAttrs.size()));}// todo 默认 往NioServerSocketChannel的管道里面添加了一个 ChannelInitializer ,// todo ( 后来我们自己添加的ChildHandler 就继承了的这个ChannelInitializer , 而这个就继承了的这个ChannelInitializer 实现了ChannelHandler)p.addLast(new ChannelInitializer() { // todo 进入addlast // todo 这个ChannelInitializer 方便我们一次性往pipeline中添加多个处理器 @Override public void initChannel(final Channel ch) throws Exception { final ChannelPipeline pipeline = ch.pipeline(); // todo 获取bootStrap的handler 对象, 没有返回空 // todo 这个handler 针对bossgroup的Channel , 给他添加上我们在server类中添加的handler()里面添加处理器 ChannelHandler handler = config.handler(); if (handler != null) { pipeline.addLast(handler); } // todo ServerBootstrapAcceptor 接收器, 是一个特殊的chanelHandler ch.eventLoop().execute(new Runnable() { @Override public void run() { // todo !!! -- 这个很重要,在ServerBootStrap里面,netty已经为我们生成了接收器 --!!! // todo 专门处理新连接的接入, 把新连接的channel绑定在 workerGroup中的某一条线程上 // todo 用于处理用户的请求, 但是还有没搞明白它是怎么触发执行的 pipeline.addLast(new ServerBootstrapAcceptor( // todo 这些参数是用户自定义的参数 // todo NioServerSocketChannel, worker线程组 处理器 关系的事件 ch, currentChildGroup, currentChildHandler, currentChildOptions, currentChildAttrs)); } }); }});

这个函数真的是好长,但是我们的重点放在ChannelInitializer身上, 现在的阶段, 当前的channel还没有注册上EventLoop上的Selector中

还有不是分析怎么添加handler? 怎么来这里了? 其实下面的 ServerBootstrapAcceptor就是一个handler

我们看一下上面的代码做了啥

Copych.eventLoop().execute(new Runnable() { @Override public void run() { // todo !!! -- 这个很重要,在ServerBootStrap里面,netty已经为我们生成了接收器 --!!! // todo 专门处理新连接的接入, 把新连接的channel绑定在 workerGroup中的某一条线程上 // todo 用于处理用户的请求, 但是还有没搞明白它是怎么触发执行的 pipeline.addLast(new ServerBootstrapAcceptor( // todo 这些参数是用户自定义的参数 // todo NioServerSocketChannel, worker线程组 处理器 关系的事件 ch, currentChildGroup, currentChildHandler, currentChildOptions, currentChildAttrs)); }});

懵逼不? 当时真的是给我整蒙圈了, 还没有关联上 EventLoop呢!!! 哪来的ch.eventLoop()....

后来整明白了,这其实是一个回调,netty提供给用户在任意时刻都可以往pipeline中添加handler的实现手段

那么在哪里回调呢? 其实是在 jdk原生的channel组册进EventLoop中的Selector后紧接着回调的,源码如下

Copyprivate void register0(ChannelPromise promise) { try { // check if the channel is still open as it could be closed in the mean time when the register // call was outside of the eventLoop if (!promise.setUncancellable() || !ensureOpen(promise)) { return; } boolean firstRegistration = neverRegistered; // todo 进入这个方法doRegister() // todo 它把系统创建的ServerSocketChannel 注册进了选择器 doRegister(); neverRegistered = false; registered = true;  // Ensure we call handlerAdded(...) before we actually notify the promise. This is needed as the // user may already fire events through the pipeline in the ChannelFutureListener. // todo 确保在 notify the promise前调用 handlerAdded(...) // todo 这是必需的，因为用户可能已经通过ChannelFutureListener中的管道触发了事件。 // todo 如果需要的话,执行HandlerAdded()方法 // todo 正是这个方法, 回调了前面我们添加 Initializer 中添加 Accpter的重要方法 pipeline.invokeHandlerAddedIfNeeded();

回调函数在pipeline.invokeHandlerAddedIfNeeded();, 看它的命名, 如果需要的话,执行handler已经添加完成了操作 哈哈,我们现在当然需要,刚添加了个ServerBootstrapAcceptor

在跟进入看源码之间,注意,方法是pipeline调用的, 那个pipeline呢? 就是上面我们说的DefaultChannelPipeline, ok,跟进源码,进入 DefaultChannelPipeline

Copy// todo 执行handler的添加,如果 需要的话final void invokeHandlerAddedIfNeeded() { assert channel.eventLoop().inEventLoop(); if (firstRegistration) { firstRegistration = false; // todo 现在我们的channel已经注册在bossGroup中的eventLoop上了, 是时候回调执行那些在注册前添加的 handler了 callHandlerAddedForAllHandlers(); }}

调用本类方法callHandlerAddedForAllHandlers(); 继续跟进下

Copy// todo 回调原来在没有注册完成之前添加的handlerprivate void callHandlerAddedForAllHandlers() { final PendingHandlerCallback pendingHandlerCallbackHead; synchronized (this) { assert !registered; // This Channel itself was registered. registered = true; pendingHandlerCallbackHead = this.pendingHandlerCallbackHead; // Null out so it can be GC'ed. this.pendingHandlerCallbackHead = null; } PendingHandlerCallback task = pendingHandlerCallbackHead; while (task != null) { task.execute(); task = task.next; }}

我们它的动作task.execute();

其中的task是谁? pendingHandlerCallbackHead 这是DefaultChannelPipeline的内部类, 它的作用就是辅助完成 添加handler之后的回调, 源码如下:

Copyprivate abstract static class PendingHandlerCallback implements Runnable { final AbstractChannelHandlerContext ctx; PendingHandlerCallback next; PendingHandlerCallback(AbstractChannelHandlerContext ctx) { this.ctx = ctx; } abstract void execute();}

我们跟进上一步的task.execute()就会看到它的抽象方法,那么是谁实现的呢? 实现类是PendingHandlerAddedTask同样是DefaultChannelPipeline的内部类, 既然不是抽象类了, 就得同时实现他父类PendingHandlerCallback的抽象方法,其实有两个一是个excute()另一个是run() --Runable

我们进入看它是如何实现excute,源码如下:

Copy@Overridevoid execute() {EventExecutor executor = ctx.executor();if (executor.inEventLoop()) { callHandlerAdded0(ctx);} else { try { executor.execute(this); } catch (RejectedExecutionException e) { if (logger.isWarnEnabled()) { logger.warn( "Can't invoke handlerAdded() as the EventExecutor {} rejected it, removing handler {}.