主頁 > 移動端開發 > 【從零開始擼一個App】Dagger2

【從零開始擼一個App】Dagger2

2020-09-10 06:57:59 移動端開發

Dagger2是一個IOC框架,一般用于Android平臺,第一次接觸的朋友,一定會被搞得暈頭轉向,它延續了Java平臺Spring框架代碼碎片化,注解滿天飛的傳統,嘗試將各處代碼片段串聯起來,理清思緒,真不是件容易的事,更不用說還有各版本細微的差別,
與Spring不同的是,Spring是通過反射創建物件的,而Dagger2是[通過apt插件]在編譯期間生成代碼,這些生成的代碼負責依賴物件創建,

本文旨在以簡單通俗易懂的方式說明如何使用Dagger2,對其背后設計不做深入探討,人生苦短,碼農更甚,先知其然等有空時再知其所以然,不失為擼App的較好實踐,

正式開始前,先給像筆者這樣的小白定義幾個概念,方便下文理解:

  • 依賴物件:比如bean,被其它類所需(依賴)的物件,需要以某種方式注入到目標物件中,
  • 目標物件:依賴物件的需求方,注入者將依賴物件注入其中,
  • 注入者/[依賴物件的]容器:維護依賴物件,將依賴物件注入到目標物件的工具類,

入門

首先,添加依賴庫,

    implementation "com.google.dagger:dagger:2.27"
    // kapt是服務于Kotlin的Annotation Processing Tool,用于編譯時處理注解
    kapt "com.google.dagger:dagger-compiler:2.27"

一般來說,IOC會根據規則在運行時自動幫我們生成依賴物件實體,Dagger2提供了兩種宣告依賴物件的方式:

  • 建構式有@Inject修飾,
  • @Module修飾的類中所定義的有@Provides修飾的方法提供(可用于依賴物件是第三方庫中的物件),
// 方式一(注意此處hen也要是依賴物件,否則將為null或者直接報錯)
class Egg @Inject constructor(private val hen: Hen)

// 方式二
@Module
class HenModule {
    @Singleton
    @Provides
    fun provideHen() = Hen()
}

大家注意@Singleton注解(javax.inject中定義),它表示該依賴物件的作用域或者說生命周期,Dagger2中可通過@Scope定義,@Singleton是Dagger2默認支持的scope,表示依賴物件是單例,需要注意的是,通常我們將單例保存在一個靜態域中,這樣的單例往往要等到虛擬機關閉時候,所占用的資源才釋放,但是,Dagger通過Singleton創建出來的單例并不保持在靜態域上,而是保留在同樣標注了@Singleton的Component實體中(依賴物件容器,接下來會講到),其實對于任意scope,只要依賴物件和Component標注的是相同scope,那么該依賴物件在相應的Component中就是一個區域單例,僅會呼叫一次工廠類生成物件實體,一般來說我們只要使用默認的@Singleton即可,沒必要自定義,自定義Scope常用于業務或邏輯的劃分,
如果不想依賴物件與Component系結,則可以使用@Reusable作用域,

上面說的Component是@Component注解修飾的介面,Dagger2會先尋找它,以此為入口得到所有依賴物件,該介面中可定義類似void inject(Target target)的方法,顯然,@Component注解的介面就是注入者,它將依賴物件和目標物件串聯了起來,

@Singleton
@Component(modules = [HenModule::class]) //依賴物件
interface MyAppComponent {
    fun inject(activity: MainActivity); //目標物件
}

最后我們就可以在目標物件中愉快地使用依賴物件了,

class MainActivity : AppCompatActivity() {
    @Inject
    lateinit var hen: Hen

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        DaggerMyAppComponent.builder().build().inject(this); // 關鍵
    }
}

改進

如上,對于Activity/Fragment來說,它們的實體化是系統完成的,因此我們只能在它們使用之前的某個環節比如onCreate回呼方法內手動將其自身依附到Dagger2中,這產生了至少一個問題:這種方式破壞了依賴注入的核心準則:一個類不應該知道它是如何被注入的,為了解決這個問題,Dagger 2.10版本引入的dagger-android,它是一個專為Android設計的除了Dagger主模塊之外的全新模塊,

首先,新增兩個依賴庫,

    implementation "com.google.dagger:dagger-android:2.27"
    kapt "com.google.dagger:dagger-android-processor:2.27"

針對每個目標類撰寫對應的子容器代碼:

@Subcomponent(modules = [HenModule::class])
interface MainActivitySubcomponent : AndroidInjector<MainActivity?> {
    @Subcomponent.Builder
    abstract class Builder : AndroidInjector.Factory<MainActivity?>
}

再針對每個目標類撰寫對應的依賴物件代碼:

@Module(subcomponents = MainActivitySubcomponent::class)
abstract class MainActivityModule {
    @Binds
    @IntoMap
    @ActivityKey(MainActivity::class)
    abstract fun bindMainActivityInjectorFactory(builder: MainActivitySubcomponent.Builder?): AndroidInjector.Factory<out Activity?>?
}

修改之前的MyAppComponent代碼:

@Singleton
@Component(modules = [AndroidInjectionModule::class,MainActivityModule::class]) // 關鍵,引入AndroidInjectionModule
interface MyAppComponent {
    fun inject(app: MyApplication); //注入到Application
}

Application需要繼承HasActivityInjector,實作inject方法,回傳DispatchingAndroidInjector物件,

class MyApplication : Application(), HasActivityInjector {
    // 由dagger.android自動注入
    @Inject
    lateinit var dispatchingAndroidInjector: DispatchingAndroidInjector<Activity>

    override fun androidInjector() = dispatchingAndroidInjector

    override fun onCreate() {
        super.onCreate()
        DaggerMyAppComponent.builder().build().inject(this)
    }
}

創建一個BaseActivity,在super.onCreate之前呼叫AndroidInjection.inject(this),這樣之后的Activity就只需要繼承它,就可以使用各自的依賴物件了,

open class BaseActivity: AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        AndroidInjection.inject(this)
        super.onCreate(savedInstanceState)
    }
}
class MainActivity : BaseActivity() {
    @Inject
    lateinit var hen: Hen

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        //DaggerMyAppComponent.builder().build().inject(this); // 不需要了
    }
}

可見,為了解決前述問題,引入了更多的代碼,復雜度也提高了,這是否有必要,值得商榷,好在Dagger2提供了@ContributesAndroidInjector注解解決了這個問題,


再改進

  1. 洗掉前述的MainActivitySubcomponent和MainActivityModule;
  2. 創建基于BaseActivity型別的容器(非必須):
@Subcomponent
interface ActivityComponet: AndroidInjector<BaseActivity>{
    @Subcomponent.Builder
    abstract class Builder: AndroidInjector.Builder<BaseActivity>()
}
  1. 創建ActivityModule,管理所有Activity,注意@ContributesAndroidInjector注解的使用,
@Module(subcomponents = [ActivityComponet::class])
abstract class ActivityModule{
    @ContributesAndroidInjector
    abstract fun mainActivityInjector(): MainActivity
}
  1. 修改之前的MyAppComponent代碼:
@Singleton
@Component(modules = [AndroidInjectionModule::class,ActivityModule::class]) // MainActivityModule改為ActivityModule
interface MyAppComponent {
    fun inject(app: MyApplication);
}

大功告成!我們再也不需要重復地創建XXXActivityModule和XXXActivitySubcomponent類了,
參看Dagger & Android


后記拾遺

@BindsInstance:編譯后會在Component的Builder類中生成修飾的方法里面的引數對應的成員變數,so該變數對應的物件可在與該Component相關的Module中通過@Inject注入,可看作是該Component范圍內的全域單例,類似于上述的@Scope的作用,

Dagger 2.22 起引入了 @Component.Factory, 可以取代@Component.Builder的使用,Factory在許多場景的上的使用相對于Builder會更簡單,

Dagger 2.23新增了一個HasAndroidInjector介面,用于替代HasActivityInjector, HasServiceInjector, HasBroadcastReceiverInjector, HasSupportFragmentInjector四個介面,讓Application中的代碼更簡潔,目前還是beta版,一般如果我們只需要HasActivityInjector的話那也無所謂了,參看Reducing Boilerplate with the new HasAndroidInjector in Dagger 2.23

了解一下javax.inject,這個是 Java EE 6 規范 JSR 330 -- Dependency Injection for Java 中的東西, Spring、Guice兼容該規范,

Assisted Injection:似乎是Guice引入的一個概念?——
Sometimes a class gets some of its constructor parameters from the Injector and others from the caller. 對于這種情況,我們常封裝一個工廠類,該類內部提供了注入型別的實體化,對外暴露一個生產方法,該方法只接收需要外部傳入的引數,如果覺得手寫這種工廠類太過麻煩或作業量太大,那么可以使用AssistedInject自動生成,參看AssistedInject,Assisted Injection for JSR 330

拋棄dagger-android:雖然最終改進之后,代碼變得清晰很多,但內在邏輯反而更加復雜了,這種[理解門檻較高的]復雜度就像一顆定時炸彈,讓人夜不能寐,當我使用到ViewModel之后發現,也可以不引入dagger-android,而是將所有依賴注入到ViewModel中,再由ViewModel暴露給系統組件,然而由于框架所限,其實不然——ViewModel是由Android框架本身維護的,當然框架也給我們留了一個自定義provider viewmodel的口子,就是ViewModelProvider.Factory——這又是一項頗費腦力的工程,參看How to Inject ViewModel using Dagger 2,這步完成以后,我們再將ViewModelProvider.Factory實體注入到Application中,變為一個全域工廠物件,Activity/Fragment直接拿來用即可,再也不需要與依賴注入有任何瓜葛,自然也不需要dagger-android了,也有大神跟我想到一塊,參看當Dagger2撞上ViewModel


參考資料

Dagger2從入門到放棄再到恍然大悟
Dagger2 @Component 和@SubComponent 區別解惑
學習Dagger2筆記
dagger.android(Dagger2中的AndroidInjector)使用決議
Dagger2 中的 Binds、IntoSet、IntoMap
dagger android 學習(一):dagger基礎使用
Dagger2在Android平臺上的新魔法(作者了解了dagger-android背后的原理后棄用)

轉載請註明出處,本文鏈接:https://www.uj5u.com/yidong/1217.html

標籤:Android

上一篇:返回列表

下一篇:Flutter Weekly Issue 66

標籤雲
其他(123570) Java(13369) Python(12729) C(7542) 區塊鏈(7372) JavaScript(7049) 基礎類(6313) AI(6244) 腳本語言(PerlPython)(5129) 非技術區(4971) Android(4120) MySQL(4012) Linux(3394) C語言(3288) C++語言(3117) Java相關(2746) 疑難問題(2699) 單片機工控(2479) Web開發(1951) 網絡通信(1793) 數據庫相關(1767) VB基礎類(1755) PHP(1727) 開發(1646) 系統維護與使用區(1617) .NETCore(1586) 基礎和管理(1579) JavaEE(1566) C++(1527) 專題技術討論區(1515) Windows客戶端使用(1484) HtmlCss(1466) ASP.NET(1428) Unity3D(1354) VCL組件開發及應用(1353) HTML(CSS)(1220) 其他技術討論專區(1200) WindowsServer(1192) .NET技术(1165) 交換及路由技術(1149) 語言基礎算法系統設計(1133) WindowsSDKAPI(1124) 界面(1088) JavaSE(1075) Qt(1074) VBA(1048) 新手樂園(1016) 其他開發語言(947) Go(907) HTML5(901) 新技術前沿(898) 硬件設計(872) 區塊鏈技術(860) 網絡編程(857) 非技術版(846) 一般軟件使用(839) 網絡協議與配置(835) Eclipse(790) Spark(750) 下載資源懸賞專區(743)

熱門瀏覽
  • 【從零開始擼一個App】Dagger2

    Dagger2是一個IOC框架,一般用于Android平臺,第一次接觸的朋友,一定會被搞得暈頭轉向。它延續了Java平臺Spring框架代碼碎片化,注解滿天飛的傳統。嘗試將各處代碼片段串聯起來,理清思緒,真不是件容易的事。更不用說還有各版本細微的差別。 與Spring不同的是,Spring是通過反射 ......

    uj5u.com 2020-09-10 06:57:59 more
  • Flutter Weekly Issue 66

    新聞 Flutter 季度調研結果分享 教程 Flutter+FaaS一體化任務編排的思考與設計 詳解Dart中如何通過注解生成代碼 GitHub 用對了嗎?Flutter 團隊分享如何管理大型開源專案 插件 flutter-bubble-tab-indicator A Flutter librar ......

    uj5u.com 2020-09-10 06:58:52 more
  • Proguard 常用規則

    介紹 Proguard 入口,如何查看輸出,如何使用 keep 設定入口以及使用實體,如何配置壓縮,混淆,校驗等規則。

    ......

    uj5u.com 2020-09-10 06:59:00 more
  • Android 開發技術周報 Issue#292

    新聞 Android即將獲得類AirDrop功能:可向附近設備快速分享檔案 谷歌為安卓檔案管理應用引入可安全隱藏資料的Safe Folder功能 Android TV新主界面將顯示電影、電視節目和應用推薦內容 泄露的Android檔案暗示了傳說中的谷歌Pixel 5a與折疊屏新機 谷歌發布Andro ......

    uj5u.com 2020-09-10 07:00:37 more
  • AutoFitTextureView Error inflating class

    報錯: Binary XML file line #0: Binary XML file line #0: Error inflating class xxx.AutoFitTextureView 解決: <com.example.testy2.AutoFitTextureView android: ......

    uj5u.com 2020-09-10 07:00:41 more
  • 根據Uri,Cursor沒有獲取到對應的屬性

    Android: 背景:呼叫攝像頭,拍攝視頻,指定保存的地址,但是回傳的Cursor檔案,只有名稱和大小的屬性,沒有其他諸如時長,連ID屬性都沒有 使用 cursor.getInt(cursor.getColumnIndexOrThrow(MediaStore.Video.Media.DURATIO ......

    uj5u.com 2020-09-10 07:00:44 more
  • Android連載29-持久化技術

    一、持久化技術 我們平時所使用的APP產生的資料,在記憶體中都是瞬時的,會隨著斷電、關機等丟失資料,因此android系統采用了持久化技術,用于存盤這些“瞬時”資料 持久化技術包括:檔案存盤、SharedPreference存盤以及資料庫存盤,還有更復雜的SD卡記憶體儲。 二、檔案存盤 最基本存盤方式, ......

    uj5u.com 2020-09-10 07:00:47 more
  • Android Camera2Video整合到自己專案里

    背景: Android專案里呼叫攝像頭拍攝視頻,原本使用的 MediaStore.ACTION_VIDEO_CAPTURE, 后來因專案需要,改成了camera2 1.Camera2Video 官方demo有點問題,下載后,不能直接整合到專案 問題1.多次拍攝視頻崩潰 問題2.雙擊record按鈕, ......

    uj5u.com 2020-09-10 07:00:50 more
  • Android 開發技術周報 Issue#293

    新聞 谷歌為Android TV開發者提供多種新功能 Android 11將自動填表功能整合到鍵盤輸入建議中 谷歌宣布Android Auto即將支持更多的導航和數字停車應用 谷歌Pixel 5只有XL版本 搭載驍龍765G且將比Pixel 4更便宜 [圖]Wear OS將迎來重磅更新:應用啟動時間 ......

    uj5u.com 2020-09-10 07:01:38 more
  • 海豚星空掃碼投屏 Android 接收端 SDK 集成 六步驟

    掃碼投屏,開放網路,獨占設備,不需要額外下載軟體,微信掃碼,發現設備。支持標準DLNA協議,支持倍速播放。視頻,音頻,圖片投屏。好點意思。還支持自定義基于 DLNA 擴展的操作動作。好像要收費,沒體驗。 這里簡單記錄一下集成程序。 一 跟目錄的build.gradle添加私有mevan倉庫 mave ......

    uj5u.com 2020-09-10 07:01:43 more
最新发布
  • 如何在同一頁面上向下滾動并顯示章節?

    我正在開發一個單頁網站,當用戶點擊一個特定的按鈕時,應該向下滾動到頁面的另一個部分。
    因為我使用了粘性標題,所以該部分的標題被隱藏在橫幅后面,所以我使用下面的代碼在點擊...

    uj5u.com 2021-10-16 15:31:29 more
  • 是否有辦法在gradle.build檔案中擴展或創建不同的jib配置?

    我正在使用jib插件來為我的springboot應用構建docker鏡像。然而,我希望在我的構建檔案中有一個新的任務,它將呼叫不同的構建jib任務。
    其原因是,根據我在 gradle 中創建的任務,...

    uj5u.com 2021-10-16 15:31:10 more
  • 未生成Apollo目錄

    我在初步實施中遇到了困難。
    我的問題是,下面的構建無法生成apollo目錄。
    用這個gradle(應用程式級別)
    plugins {
    id 'com.android.application'/span>
    id 'kotlin-androi...

    uj5u.com 2021-10-16 15:30:57 more
  • 引數型別'PointerEvent'不能分配給引數型別'PointerDownEvent'。

    最近,我更新到了flutter 2.5和最新的androids studio,并試圖將我的flutter專案編譯到android設備上。Android studio向我拋出了下面的錯誤。如果我在終端寫flutter run,編譯到...

    uj5u.com 2021-10-16 15:30:43 more
  • 如何使用then()并在Cypress中獲取數值

    我有一個span元素,它的值是2,我想檢查它的值是否大于0,但在網上查詢并實施了所有方法后,它沒有作業......
    下面是我記錄$span時的控制臺> 2</span>
    </div>

    cy.get(" .badge....

    uj5u.com 2021-10-16 15:28:04 more
  • 使用Kotlin中的高階函式在trycatch中包裹一個函式

    我有一組函式,它們有不同的簽名和引數,但它們都可以拋出一個例外。我想寫一個行內函式,將一個函式作為引數,在一個try-catch塊中呼叫這個函式,并回傳某些型別的例外,而不是在每個...

    uj5u.com 2021-10-16 15:25:37 more
  • 如何在運行時指定通用型別?

    我有一段這樣的代碼:
    var senders = new List<MessageSenderBase<object>();
    senders.Add(new MessageSender1<MessageType1>())。

    其中MessageSender1<MessageType1>是...

    uj5u.com 2021-10-16 15:25:20 more
  • Dart中非通用類中的通用欄位/方法

    在 Dart 中,是否有可能像 Java 一樣,在非通用類中擁有通用方法?
    我使用Getx進行狀態管理、DI&路由,但這個問題并不是針對Getx或Flutter的。
    我有AuthService,它處理認證和設定登...

    uj5u.com 2021-10-16 15:25:12 more
  • Typecript中通用的"設定屬性"函式

    我遇到了一個問題,我通過創建下面的函式簡化了這個問題: 我遇到了一個問題。
    function setProperty< T extends Record<string, string>> (obj: T, key: keyof T) {
    obj[key...

    uj5u.com 2021-10-16 15:24:55 more
  • 如何讓我的代碼從乞討開始,而無需用戶重新啟動程式,VisualBasic

    這是我的代碼Module vbModule Sub Main() 'Welcome Text Console.WriteLine("Welcome To Squidwards Password Checker") 'Length Check 'C...

    uj5u.com 2021-10-16 15:11:49 more