開天辟地
今天我們來講講一個有一點點冷門的庫dagger吧。我做一個不負責任的猜測:做用戶端的同學可能比較少聽到一些名詞,比如面向切面程式設計、控制反轉、依賴注入,相信玩過spring的同學肯定知道這些一開始讓人頭大後來卻很好玩的玩意兒。
今天我們來介紹這款依賴注入器 —— dagger2,源自square的dagger,由google開發,基于apt生成靜态編譯時的依賴注入工具,比動态注入的方式更加高性能,但是需要更多的約定。
組成
dagger2(以下稱為dagger) 主要由兩個部分組成:component和module。分别作為注入器和注入源存在于整個依賴圖中,然後有了源和工具,那麼隻用在我們需要注入的地方加上@inject注解即可,它是屬于jsr-330的一部分,我們這裡就直接引入一個最簡單的demo。
module
@module
public class appmodule {
context mapplicationcontext;
public appmodule(context context) {
this.mapplicationcontext = context;
}
@provides
public context providecontext(){
return mapplicationcontext;
public service provideservice(context context) {
return new service(context, null);
}
這是世界的起源。
@module注解表示這個類是個module,是一個“源”。
@provides注解告訴dagger我們想要構造對象并提供這些依賴。
component
@component(modules=appmodule.class)
public interface appcomponent {
void inject(app app);
context context();
service service();
component是一個接口,具體的實作由dagger經過apt工具為你生成(是不是有了apt就特别爽),我們給appcomponent這枚“針”指定了藥劑——appmodule,告訴它注入的時候,從appmodule裡面拿到我們要的變量執行個體,隻要給component聲明一個無傳回值,帶被注入類型形參的方法,dagger 就會為這個類生成一個memberinjector對象,用來給被注入類注入對象。
被注入對象
public class app extends application {
@inject service mservice;
private appcomponent mappcomponent;
/**
* 應用程式初始化
*/
@override
public void oncreate() {
super.oncreate();
mappcomponent = daggerappcomponent.builder()
.appmodule(new appmodule(this))
.build();
mappcomponent.inject(this);
public appcomponent getappcomponent() {
return mappcomponent;
這裡的daggerappcomponent是dagger生成的,它的實作類會在所有component接口類之前增加一個dagger字首,我們隻用傳入它所需要的依賴即可,component顯然是依賴module的,是以需要在這裡傳入appmodule,現在,隻要用context的地方,我們都可以拿到這個appcomponent執行個體,隻要有這個執行個體,我們可以在任意地方注入被管理的類。
作用域
我們說依賴注入的時候,作用域(scope)是經常會出現在我們眼裡的詞彙。控制變量生命周期,實質就是控制它存在的作用域,服務端典型的作用域如單例(singleton),request,session,等等,它們的變量分别存在于不同的生命周期。
我們預設存在的是singleton,也就是@singleton注解。由它标注的provider生成的對象會被緩存起來,用singlecheck或者doublecheck進行包裝。我們provider指定的作用域需要和component的作用域一緻。
比如component這樣定義:
@singleton
而module就是這個樣子
@singleton
public context provideservice(){
return new service();
限定符
dagger還支援使用限定符(qualifier)來指定注入的對象,比如内置的@named限定符,我們在需要特定限定名字的變量的時候,可以在@inject上,指定@named限定符,擷取指定對象。
//module
@providers
@named("cache")
public service provideservice();
// injection
@inject
service mservice;
這樣就給這個mservice注入了名字為"cache"的執行個體了。
一個簡單場景的應用
當我們談論依賴注入的時候,我們在談論什麼?
其實我們是在讨論 作用域。
這是什麼意思呢,我相信每一個程式員去實作一個單例是一件非常簡單的事情,makeinstance和getinstance嘛。但是,你們想過維護“雙例”嗎?我之前碰到了一個場景如下:
使用者(user) 需要一張tag表,會增删查改,并和使用者相關聯。
問題(question) 也需要一張tag表,也會增删查改,和問題關聯。
這兩張表的實體模型一模一樣。
那麼我們采取的方案有兩種,雙表,或者雙庫。雙表的話,對orm很不友好,因為orm是根據類來确定表的,我們為了代碼簡潔優雅,不可能建立兩個一模一樣的類,不然取名都變成一件困難的事。這裡,一個優勢是,我使用的orm庫首先是維護一個單例,單例進行crud操作,且一個單例和一個資料庫相關。于是我使用qualifer的特性,生成了兩個執行個體(也就是對應了兩個資料庫),分别注入到不同的業務模型中去,他們就可以使用同一個類,而且對tag的修改完全沒有影響。這件事要是我們自己去做的話,可能要寫很多肮髒不堪的代碼,但是dagger隻用2個注解就把我的需求解決了。
總結
好了,本文簡單的闡述了dagger入門使用,總結起來,我們隻要約定好componenet、module,搭配inject使用,即可實作一個靜态的依賴注入流程。下一次我們詳細介紹dagger生成的代碼結構。
作者:gemini
來源:51cto