依賴注入
在介紹 Dagger2 這個之前,必須先解釋一下什么是依賴注入,因為這個庫就是用來做依賴注入的。所以這里先簡單用一句話來介紹一下依賴注入:
依賴注入是一種設計模式,它允許對象在運行時注入其依賴項。而不是在編譯時確定(也就是硬編碼)。通過這種方式,可以更好地解耦代碼,提高測試性和可維護性。
詳細了解依賴注入,這里建立先看完這個博文,詳細介紹了這個概念和實現方式:Java 基礎知識之 依賴注入(Dependency Injection)
Dagger2
上面的博客已經介紹了,依賴注入有很多不同的框架都可以做這個事,那為什么選擇 Dagger2 呢?對于后端開發可能會用 Spring,而對于 Android 開發,只能用 Dagger2 了。這主要是因為這個庫本身就是由 Google 推出的,而且它通過注解處理器生成高效的依賴注入代碼,避免了運行時反射產生的性能開銷。在 Android 源代碼項目中,廣泛使用了這個庫。
這里重點注意 Dagger2 這個庫與其他依賴注入庫的區別在于 Dagger2 使用的是注解處理器,而不是運行時反射。如果不了解這兩個方式的區別可以看一些這個:
制作自己的ButterKnife(使用AutoService和APT注解處理器在編譯期生成Java代碼)
制作自己的 @OnClick、@OnLongClick(告別setOnClickListener,使用注解、反射和動態代理)
使用注解處理器可以在編譯時生成代碼來完成功能,這比使用運行時反射要快很多。而性能在 Android 這種嵌入式設備中相當重要,因此對于 Android 開發者來說,如果使用依賴注入,這個庫就是必選的。
基本概念
在使用 Dagger2 這個庫時,主要會有三個角色:
- 依賴需求方:就是需要依賴對象的那些類。例如一個人想要玩電腦,那么他就必須得有一臺電腦,因此這個人就是依賴需求方;
- 依賴供應方:負責提供依賴對象,類似與實際編碼中的工廠類,這個人依賴一臺電腦玩游戲,那么就必須有個地方能夠提供一臺電腦,這個地方就是依賴供應方,顧名思義,就是用于創建以來對象的;
- 依賴注入器:負責將以來對象注入到以來需求方,在實際代碼中是一個接口,編譯時 Dagger2 自動生成的就是這個接口的實現類。接著上面的說,這個人是依賴需求方,他需要一臺電腦,依賴供應方能夠提供一臺電腦,可是這兩者沒有打通啊,電腦沒有給到這個人,他還是玩不了游戲啊,因此這個時候就由依賴注入器將這臺電腦注入給這個人,他就能夠使用這臺電腦玩游戲了。
上面已經說得很形象了,大家應該都能理解,不能理解的,可以想象下面的一個場景。
你需要一臺電腦打游戲,那么你依賴于電腦,你就是依賴需求方,依賴對象是一臺電腦。這臺電腦哪里能提供呢?當然是淘寶、京東、實體店了,這些都能提供一臺電腦,那么它們都是依賴供應方。但是這中間必須得有個東西把電腦從供應商的倉庫送到你手里,你才能用,這就可以理解為將電腦這個依賴對象注入到你手中。什么是依賴注入器呢?在這里例子中,那就是三通一達這些快遞公司了。
就是一個簡單的購物的流程,只是把依賴注入的概念套進去了而已。下面我們就以這個場景為例,寫個 Demo,告訴大家如何使用 Dagger2 這個庫。
引入 Dagger2
截止到目前,Dagger2 這個庫的最新版本是 2.51.1。引入這個庫的方式也很簡單,在 build.gradle 中添加如下依賴:
dependencies {implementation 'com.google.dagger:dagger:2.51.1'annotationProcessor 'com.google.dagger:dagger-compiler:2.51.1'
}
大家再引入的時候最好查看一下 Dagger 的官網,引入最新的版本:https://dagger.dev/
在引入依賴并 Sync Project 之后,你會發現項目的依賴會多出來兩個庫:
編寫依賴需求方
先編寫一個 Person 類,里面有一個 playGame 的方法,這個方法中要使用 Computer,也就是說,Computer 是 Person 的依賴,我們使其成為一個成員變量:
public class Person {private String name;private Computer computer;public void Person(String name) {this.name = name; }public void playGame(String gameName) {computer.play(gameName);}
}
以下是 Computer 類,作為依賴對象:
public class Computer {private String name;public Computer(String name) {this.name = name;}public void play(String game) {System.out.println("使用 " + name + " 玩 " + game);}
}
編寫依賴供應方
現在,有了依賴需求方,那就要找到依賴提供商提供一臺電腦。哪里能提供電腦呢,那就先編寫一個淘寶類吧:
@Module
public class TaoBao {private Computer assembleComputer() { //組裝一臺電腦Computer computer = new Computer("淘寶的電腦");return computer;}@Providespublic Computer getComputer() {return assembleComputer();}
}
這里注意兩個注解 @Module 和 @Provides,這兩個注解是 Dagger 提供的。其中 @Module 用于告知 Dagger 這個類是一個依賴提供商,@Provides 用于告知 Dagger 這個依賴提供商里面哪些方法是用于提供依賴對象的。
在這個例子中, TaoBao 是一個依賴供應方,其中 getComputer 用于提供依賴對象,assembleComputer 則是一個普通方法。
編寫依賴注入器
有了需求方和供應方,那么就需要將兩者鏈接起來,依賴對象只有從供應方交給需求方,才有意義,這就是依賴注入器的工作。在這個例子中,依賴注入器就是快遞了,快遞把電腦從淘寶店家送到買家手中。這里我們就先編寫一個中通吧:
@Component(modules = TaoBao.class)
public interface ZTOExpress {void deliverTo(Person person);
}
注意這個注入器是一個 interface 而非 class,在編譯時,Dagger 會生成對應的實現類。
這個接口添加了一個注解:@Component,這個注解是就是告訴注入器,從哪個依賴供應方拿依賴對象。這段代碼里,@Component 注解告知了中通,去淘寶拿電腦快遞給買家。
但還有一個問題,中通知道將電腦配送給買家,那配送到那個成員變量呢?Person 里有 name 和 computer,從名字上就能看到電腦肯定要配送到 computer 的成員變量上,這個時候需要將 computer 這個成員變量添加 @Inject 注解:
public class Person {private String name;@Injectprivate Computer computer;//......
}
依賴注入結果
現在三個角色都有了,那我們現在就把它們拼接在一起,看看效果吧。
Person person = new Person("張三");
ZTOExpress ztoExpress = DaggerZTOExpress.builder().taoBao(new TaoBao()).build();
ztoExpress.deliverTo(person);
person.playGame("賽博朋克2077");
輸入:
System.out I 使用 淘寶的電腦 玩 賽博朋克2077
總結
先講到這里。后續再補全。