Dagger2之 @Singleton

單例@Singleton

在開始寫文章之前,先來了解一些與后邊的內容相關的注意事項(看文章前要有這些概念,剛開始不明白沒事衅金,等看完后續(xù)的內容再回來看就知道什么意思了):

  • 1森逮、Component的inject方法接收父類型參數榨婆,而調用時傳入的是子類型對象則無法注入,也就是說無法使用多態(tài)方式進行注入褒侧。
  • 2良风、component關聯(lián)的modules中不能有重復的provide
  • 3、module的provide方法使用了scope闷供,那么component就必須使用同一個注解
  • 4烟央、module的provide方法沒有使用scope,那么component和module是否加注解都無關緊要歪脏,可以通過編譯
  • 5疑俭、component的dependencies與component自身的scope不能相同,即組件之間的scope不同
  • 6婿失、Singleton的組件不能依賴其他的scope的組件钞艇,只能其他scope的組件依賴Singleton的組件。
  • 7豪硅、沒有scope的component不能依賴有scope的component
  • 8香璃、一個component不能同時有多個scope(Subcomponent除外)
  • 9、@Singleton的生命周期依附于component舟误,同一個module有provideXX()提供一個實例,且被@Singleton標注葡秒,針對不同的component,創(chuàng)建的實例不同嵌溢。

了解Singleton

先通過一個簡單的例子了解Singleton:
對于MainActivity中代碼:

public class MainActivity extends AppCompatActivity {

    @Inject
    OkHttpClient mOkHttpClient1;

    @Inject
    OkHttpClient mOkHttpClient2;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        DaggerUserComponet.create().inject(this);
        Log.e("itydl","MainActivity--->"+mOkHttpClient1);
        Log.e("itydl","MainActivity--->"+mOkHttpClient2);
    }
}

應該有個Module類提供OkHttpClient 實例:
創(chuàng)建UserModel:

@Module
public class UserModule {

    @Singleton
    @Provides
    public OkHttpClient provideSingletonOkhttpClient(){
        return new OkHttpClient().newBuilder().build();
    }
}

這里對provideXXX()方法加入了@Singleton注解眯牧,然后點進去這個類:

@Scope
@Documented
@Retention(RUNTIME)
public @interface Singleton {}

它是定義的Scope(待會講)。對應的Componet也必須定義為Scope:

@Singleton
@Component(modules = {UserModule.class})
public interface UserComponet {
    void inject(MainActivity mainActivity);
}

這樣客戶端需要依賴赖草,Module通過UserComponet 像其提供了依賴学少。運行程序:

okhttp3.OkHttpClient@3f9d7b7
okhttp3.OkHttpClient@3f9d7b7

發(fā)現(xiàn)兩個實例是一樣的。這樣就對單例Singleton有了一個了解秧骑。但是它里面還存在很多很多的坑版确,繼續(xù)往下一點點找出來吧。

挖掘Singleton存在的坑

修改所有的代碼如下:

MainActivity:
public class MainActivity extends AppCompatActivity {

    @Inject
    UserManager mManager;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        DaggerUserComponet.create().inject(this);

        mManager.register();

    }
}

它里面需要一個UserManager 依賴乎折,然后調用注冊方法绒疗。
對于UserManager類:

public class UserManager {

    private ApiServer mApiServer;
    
    @Inject
    public UserManager(ApiServer mApiServer){
        this.mApiServer = mApiServer;
    }

    public void register(){
        mApiServer.register();
    }
}

在這個類里面提供了注冊方法,真正的注冊是通過調用ApiServer 的register();他需要ApiServer 的實例骂澄,通過構造方法注入這個實例吓蘑。
看一下ApiServer 類:

public class ApiServer {

    OkHttpClient mOkHttpClient;

    @Inject
    public ApiServer(OkHttpClient okHttpClient){
        this.mOkHttpClient = okHttpClient;
    }

    /**
     * 往服務端保存用戶信息
     */
    public void register() {
        Log.e("Howard","ApiServer--->register()"+mOkHttpClient);
    }

}

在ApiServer 的egister()方法中,肯定需要OkHttpClient 實例進行訪問網絡的功能,這個實例又通過ApiServer的構造方法進行了注入磨镶。
然后Module提供依賴:

@Module
public class UserModule {

    @Singleton
    @Provides
    public OkHttpClient provideSingletonOkhttpClient(){
        return new OkHttpClient().newBuilder().build();
    }

    @Provides
    public ApiServer provideApiServer(OkHttpClient okHttpClient){
        ApiServer apiServer = new ApiServer(okHttpClient);
        return apiServer;
    }

     @Provides
     public UserManager provideUserManager(ApiServer mApiServer){
         return new UserManager(mApiServer);
     }

}

這個類專門提供依賴的溃蔫,provideUserManager方法提供MainActivity類需要的UserManager實例,然后這個構造方法中需要注入ApiServer 實例琳猫,直接在這個類里面提供了provideApiServer方法伟叛,然后返回出去。而這個方法創(chuàng)建ApiServer實例的時候又需要一個OkHttpClient 實例脐嫂,同樣在這里提供了provideSingletonOkhttpClient方法用于創(chuàng)建OkHttpClient 的痪伦。然后看一下Component里面的代碼:

@Singleton
@Component(modules = {UserModule.class})
public interface UserComponet {
    void inject(MainActivity mainActivity);
}

然后運行程序:

ApiServer--->register()okhttp3.OkHttpClient@3f9d7b7

打印了okhttp3的實例。

然后雹锣,假設現(xiàn)在有這樣的需求:在MainActivity中有注冊的功能网沾,如果還有登錄的功能,且希望使用的OkhttpClient是同一個實例蕊爵,該怎么去處理辉哥?
還有登錄的功能:創(chuàng)建LoginActivity,在它這里也要用到用戶管理類攒射,調用用戶管理的登錄方法:

public class LoginActivity extends AppCompatActivity {
    
    @Inject
    UserManager mManager;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_login);

        
        DaggerUserComponet.create().inject(this);
        
        mManager.login();
        
    }
}

這個時候編譯階段就報錯醋旦。DaggerUserComponet.create().inject(this);存在問題。

@Singleton
@Component(modules = {UserModule.class})
public interface UserComponet {
    void inject(MainActivity mainActivity);
}

因為void inject(MainActivity mainActivity);它里面接收的是MainActivity類型会放,顯然注入LoginActivity 類型是不允許的饲齐。
我們可能天真的認為,使用多態(tài)接收就可以了:

@Singleton
@Component(modules = {UserModule.class})
public interface UserComponet {
    void inject(Activity mainActivity);
}

運行發(fā)現(xiàn)報空指針咧最,是因為沒有完成注入捂人。這里應征了開頭的第一條Component的inject方法接收父類型參數,而調用時傳入的是子類型對象則無法注入矢沿,也就是說無法使用多態(tài)方式進行注入滥搭。
那么需要再寫一個與Login相關的連接器:

@Singleton
@Component(modules = UserModule.class)
public interface LoginCompoent {
    void inject(LoginActivity loginActivity);
}

LoginCompoent 也需要加入@Singleton進行注解,因為他關聯(lián)的UserModule里面provideSingletonOkhttpClient是通過單例@Singleton注解的捣鲸。這里關聯(lián)UserModule的原因是瑟匆,它里面已經提供了創(chuàng)建UserManager和創(chuàng)建OkHttpClient的方法。
然后看一下UserManager類栽惶,里面多了一個login();方法:

    public void login() {
        mApiServer.login();
    }

調用ApiServer類的login();方法:

    public void login(){
        Log.e("Howard","ApiServer--->login()"+mOkHttpClient);
    }

也是打印了OkHttpClient實例愁溜。
然后在LoginActivity中進行注入:
DaggerLoginCompoent.create().inject(this);
打印結果:

ApiServer--->register()okhttp3.OkHttpClient@2c4dbeb6
ApiServer--->login()okhttp3.OkHttpClient@5634554

跟我們想象的差別很大啊,我們明明對UserModel的provideSingletonOkhttpClient()方法加入了@Singleton注解為單例外厂,為何這里是兩個實例呀冕象?
解釋:Dagger2里面的單例不同意java中的單例,這是兩個不同的概念酣衷。在Dagger2里面的單例依附于Compoent交惯,不同的Compoent就算關聯(lián)了相同的Module且里面提供了共同所需要的實例次泽,也是創(chuàng)建了不同的實例對象(地址不同)穿仪。

在一個項目中席爽,我們希望提供的OkHttp是一個實例,而不是像上面那樣啊片,有多個Compoent就創(chuàng)建多個OkHttp實例只锻,該怎么辦呢?那就是下一篇文章的事了紫谷,自定義Scope齐饮。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市笤昨,隨后出現(xiàn)的幾起案子祖驱,更是在濱河造成了極大的恐慌,老刑警劉巖瞒窒,帶你破解...
    沈念sama閱讀 207,248評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件捺僻,死亡現(xiàn)場離奇詭異,居然都是意外死亡崇裁,警方通過查閱死者的電腦和手機匕坯,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,681評論 2 381
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來拔稳,“玉大人葛峻,你說我怎么就攤上這事“捅龋” “怎么了术奖?”我有些...
    開封第一講書人閱讀 153,443評論 0 344
  • 文/不壞的土叔 我叫張陵,是天一觀的道長轻绞。 經常有香客問我腰耙,道長,這世上最難降的妖魔是什么铲球? 我笑而不...
    開封第一講書人閱讀 55,475評論 1 279
  • 正文 為了忘掉前任挺庞,我火速辦了婚禮,結果婚禮上稼病,老公的妹妹穿的比我還像新娘选侨。我一直安慰自己,他們只是感情好然走,可當我...
    茶點故事閱讀 64,458評論 5 374
  • 文/花漫 我一把揭開白布援制。 她就那樣靜靜地躺著,像睡著了一般芍瑞。 火紅的嫁衣襯著肌膚如雪晨仑。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,185評論 1 284
  • 那天,我揣著相機與錄音洪己,去河邊找鬼妥凳。 笑死,一個胖子當著我的面吹牛答捕,可吹牛的內容都是我干的逝钥。 我是一名探鬼主播,決...
    沈念sama閱讀 38,451評論 3 401
  • 文/蒼蘭香墨 我猛地睜開眼拱镐,長吁一口氣:“原來是場噩夢啊……” “哼艘款!你這毒婦竟也來了?” 一聲冷哼從身側響起沃琅,我...
    開封第一講書人閱讀 37,112評論 0 261
  • 序言:老撾萬榮一對情侶失蹤哗咆,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后益眉,有當地人在樹林里發(fā)現(xiàn)了一具尸體岳枷,經...
    沈念sama閱讀 43,609評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 36,083評論 2 325
  • 正文 我和宋清朗相戀三年呜叫,在試婚紗的時候發(fā)現(xiàn)自己被綠了空繁。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,163評論 1 334
  • 序言:一個原本活蹦亂跳的男人離奇死亡朱庆,死狀恐怖盛泡,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情娱颊,我是刑警寧澤傲诵,帶...
    沈念sama閱讀 33,803評論 4 323
  • 正文 年R本政府宣布,位于F島的核電站箱硕,受9級特大地震影響拴竹,放射性物質發(fā)生泄漏。R本人自食惡果不足惜剧罩,卻給世界環(huán)境...
    茶點故事閱讀 39,357評論 3 307
  • 文/蒙蒙 一栓拜、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧惠昔,春花似錦幕与、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,357評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至来氧,卻和暖如春诫给,著一層夾襖步出監(jiān)牢的瞬間香拉,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,590評論 1 261
  • 我被黑心中介騙來泰國打工中狂, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留凫碌,地道東北人。 一個月前我還...
    沈念sama閱讀 45,636評論 2 355
  • 正文 我出身青樓吃型,卻偏偏與公主長得像证鸥,于是被迫代替她去往敵國和親僚楞。 傳聞我的和親對象是個殘疾皇子勤晚,可洞房花燭夜當晚...
    茶點故事閱讀 42,925評論 2 344

推薦閱讀更多精彩內容