前言
最近在學(xué)習(xí)的過程中,發(fā)現(xiàn)了一個(gè)問題,抽象類在沒有實(shí)現(xiàn)所有的抽象方法前是不可以通過new來(lái)構(gòu)建該對(duì)象的,但是抽象方法卻是可以有自己的構(gòu)造方法的。這樣就把我搞糊涂了,既然有構(gòu)造方法,又不可以通過new來(lái)創(chuàng)建,那么抽象類在沒變成具體類的時(shí)候究竟可不可以實(shí)例化呢?
在Java 中抽象類是不能直接被實(shí)例化的。但是很多時(shí)候抽象類的該特點(diǎn)成為一個(gè)比較麻煩的阻礙。例如如果我想使用動(dòng)態(tài)代理來(lái)給一個(gè)抽象類賦予其執(zhí)行抽象方法的能力,就會(huì)有兩個(gè)困難:1. 動(dòng)態(tài)代理只能創(chuàng)建實(shí)現(xiàn)接口的一個(gè)代理對(duì)象,而不能是一個(gè)繼承抽象類的對(duì)象。為此標(biāo)準(zhǔn)的 JVM 中有一些實(shí)現(xiàn),例如 javassist 可以使用字節(jié)碼工具來(lái)完成這一目的(ProxyFactory)。
在 Android 中如果想構(gòu)造一個(gè)抽象類對(duì)象,恐怕只有 new ClassName() {}
或者繼承之后構(gòu)造了。但是這兩種方法都是不能由其 Class 對(duì)象直接操作的,這就導(dǎo)致一些問題上達(dá)不到我們需要的抽象能力。
這里詳細(xì)描述一下第一段所說的場(chǎng)景:
首先有一個(gè) interface 文件定義如下(熟悉 Android 的朋友可以看出這是一個(gè)提供給 Retrofit 生成代理對(duì)象的 Api 配置接口):
1
2
3
4
5
6
7
8
9
|
public interface RealApi { @GET ( "api1" ) Observable<String> api1(); @GET ( "api2" ) Observable<String> api2(); @GET ( "api3" ) Observable<String> api3(); //...其他方法 } |
其次再寫一個(gè)抽象類,只實(shí)現(xiàn)接口的其中一個(gè)方法(用來(lái)模擬接口數(shù)據(jù)):
1
2
3
4
5
6
|
@MockApi public abstract class MockApi implements RealApi { Observable<String> api3() { return Observable.just( "mock data" ); } } |
然后我們需要有一個(gè)工具,例如 MockManager ,讓他結(jié)合我們已存在的 RealApi 對(duì)象和 MockApi 類,來(lái)構(gòu)造出一個(gè)混合對(duì)象,該對(duì)象在執(zhí)行 MockApi 中已經(jīng)定義的方法時(shí),為直接執(zhí)行,在 MockApi 沒有定義該方法時(shí),去調(diào)用 RealApi 的方法。其調(diào)用方式大概為:
1
|
RealApi api = MockManager.build(realApi, MockApi. class ); |
通過 javassist,完成上述功能很簡(jiǎn)單,創(chuàng)建一個(gè) ProxyFactory 對(duì)象,設(shè)置其 Superclass 為MockApi,然后過濾抽象方法,設(shè)置 method handler 調(diào)用 realApi 對(duì)象的同名同參方法。這里就不再給出代碼實(shí)現(xiàn)。
但是在 Android 上,javassist 的該方法會(huì)拋出
1
2
3
4
|
Caused by: java.lang.UnsupportedOperationException: can't load this type of class file at java.lang.ClassLoader.defineClass(ClassLoader.java: 520 ) at java.lang.reflect.Method.invoke(Native Method) at javassist.util.proxy.FactoryHelper.toClass2(FactoryHelper.java: 182 ) |
類似的異常。原因大概是 Android 上的虛擬機(jī)的實(shí)現(xiàn)和標(biāo)準(zhǔn)略微不同,所以這里把方向轉(zhuǎn)為了動(dòng)態(tài)代碼生成的另一個(gè)方向 Annotation Processor。
使用 Annotation Processor 實(shí)現(xiàn)的話,思路就簡(jiǎn)單的多了,但過程還是有些曲折:
首先定義一個(gè)注解,用來(lái)標(biāo)記需要構(gòu)造對(duì)象的抽象類
1
2
3
4
5
|
@Target (ElementType.TYPE) @Documented @Retention (RetentionPolicy.SOURCE) public @interface MockApi { } |
Processor 根據(jù)注解來(lái)獲得類的 element 對(duì)象,該對(duì)象是一個(gè)類似 class 的對(duì)象。因?yàn)樵陬A(yù)編譯階段,class 尚未存在,此時(shí)使用 Class.forName
是不可以獲取運(yùn)行時(shí)需要的 Class 對(duì)象的,但是 Element 提供了類似 Class 反射相關(guān)的方法,也有 TypeElement、ExecutableElement 等區(qū)分。使用 Element 對(duì)象分析注解的抽象類的抽象方法有哪些,生成一個(gè)繼承該類的實(shí)現(xiàn)類(非抽象),并在該類中實(shí)現(xiàn)所有抽象方法,因?yàn)椴粫?huì)實(shí)際用到這些抽象方法,所以只需要能編譯通過就可以了,我選擇的方式是每個(gè)方法體都拋出一個(gè)異常,提示該方法為抽象方法不能直接調(diào)用。生成代碼的方法可以使用一些工具來(lái)簡(jiǎn)化工作,例如 AutoProcessor 和 JavaPoet,具體實(shí)現(xiàn)參考文尾的項(xiàng)目代碼,生成后的代碼大致像這樣:
1
2
3
4
5
6
7
8
9
10
11
|
// 生成的類名使用原類名+"$Impl"的后綴來(lái)命名,避免和其他類名沖突,后面也使用該約束進(jìn)行反射來(lái)調(diào)用該類 public final class MockApi$Impl extends MockApi { @Override public Observable<String> api1() { throw new IllegalStateException( "api1() is an abstract method!" ); } @Override public Observable<String> api2() { throw new IllegalStateException( "api2() is an abstract method!" ); } } |
根據(jù)該抽象類的類名去反射獲得該實(shí)現(xiàn)類,然后再根據(jù)反射調(diào)用其構(gòu)造方法構(gòu)造出一個(gè)實(shí)現(xiàn)對(duì)象。
1
2
3
4
5
6
7
8
|
// 獲得生成代碼構(gòu)造的對(duì)象 private static <T> T getImplObject(Class<T> cls) { try { return (T) Class.forName(cls.getName() + "$Impl" ).newInstance(); } catch (Exception e) { return null ; } } |
構(gòu)造一個(gè)動(dòng)態(tài)代理,傳入 RealApi 的真實(shí)對(duì)象,和上一步構(gòu)造出的抽象類的實(shí)現(xiàn)對(duì)象,根據(jù)抽象類中的定義來(lái)判斷由哪個(gè)對(duì)象代理其方法行為:如果抽象類中有定義,即該方法不是抽象方法,則抽象類的實(shí)現(xiàn)對(duì)象執(zhí)行;反之,由接口的真實(shí)對(duì)象執(zhí)行。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
public static <Origin, Mock extends Origin> Origin build( final Origin origin, final Class<Mock> mockClass) { // 如果 Mock Class 標(biāo)記為關(guān)閉,則直接返回真實(shí)接口對(duì)象 if (!isEnable(mockClass)) { return origin; } final Mock mockObject = getImplObject(mockClass); Class<?> originClass = origin.getClass().getInterfaces()[ 0 ]; return (Origin) Proxy.newProxyInstance(originClass.getClassLoader(), new Class[]{originClass}, new InvocationHandler() { @Override public Object invoke(Object o, Method method, Object[] objects) throws Throwable { // 獲取定義的抽象類中的同名方法,判斷是否已經(jīng)實(shí)現(xiàn) Method mockMethod = null ; try { mockMethod = mockClass.getDeclaredMethod(method.getName(), method.getParameterTypes()); } catch (NoSuchMethodException ignored) { } if (mockMethod == null || Modifier.isAbstract(mockMethod.getModifiers())) { return method.invoke(origin, objects); } else { return mockMethod.invoke(mockObject, objects); } } }); } |
完成上述工作以后,就可以像開頭所說的那樣,使用 build 方法來(lái)構(gòu)造一個(gè)混合了真實(shí)接口和抽象類方法的代理對(duì)象了,雖然調(diào)用的類本質(zhì)上還是硬編碼,但是由 Annotation Processor 自動(dòng)生成免于手動(dòng)維護(hù),使用上來(lái)講和使用 Javassist 實(shí)現(xiàn)還是基本相同的。
我用本文中所屬的方法實(shí)現(xiàn)了一個(gè)模擬 retrofit 請(qǐng)求的工具(文尾有鏈接),但本質(zhì)上可以用它來(lái)實(shí)現(xiàn)很多需要構(gòu)造抽象類的需求,更多的使用場(chǎng)景還有待挖掘。
文中提到的源碼實(shí)現(xiàn)可以在項(xiàng)目 retrofit-mock-result 中找到;
總結(jié)
以上就是這篇文章的全部?jī)?nèi)容了,希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,如果有疑問大家可以留言交流,謝謝大家對(duì)服務(wù)器之家的支持。
原文鏈接:https://twiceyuan.com/2017/04/07/instantiating-an-abstract-class-in-java/