摘要:開天辟地今天我們來講講一個(gè)有一點(diǎn)點(diǎn)冷門的庫Dagger吧。我做一個(gè)不負(fù)責(zé)任的猜測(cè):做客戶端的同學(xué)可能比較少聽到一些名詞,比如面向切面編程、控制反轉(zhuǎn)、依賴注入,相信玩過Spring的同學(xué)肯定知道這些一開始讓人頭大后來卻很好玩的玩意兒。今天我們來介紹這款依賴注入器 —— Dagger2,源自Square的Dagger,由Google開發(fā),基于apt生成靜態(tài)編譯時(shí)的依賴注入工具,比動(dòng)態(tài)注入的方式更加高性
開天辟地
今天我們來講講一個(gè)有一點(diǎn)點(diǎn)冷門的庫Dagger吧。我做一個(gè)不負(fù)責(zé)任的猜測(cè):做客戶端的同學(xué)可能比較少聽到一些名詞,比如面向切面編程、控制反轉(zhuǎn)、依賴注入,相信玩過Spring的同學(xué)肯定知道這些一開始讓人頭大后來卻很好玩的玩意兒。
今天我們來介紹這款依賴注入器 —— Dagger2,源自Square的Dagger,由Google開發(fā),基于apt生成靜態(tài)編譯時(shí)的依賴注入工具,比動(dòng)態(tài)注入的方式更加高性能,但是需要更多的約定。
官網(wǎng):https://google.github.io/dagger/
組成
Dagger2(以下稱為Dagger) 主要由兩個(gè)部分組成:Component和Module。分別作為注入器和注入源存在于整個(gè)依賴圖中,然后有了源和工具,那么只用在我們需要注入的地方加上@Inject注解即可,它是屬于JSR-330的一部分,我們這里就直接引入一個(gè)最簡(jiǎn)單的Demo。
Module
@Module public class AppModule { Context mApplicationContext; public AppModule(Context context) { this.mApplicationContext = context; } @Provides public Context provideContext(){ return mApplicationContext; } @Provides public Service provideService(Context context) { return new Service(context, null); } }
這是世界的起源。
@Module注解表示這個(gè)類是個(gè)Module,是一個(gè)“源”。
@Provides注解告訴Dagger我們想要構(gòu)造對(duì)象并提供這些依賴。
Component
@Component(modules=AppModule.class) public interface AppComponent { void inject(App app); Context context(); Service service(); }
Component是一個(gè)接口,具體的實(shí)現(xiàn)由Dagger經(jīng)過apt工具為你生成(是不是有了apt就特別爽),我們給AppComponent這枚“針”指定了藥劑——AppModule,告訴它注入的時(shí)候,從AppModule里面拿到我們要的變量實(shí)例,只要給Component聲明一個(gè)無返回值,帶被注入類型形參的方法,Dagger 就會(huì)為這個(gè)類生成一個(gè)MemberInjector對(duì)象,用來給被注入類注入對(duì)象。
被注入對(duì)象
public class App extends Application { @Inject Service mService; private AppComponent mAppComponent; /** * 應(yīng)用程序初始化 */ @Override public void onCreate() { super.onCreate(); mAppComponent = DaggerAppComponent.builder() .appModule(new AppModule(this)) .build(); mAppComponent.inject(this); } public AppComponent getAppComponent() { return mAppComponent; } }
這里的DaggerAppComponent是Dagger生成的,它的實(shí)現(xiàn)類會(huì)在所有Component接口類之前增加一個(gè)Dagger前綴,我們只用傳入它所需要的依賴即可,Component顯然是依賴Module的,所以需要在這里傳入AppModule,現(xiàn)在,只要用Context的地方,我們都可以拿到這個(gè)AppComponent實(shí)例,只要有這個(gè)實(shí)例,我們可以在任意地方注入被管理的類。
作用域
我們說依賴注入的時(shí)候,作用域(Scope)是經(jīng)常會(huì)出現(xiàn)在我們眼里的詞匯??刂谱兞可芷冢瑢?shí)質(zhì)就是控制它存在的作用域,服務(wù)端典型的作用域如單例(Singleton),Request,Session,等等,它們的變量分別存在于不同的生命周期。
我們默認(rèn)存在的是Singleton,也就是@Singleton注解。由它標(biāo)注的Provider生成的對(duì)象會(huì)被緩存起來,用SingleCheck或者DoubleCheck進(jìn)行包裝。我們Provider指定的作用域需要和Component的作用域一致。
比如Component這樣定義:
@Singleton @Component(modules=AppModule.class) public interface AppComponent { void inject(App app); Service service(); }
而Module就是這個(gè)樣子
@Module public class AppModule { Context mApplicationContext; public AppModule(Context context) { this.mApplicationContext = context; } @Singleton @Provides public Context provideService(){ return new Service(); } }
限定符
Dagger還支持使用限定符(Qualifier)來指定注入的對(duì)象,比如內(nèi)置的@Named限定符,我們?cè)谛枰囟ㄏ薅值淖兞康臅r(shí)候,可以在@Inject上,指定@Named限定符,獲取指定對(duì)象。
//Module @Providers @Named("cache") public Service provideService(); // Injection @Inject @Named("cache") Service mService;
這樣就給這個(gè)mService注入了名字為"cache"的實(shí)例了。
一個(gè)簡(jiǎn)單場(chǎng)景的應(yīng)用
當(dāng)我們談?wù)撘蕾囎⑷氲臅r(shí)候,我們?cè)谡務(wù)撌裁?
其實(shí)我們是在討論 作用域。
這是什么意思呢,我相信每一個(gè)程序員去實(shí)現(xiàn)一個(gè)單例是一件非常簡(jiǎn)單的事情,makeInstance和getInstance嘛。但是,你們想過維護(hù)“雙例”嗎?我之前碰到了一個(gè)場(chǎng)景如下:
用戶(User) 需要一張tag表,會(huì)增刪查改,并和用戶相關(guān)聯(lián)。
問題(Question) 也需要一張tag表,也會(huì)增刪查改,和問題關(guān)聯(lián)。
這兩張表的實(shí)體模型一模一樣。
那么我們采取的方案有兩種,雙表,或者雙庫。雙表的話,對(duì)ORM很不友好,因?yàn)镺RM是根據(jù)類來確定表的,我們?yōu)榱舜a簡(jiǎn)潔優(yōu)雅,不可能創(chuàng)建兩個(gè)一模一樣的類,不然取名都變成一件困難的事。這里,一個(gè)優(yōu)勢(shì)是,我使用的ORM庫首先是維護(hù)一個(gè)單例,單例進(jìn)行CRUD操作,且一個(gè)單例和一個(gè)數(shù)據(jù)庫相關(guān)。于是我使用Qualifer的特性,生成了兩個(gè)實(shí)例(也就是對(duì)應(yīng)了兩個(gè)數(shù)據(jù)庫),分別注入到不同的業(yè)務(wù)模型中去,他們就可以使用同一個(gè)類,而且對(duì)tag的修改完全沒有影響。這件事要是我們自己去做的話,可能要寫很多骯臟不堪的代碼,但是Dagger只用2個(gè)注解就把我的需求解決了。
總結(jié)
好了,本文簡(jiǎn)單的闡述了Dagger入門使用,總結(jié)起來,我們只要約定好Componenet、Module,搭配Inject使用,即可實(shí)現(xiàn)一個(gè)靜態(tài)的依賴注入流程。下一次我們?cè)敿?xì)介紹Dagger生成的代碼結(jié)構(gòu)。