從原始碼角度詳解Java的Callable介面
摘要:本文從原始碼角度深入解析Callable介面。
本文分享自華為雲社群《深入解析Callable介面》,作者: 冰 河 。
本文純乾貨,從原始碼角度深入解析Callable介面,希望大家踏下心來,開啟你的IDE,跟著文章看原始碼,相信你一定收穫不小。
1.Callable介面介紹
Callable介面是JDK1.5新增的泛型介面,在JDK1.8中,被宣告為函式式介面,如下所示。
@FunctionalInterface public interface Callable<V> { V call() throws Exception; }
在JDK 1.8中只宣告有一個方法的介面為函式式介面,函式式介面可以使用@FunctionalInterface註解修飾,也可以不使用@FunctionalInterface註解修飾。只要一個介面中只包含有一個方法,那麼,這個介面就是函式式介面。
在JDK中,實現Callable介面的子類如下圖所示。
預設的子類層級關係圖看不清,這裡,可以通過IDEA右鍵Callable介面,選擇“Layout”來指定Callable介面的實現類圖的不同結構,如下所示。
這裡,可以選擇“Organic Layout”選項,選擇後的Callable介面的子類的結構如下圖所示。
在實現Callable介面的子類中,有幾個比較重要的類,如下圖所示。
分別是:Executors類中的靜態內部類:PrivilegedCallable、PrivilegedCallableUsingCurrentClassLoader、RunnableAdapter和Task類下的TaskCallable。
2.實現Callable介面的重要類分析
接下來,分析的類主要有:PrivilegedCallable、PrivilegedCallableUsingCurrentClassLoader、RunnableAdapter和Task類下的TaskCallable。雖然這些類在實際工作中很少被直接用到,但是作為一名合格的開發工程師,設定是禿頂的資深專家來說,瞭解並掌握這些類的實現有助你進一步理解Callable介面,並提高專業技能(頭髮再掉一批,哇哈哈哈。。。)。
- PrivilegedCallable
PrivilegedCallable類是Callable介面的一個特殊實現類,它表明Callable物件有某種特權來訪問系統的某種資源,PrivilegedCallable類的原始碼如下所示。
/** * A callable that runs under established access control settings */ static final class PrivilegedCallable<T> implements Callable<T> { private final Callable<T> task; private final AccessControlContext acc; PrivilegedCallable(Callable<T> task) { this.task = task; this.acc = AccessController.getContext(); } public T call() throws Exception { try { return AccessController.doPrivileged( new PrivilegedExceptionAction<T>() { public T run() throws Exception { return task.call(); } }, acc); } catch (PrivilegedActionException e) { throw e.getException(); } } }
從PrivilegedCallable類的原始碼來看,可以將PrivilegedCallable看成是對Callable介面的封裝,並且這個類也繼承了Callable介面。
在PrivilegedCallable類中有兩個成員變數,分別是Callable介面的例項物件和AccessControlContext類的例項物件,如下所示。
private final Callable<T> task; private final AccessControlContext acc;
其中,AccessControlContext類可以理解為一個具有系統資源訪問決策的上下文類,通過這個類可以訪問系統的特定資源。通過類的構造方法可以看出,在例項化AccessControlContext類的物件時,只需要傳遞Callable介面子類的物件即可,如下所示。
PrivilegedCallable(Callable<T> task) { this.task = task; this.acc = AccessController.getContext(); }
AccessControlContext類的物件是通過AccessController類的getContext()方法獲取的,這裡,檢視AccessController類的getContext()方法,如下所示。
public static AccessControlContext getContext(){ AccessControlContext acc = getStackAccessControlContext(); if (acc == null) { return new AccessControlContext(null, true); } else { return acc.optimize(); } }
通過AccessController的getContext()方法可以看出,首先通過getStackAccessControlContext()方法來獲取AccessControlContext物件例項。如果獲取的AccessControlContext物件例項為空,則通過呼叫AccessControlContext類的構造方法例項化,否則,呼叫AccessControlContext物件例項的optimize()方法返回AccessControlContext物件例項。
這裡,我們先看下getStackAccessControlContext()方法是個什麼鬼。
private static native AccessControlContext getStackAccessControlContext();
原來是個本地方法,方法的字面意思就是獲取能夠訪問系統棧的決策上下文物件。
接下來,我們回到PrivilegedCallable類的call()方法,如下所示。
public T call() throws Exception { try { return AccessController.doPrivileged( new PrivilegedExceptionAction<T>() { public T run() throws Exception { return task.call(); } }, acc); } catch (PrivilegedActionException e) { throw e.getException(); } }
通過呼叫AccessController.doPrivileged()方法,傳遞PrivilegedExceptionAction。介面物件和AccessControlContext物件,並最終返回泛型的例項物件。
首先,看下AccessController.doPrivileged()方法,如下所示。
@CallerSensitive public static native <T> T doPrivileged(PrivilegedExceptionAction<T> action, AccessControlContext context) throws PrivilegedActionException;
可以看到,又是一個本地方法。也就是說,最終的執行情況是將PrivilegedExceptionAction介面物件和AccessControlContext物件例項傳遞給這個本地方法執行。並且在PrivilegedExceptionAction介面物件的run()方法中呼叫Callable介面的call()方法來執行最終的業務邏輯,並且返回泛型物件。
- PrivilegedCallableUsingCurrentClassLoader
此類表示為在已經建立的特定訪問控制和當前的類載入器下執行的Callable類,原始碼如下所示。
/** * A callable that runs under established access control settings and * current ClassLoader */ static final class PrivilegedCallableUsingCurrentClassLoader<T> implements Callable<T> { private final Callable<T> task; private final AccessControlContext acc; private final ClassLoader ccl; PrivilegedCallableUsingCurrentClassLoader(Callable<T> task) { SecurityManager sm = System.getSecurityManager(); if (sm != null) { sm.checkPermission(SecurityConstants.GET_CLASSLOADER_PERMISSION); sm.checkPermission(new RuntimePermission("setContextClassLoader")); } this.task = task; this.acc = AccessController.getContext(); this.ccl = Thread.currentThread().getContextClassLoader(); } public T call() throws Exception { try { return AccessController.doPrivileged( new PrivilegedExceptionAction<T>() { public T run() throws Exception { Thread t = Thread.currentThread(); ClassLoader cl = t.getContextClassLoader(); if (ccl == cl) { return task.call(); } else { t.setContextClassLoader(ccl); try { return task.call(); } finally { t.setContextClassLoader(cl); } } } }, acc); } catch (PrivilegedActionException e) { throw e.getException(); } } }
這個類理解起來比較簡單,首先,在類中定義了三個成員變數,如下所示。
private final Callable<T> task; private final AccessControlContext acc; private final ClassLoader ccl;
接下來,通過構造方法注入Callable物件,在構造方法中,首先獲取系統安全管理器物件例項,通過系統安全管理器物件例項檢查是否具有獲取ClassLoader和設定ContextClassLoader的許可權。並在構造方法中為三個成員變數賦值,如下所示。
PrivilegedCallableUsingCurrentClassLoader(Callable<T> task) { SecurityManager sm = System.getSecurityManager(); if (sm != null) { sm.checkPermission(SecurityConstants.GET_CLASSLOADER_PERMISSION); sm.checkPermission(new RuntimePermission("setContextClassLoader")); } this.task = task; this.acc = AccessController.getContext(); this.ccl = Thread.currentThread().getContextClassLoader(); }
接下來,通過呼叫call()方法來執行具體的業務邏輯,如下所示。
public T call() throws Exception { try { return AccessController.doPrivileged( new PrivilegedExceptionAction<T>() { public T run() throws Exception { Thread t = Thread.currentThread(); ClassLoader cl = t.getContextClassLoader(); if (ccl == cl) { return task.call(); } else { t.setContextClassLoader(ccl); try { return task.call(); } finally { t.setContextClassLoader(cl); } } } }, acc); } catch (PrivilegedActionException e) { throw e.getException(); } }
在call()方法中同樣是通過呼叫AccessController類的本地方法doPrivileged,傳遞PrivilegedExceptionAction介面的例項物件和AccessControlContext類的物件例項。
具體執行邏輯為:在PrivilegedExceptionAction物件的run()方法中獲取當前執行緒的ContextClassLoader物件,如果在構造方法中獲取的ClassLoader物件與此處的ContextClassLoader物件是同一個物件(不止物件例項相同,而且記憶體地址也相同),則直接呼叫Callable物件的call()方法返回結果。否則,將PrivilegedExceptionAction物件的run()方法中的當前執行緒的ContextClassLoader設定為在構造方法中獲取的類載入器物件,接下來,再呼叫Callable物件的call()方法返回結果。最終將當前執行緒的ContextClassLoader重置為之前的ContextClassLoader。
- RunnableAdapter
RunnableAdapter類比較簡單,給定執行的任務和結果,執行給定的任務並返回給定的結果,原始碼如下所示。
/** * A callable that runs given task and returns given result */ static final class RunnableAdapter<T> implements Callable<T> { final Runnable task; final T result; RunnableAdapter(Runnable task, T result) { this.task = task; this.result = result; } public T call() { task.run(); return result; } }
- TaskCallable
TaskCallable類是javafx.concurrent.Task類的靜態內部類,TaskCallable類主要是實現了Callable介面並且被定義為FutureTask的類,並且在這個類中允許我們攔截call()方法來更新task任務的狀態。原始碼如下所示。
private static final class TaskCallable<V> implements Callable<V> { private Task<V> task; private TaskCallable() { } @Override public V call() throws Exception { task.started = true; task.runLater(() -> { task.setState(State.SCHEDULED); task.setState(State.RUNNING); }); try { final V result = task.call(); if (!task.isCancelled()) { task.runLater(() -> { task.updateValue(result); task.setState(State.SUCCEEDED); }); return result; } else { return null; } } catch (final Throwable th) { task.runLater(() -> { task._setException(th); task.setState(State.FAILED); }); if (th instanceof Exception) { throw (Exception) th; } else { throw new Exception(th); } } } }
從TaskCallable類的原始碼可以看出,只定義了一個Task型別的成員變數。下面主要分析TaskCallable類的call()方法。
當程式的執行進入到call()方法時,首先將task物件的started屬性設定為true,表示任務已經開始,並且將任務的狀態依次設定為State.SCHEDULED和State.RUNNING,依次觸發任務的排程事件和執行事件。如下所示。
task.started = true; task.runLater(() -> { task.setState(State.SCHEDULED); task.setState(State.RUNNING); });
接下來,在try程式碼塊中執行Task物件的call()方法,返回泛型物件。如果任務沒有被取消,則更新任務的快取,將呼叫call()方法返回的泛型物件繫結到Task物件中的ObjectProperty<V>物件中,其中,ObjectProperty<V>在Task類中的定義如下。
private final ObjectProperty<V> value = new SimpleObjectProperty<>(this, "value");
接下來,將任務的狀態設定為成功狀態。如下所示。
try { final V result = task.call(); if (!task.isCancelled()) { task.runLater(() -> { task.updateValue(result); task.setState(State.SUCCEEDED); }); return result; } else { return null; } }
如果程式丟擲了異常或者錯誤,會進入catch()程式碼塊,設定Task物件的Exception資訊並將狀態設定為State.FAILED,也就是將任務標記為失敗。接下來,判斷異常或錯誤的型別,如果是Exception型別的異常,則直接強轉為Exception型別的異常並丟擲。否則,將異常或者錯誤封裝為Exception物件並丟擲,如下所示。
catch (final Throwable th) { task.runLater(() -> { task._setException(th); task.setState(State.FAILED); }); if (th instanceof Exception) { throw (Exception) th; } else { throw new Exception(th); } }
好了,今天就到這兒吧,我是冰河,我們下期見~~