先看下Future的整個繼承體系,還有一個ChannelFuture不在里面;
在並發編程中,我們通常會用到一組非阻塞的模型:Promise,Future 和 Callback。其中的 Future 表示一個可能還沒有實際完成的異步任務的結果,針對這個結果可以添加 Callback 以便在任務執行成功或失敗后做出對應的操作,而 Promise 交由任務執行者,任務執行者通過 Promise 可以標記任務完成或者失敗。 可以說這一套模型是很多異步非阻塞架構的基礎。
這一套經典的模型在 Scala、C# 中得到了原生的支持,但 JDK 中暫時還只有無 Callback 的 Future 出現,當然也並非在 JAVA 界就沒有發展了,比如 Guava 就提供了ListenableFuture 接口,而 Netty 4+ 更是提供了完整的 Promise、Future 和 Listener 機制,在 Netty 的官方文檔 Using as a generic library 中也介紹了將 Netty 作為一個 lib 包依賴,並且使用 Listenable futures 的示例。在實際的項目使用中,發現 Netty 的 EventLoop 機制不一定適用其他場景,因此想去除對 EventLoop 的依賴,實現一個簡化版本。
Netty自己實現了一套並發庫,Future是其中的一塊,下篇文章講下他的並發庫的線程池實現。Netty的Future的特性
- Future<V>的V為異步結果的返回類型
- getNow 是無阻塞調用,返回異步執行結果,如果未完成那么返回null
- await 是阻塞調用,等到異步執行完成
- isSuccess 執行成功是否成功
- sync 阻塞調用,等待這個future直到isDone(可能由於正常終止、異常或取消而完成)返回true; 如果該future失敗,重新拋出失敗的原因。 和await區別就是返回結果不同,它返回一個Future對象,通過這個Future知道任務執行結果。
- 添加GenericFutureListener, 執行完成(future可能由於正常終止、異常或取消而完成)后調用該監聽器。
如果我實現這個Future怎么實現:1:任務執行器,這樣我們可以控制任務的執行了。2:執行結果,用於返回。3:監聽器集合。4:執行結果狀態
5:觸發監聽器的函數。那么
怎么執行完成后自定觸發監聽器,應該在Future里面又啟動了一個線程去執行這個觸發機制。這些都是我的猜想。看下他的子類怎么實現的:
AbstractFuture實現了JDK中的get方法,調用netty中future的方法,一個模板模式出現了。所有的Future都會繼承該類
Promise:任務執行者可以標記任務執行成功或失敗,添加了setFailure(Throwable)可以知道Promise的子類需要有個成員變量來保存異常,添加了setSuccess(V) 方法,setUncancellable()方法, 和tryFailure和trySuccess方法。這樣所有的操作都可以返回一個Promise,你自己檢測是否執行成功,好處是啥,接口統一嗎?
ScheduledFuture:一個定時任務的執行結果
ProgressiveFuture:可以跟蹤任務的執行進度。
下面看下幾個類的具體實現:
DefaultPromise:成員變量如下:
privatefinalEventExecutor executor; //任務執行器privatevolatileObject result;//不僅僅是結果,也有可能是異常-
* 一個或多個監聽器,可能是GenericFutureListener或者DefaultFutureListeners。如果是NULL有兩種可能
* 1:沒有添加觸發器
* 2:已經出發了 privateObject listeners;privateLateListeners lateListeners;privateshort waiters;
看來異常也是結果。
看一個重要方法的實現:
isDone:
可能由於正常終止、異常或取消而完成
privatestaticboolean isDone0(Object result){return result !=null&& result != UNCANCELLABLE;}
isSuccess: 任務執行成功
publicboolean isSuccess(){Object result =this.result;if(result ==null|| result == UNCANCELLABLE){returnfalse;}return!(result instanceofCauseHolder);}
getNow:返回執行結果
public V getNow(){Object result =this.result;if(result instanceofCauseHolder|| result == SUCCESS){returnnull;}return(V) result;}
sync:同步阻塞方法
@OverridepublicPromise<V> sync()throwsInterruptedException{await();rethrowIfFailed();returnthis;}
看來比await多了拋出異常。
await:等待任務執行完成
@OverridepublicPromise<V> await()throwsInterruptedException{if(isDone()){returnthis;}if(Thread.interrupted()){thrownewInterruptedException(toString());}synchronized(this){while(!isDone()){checkDeadLock();//判斷當前線程是否是執行線程。如果是拋出異常。incWaiters();//添加等待個數try{wait();//釋放鎖,等待喚醒,阻塞該線程}finally{decWaiters();}}}returnthis;}
執行器所在的線程不能調用await(),只能是調用者所在的線程才可以,waiters有什么用呢?
cancle方法使用:
@Overridepublicboolean cancel(boolean mayInterruptIfRunning){Object result =this.result;if(isDone0(result)|| result == UNCANCELLABLE){returnfalse;}synchronized(this){// Allow only once.result =this.result;if(isDone0(result)|| result == UNCANCELLABLE){returnfalse;}this.result = CANCELLATION_CAUSE_HOLDER;if(hasWaiters()){notifyAll();}}notifyListeners();returntrue;}
當我們修改DefaultPromise的狀態時,要觸發監聽器。
notifyListeners:
/*** 該方法不需要異步,為啥呢* 1:這個方法在同步代碼塊里面調用,因此任何監聽器列表的改變都happens-before該方法* 2:該方法只有isDone==true的時候調用,一但 isDone==true 那么監聽器列表將不會改變*/privatevoid notifyListeners(){Object listeners =this.listeners;if(listeners ==null){return;}EventExecutor executor = executor();if(executor.inEventLoop()){finalInternalThreadLocalMap threadLocals =InternalThreadLocalMap.get();finalint stackDepth = threadLocals.futureListenerStackDepth();if(stackDepth < MAX_LISTENER_STACK_DEPTH){threadLocals.setFutureListenerStackDepth(stackDepth +1);try{if(listeners instanceofDefaultFutureListeners){notifyListeners0(this,(DefaultFutureListeners) listeners);}else{finalGenericFutureListener<?extendsFuture<V>> l =(GenericFutureListener<?extendsFuture<V>>) listeners;notifyListener0(this, l);}}finally{this.listeners =null;threadLocals.setFutureListenerStackDepth(stackDepth);}return;}}if(listeners instanceofDefaultFutureListeners){finalDefaultFutureListeners dfl =(DefaultFutureListeners) listeners;execute(executor,newRunnable(){@Overridepublicvoid run(){notifyListeners0(DefaultPromise.this, dfl);DefaultPromise.this.listeners =null;}});}else{finalGenericFutureListener<?extendsFuture<V>> l =(GenericFutureListener<?extendsFuture<V>>) listeners;execute(executor,newRunnable(){@Overridepublicvoid run(){notifyListener0(DefaultPromise.this, l);DefaultPromise.this.listeners =null;}});}}
任務永遠不能在主線程中執行,需要放到執行器所在的線程執行。
DefaultFutureListeners和
GenericFutureListener,一個是容器,一個是元素
還有幾個修改狀態的方法:
@Overridepublicboolean setUncancellable(){Object result =this.result;if(isDone0(result)){return!isCancelled0(result);}synchronized(this){// Allow only once.result =this.result;if(isDone0(result)){return!isCancelled0(result);}this.result = UNCANCELLABLE;}returntrue;}privateboolean setFailure0(Throwable cause){if(cause ==null){thrownewNullPointerException("cause");}if(isDone()){returnfalse;}synchronized(this){// Allow only once.if(isDone()){returnfalse;}result =newCauseHolder(cause);if(hasWaiters()){notifyAll();}}returntrue;}privateboolean setSuccess0(V result){if(isDone()){returnfalse;}synchronized(this){// Allow only once.if(isDone()){returnfalse;}if(result ==null){this.result = SUCCESS;}else{this.result = result;}if(hasWaiters()){notifyAll();}}returntrue;}
CompleteFuture的幾個子類是狀態Promise
PromiseTask:該類繼承了RunnableFuture接口,該類表示異步操作的結果也可以異步獲得,類似JDK中的FutureTask,實例化該對象時候需要傳一個Callable的對象,如果沒有該對象可以傳遞一個Runnable和一個Result構造一個Callable對象。
privatestaticfinalclassRunnableAdapter<T>implementsCallable<T>{finalRunnable task;final T result;RunnableAdapter(Runnable task, T result){this.task = task;this.result = result;}@Overridepublic T call(){task.run();return result;}@OverridepublicString toString(){return"Callable(task: "+ task +", result: "+ result +')';}}
看下他的run方法。
@Overridepublicvoid run(){try{if(setUncancellableInternal()){V result = task.call();setSuccessInternal(result);}}catch(Throwable e){setFailureInternal(e);}
該類的setFailure,setSuccess等方法都會拋出一異常,而加了internal的方法會成功執行,他們是protected,子類或者同一個package中可以調用。
ScheduledFutureTask:該類是定時任務返回的
ChannelFuture是這個結構中最重要的類,從名稱可以知道是通道異步執行的結果:在netty中所有的IO操作都是異步的。這意味這所有的IO調用都會立即返回,且不保證IO操作完成。
IO調用會返回一個ChannelFuture的實例,通過該實例可以查看IO操作的結果和狀態,
ChannelFuture有完成和未完成兩種狀態,當IO操作開始,就會創建一個ChannelFuture的實例,該實例初始是未完成狀態,它不是成功,失敗,或者取消,因為IO操作還沒有完成,如果IO操作完成了那么將會有成功,失敗,和取消狀態,
* +---------------------------+
* | Completed successfully |
* +---------------------------+
* +----> isDone() = <b>true</b> |
* +--------------------------+ | | isSuccess() = <b>true</b> |
* | Uncompleted | | +===========================+
* +--------------------------+ | | Completed with failure |
* | isDone() = <b>false</b> | | +---------------------------+
* | isSuccess() = false |----+----> isDone() = <b>true</b> |
* | isCancelled() = false | | | cause() = <b>non-null</b> |
* | cause() = null | | +===========================+
* +--------------------------+ | | Completed by cancellation |
* | +---------------------------+
* +----> isDone() = <b>true</b> |
* | isCancelled() = <b>true</b> |
* +---------------------------+
該類提供了很多方法用來檢查IO操作是否完成,等待完成,和接受IO操作的結果。還可以添加ChannelFutureListener的監聽器,這樣IO操作完成時就可以得到提醒 * 強烈建議使用addListener而不是await。 * addListener是非阻塞的,它簡單的添加指定的ChannelFutureListener到ChannelFuture中, * IO線程將在當綁定在這個future的IO操作完成時,觸發這個觸發器,優點是提高效率和資源的利用率 * await()是一個阻塞方法,一旦調用,調用線程將會阻塞直到IO操作完成。優點是容易實現順序邏輯
