Android Dagger2

Dagger2
概述：
官方地址：https://github.com/google/dagger
它是解決Android或java中依賴注入的一個類庫。

Dagger2是Dagger1的分支，由谷歌公司接手開發(fā)，目前的版本是2.8。Dagger2是受到AutoValue項(xiàng)目的啟發(fā)。 剛開始，Dagger2解決問題的基本思想是：利用生成和寫的代碼混合達(dá)到看似所有的產(chǎn)生和提供依賴的代碼都是手寫的樣子。

基本注解：
@Inject
@Module
@Provide
@Component（注入器）
@Scope
@Singleton
@Qualifier（限定符）

基本用法：
@Inject + @Component

public class UserInfo {
    @Inject
?
    public UserInfo() {

    }
?
    public String getName() {
        return "Future";
    }
?
}

public class MainActivity extends AppCompatActivity {
   @Inject
    public UserInfo userInfo;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
?
        super.onCreate(savedInstanceState);
?
        setContentView(R.layout.activity_main);
?
        DaggerUserComponent.builder().build().inject(this);
?
           ((TextView)findViewById(R.id.name)).setText(userInfo.getName());
?
    }
?
}

@Component
public interface UserComponent {
    void inject(MainActivity mainActivity);
}

@Inject + @Component+ @Module + @Provides （Demo2）

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

@Module
public class UserModule {
?    @Provides
?    public ThirdUserInfo getUserInfo() {
        return new ThirdUserInfo();
    }
}

public class ThirdUserInfo {
    public String getName() {
        return "Future";
    }
}

public class SecondActivity extends Activity{?
    @Inject
    ThirdUserInfo thirdUserInfo;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        DaggerUserComponent2.builder().build().inject(this);
        Log.d("lc", "name="+thirdUserInfo.getName());
?
    }
?
}

@Qualifier(限定符 TAG)當(dāng)我們對于同一個類型，返回不同的對象時，Dagger會無法區(qū)分你到底要用哪個方法來提供依賴對象，這時就需要@Qualifier出現(xiàn)了。

@Module
public class UserModule {
    @Provides
    public ThirdUserInfo getUserInfo() {
        return new ThirdUserInfo().setName("tom");
    }
?
    @Provides
    public ThirdUserInfo getUserInfo2() {
        return new ThirdUserInfo().setName("lc");
    }
?
    @Provides
    public LoginInfo getLoginInfo() {
        return new LoginInfo();
    }
}

自定義注解Type 需要加@Qualifier注解來標(biāo)識。

@Qualifier
@Documented
@Retention(RetentionPolicy.RUNTIME)
public @interface Type {
    String value() default "";
}

用自己定義的Type的注解來區(qū)分不同的依賴。

@Module
public class UserModule {
    @Provides
    @Type(value = "tom")
    public ThirdUserInfo getUserInfo() {
        return new ThirdUserInfo().setName("tom");
    }
?
?
?
    @Provides
    @Type(value = "lc")
    public ThirdUserInfo getUserInfo2() {
        return new ThirdUserInfo().setName("lc");
    }
?
    @Provides
    public LoginInfo getLoginInfo() {
        return new LoginInfo();
    }
}

然后再Activity中標(biāo)識對應(yīng)的注解。

public class SecondActivity extends AppCompatActivity{
    @Type("tom")
    @Inject
    ThirdUserInfo thirdUserInfo;
    @Type("lc")
    @Inject
    ThirdUserInfo thirdUserInfo2;
    @Inject
    LoginInfo loginInfo;
    @Override
    protected void onCreate(Bundle savedInstanceState) {
?
        super.onCreate(savedInstanceState);
?
        DaggerUserComponent2.builder().build().inject(this);
?
        Log.d("lc", "name="+thirdUserInfo.getName());
?
        Log.d("lc", "name2="+thirdUserInfo2.getName());
?
    }
?
}

@Scope(作用域) & @Singleton(單例)
首先說下@Singleton(作用域-單例)
沒有使用@Singleton的代碼

public class UserInfo {
    @Inject
    public UserInfo() {
    }
}

@Component
public interface UserComponent3 {
    void inject(ThirdActivity thirdActivity);
}

public class ThirdActivity extends AppCompatActivity{
    @Inject
    UserInfo userInfo;
    @Inject
    UserInfo userInfo2;
    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
?
        super.onCreate(savedInstanceState);
?
        DaggerUserComponent3.builder().build().inject(this);
?
        Log.d("lc", "userInfo=" + userInfo.toString());
?
        Log.d("lc", "userInfo2=" + userInfo2.toString());
?
    }
?
}

打印結(jié)果：
D/lc (30180):userInfo=com.example.luchao.testdagger.demo3.UserInfo@43131e98
D/lc (30180): userInfo2=com.example.luchao.testdagger.demo3.UserInfo@43131ea8
這里可以看出是兩個不同的對象
然后使用@ Singleton注解

@Singleton
public class UserInfo {
    @Inject
?
    public UserInfo() {
    }
?
}

@Singleton
@Component
public interface UserComponent3 {
    void inject(ThirdActivity thirdActivity);
}

打印結(jié)果：
D/lc ( 2834):userInfo=com.example.luchao.testdagger.demo3.UserInfo@43132bf0
D/lc ( 2834):userInfo2=com.example.luchao.testdagger.demo3.UserInfo@43132bf0

現(xiàn)在我們知道@Singleton注解實(shí)際上實(shí)現(xiàn)的是一個全局單例模式，在實(shí)際開發(fā)中我們可能還需要一種局部單例的控件，我們可以通過自定義@Scope來實(shí)現(xiàn)局部單例。
注意標(biāo)紅的這段話，是從網(wǎng)絡(luò)上一篇博客看到的，因?yàn)檫@句話，我也被誤導(dǎo)了好久。其實(shí)@Singleton并沒有全局單例的功能。
當(dāng)我從ThirdActivity跳轉(zhuǎn)到ThirdActivity2中的時候。

public class ThirdActivity2 extends AppCompatActivity{
    @Inject
    UserInfo userInfo;
    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
//        ((MyApplication) //getApplication()).getApplicationCompenent().inject(this);
?
        DaggerUserComponent3.builder().build().inject(this);
?
        Log.d("lc", "userInfo3="+userInfo);
?
    }
?
}

發(fā)現(xiàn)UserInfo打印的完全不一樣了。從此就產(chǎn)生了疑問了。后來閱讀了一篇博客后恍然大悟。
地址：http://www.itdecent.cn/p/1d42d2e6f4a5
其實(shí)@Singleton的作用并不是創(chuàng)建全局單例功能。仔細(xì)發(fā)現(xiàn)@Singleton的代碼

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

其實(shí)也用到了@Scope注解。
在Dagger2中唯一創(chuàng)建全局單例模式的方式：
首先Module
提供了創(chuàng)建實(shí)例的方法，接著AppComponent
中對Module
進(jìn)行管理，最后AppComponent****在自定義Applicaiton中被實(shí)例化了一次。
最關(guān)鍵的就是被實(shí)例化一次，然后通過scope注解，通過代理實(shí)現(xiàn)單例。
如下：
自定義注解，用來表明Component與Module之間的關(guān)系。

@Scope
@Retention(RetentionPolicy.RUNTIME)
public @interface ApplicationScope {
}

module:

@Module
public class ApplicationModule {
    @ApplicationScope
    @Provides
    public UserInfo getUserInfo() {
        return new UserInfo();
    }
}

component:

@Component(modules = ApplicationModule.class)
@ApplicationScope
public interface ApplicationCompenent {
?
    void inject(ThirdActivity thirdActivity);
?
    void inject(ThirdActivity2 thirdActivity);
?
}

application:

public class MyApplication extends Application{
    private ApplicationCompenent applicationCompenent;
    @Override
    public void onCreate() {
        super.onCreate();
        applicationCompenent = DaggerApplicationCompenent.builder().build();
?
    }
?
    public ApplicationCompenent getApplicationCompenent() {
        return applicationCompenent;
    }
?
}

activity:

public class ThirdActivity extends AppCompatActivity{
    @Inject
    UserInfo userInfo;
    @Inject
    UserInfo userInfo2;
    @Override
    protected void onCreate(@Nullable Bundle savedInstanceState) {
?
        super.onCreate(savedInstanceState);
?
        setContentView(R.layout.activity_four);
?
        findViewById(R.id.next).setOnClickListener(new View.OnClickListener() {
?
            @Override
?
            public void onClick(View v) {
?
                Intent intent = new Intent(ThirdActivity.this, ThirdActivity2.class);
?
                startActivity(intent);
?
            }
?
        });
?
        ((MyApplication) getApplication()).getApplicationCompenent().inject(this);
?
//        DaggerUserComponent3.builder().build().inject(this);
?
        Log.d("lc", "userInfo=" + userInfo.toString());
?
        Log.d("lc", "userInfo2=" + userInfo2.toString());
?
    }
?
}

按照上面的情況來說，是不是@Singleton就是多此一舉？其實(shí)也不是！
其實(shí)@
Singleton還有有一些作用的，首先一方面能讓你直面的了解到這是一個單例，其次這個@
Singleton能夠更好的管理Modlue
和Component
之間的關(guān)系。
Dagger2注入的基本實(shí)現(xiàn)原理：拿Demo2作為例子。
編譯時會根據(jù)注解，生成實(shí)現(xiàn)類。路徑：generated-source-apt-debug
生成類的對應(yīng)關(guān)系: DaggerUserComponent2
UserComponent2 -> DaggerUserComponent2
SecondActivity -> SecondActivity_MembersInjector
UserModule:
getUserInfo -> UserModule_GetUserInfoFactory
getuserInfo2 -> UserModule_GetUserInfo2Factory
getLoginInfo -> UserModule_getLoginfoFactory
大概注入思路：Builder->Factory
見代碼：
DaggerUserComponent2.builder().build().inject(this);注入的代碼。

public static final class Builder {
  private UserModule userModule;
  private Builder() {}
  public UserComponent2 build() {
    if (userModule == null) {
      this.userModule = new UserModule();
    }
    return new DaggerUserComponent2(this);
  }
?
?
?
  public Builder userModule(UserModule userModule) {
?
    this.userModule = Preconditions.checkNotNull(userModule);
?
    return this;
?
  }
?
}

初始化 initialize：

private void initialize(final Builder builder) {
  this.getUserInfoProvider = UserModule_GetUserInfoFactory.create(builder.userModule);
?
  this.getUserInfo2Provider = UserModule_GetUserInfo2Factory.create(builder.userModule);
?
  this.getLoginInfoProvider = UserModule_GetLoginInfoFactory.create(builder.userModule);
?
  this.secondActivityMembersInjector =
?
      SecondActivity_MembersInjector.create(
?
          getUserInfoProvider, getUserInfo2Provider, getLoginInfoProvider);
?
}

為SecondActivity_MembersInjector類中的Provider<T> 對象賦值。

public static MembersInjector<SecondActivity> create(

?
    Provider<ThirdUserInfo> thirdUserInfoProvider,
?
    Provider<ThirdUserInfo> thirdUserInfo2Provider,
?
    Provider<LoginInfo> loginInfoProvider) {
?
  return new SecondActivity_MembersInjector(
?
      thirdUserInfoProvider, thirdUserInfo2Provider, loginInfoProvider);
?
}

public SecondActivity_MembersInjector(

?
    Provider<ThirdUserInfo> thirdUserInfoProvider,
?
    Provider<ThirdUserInfo> thirdUserInfo2Provider,
?
    Provider<LoginInfo> loginInfoProvider) {
?
  assert thirdUserInfoProvider != null;
?
  this.thirdUserInfoProvider = thirdUserInfoProvider;
?
  assert thirdUserInfo2Provider != null;
?
  this.thirdUserInfo2Provider = thirdUserInfo2Provider;
?
  assert loginInfoProvider != null;
?
  this.loginInfoProvider = loginInfoProvider;
?
}

此時對象的注入準(zhǔn)備工作已經(jīng)完成準(zhǔn)備inject開始注入

@Override

?
public void inject(SecondActivity secondActivity) {
?
  secondActivityMembersInjector.injectMembers(secondActivity);
?
}

這時傳進(jìn)來要注入對象的類，我們這里是SecondActivity，這時猜想后面我們應(yīng)該會對SecondActivity里面的
thirdUserInfo, thirdUserInfo2,loginInfo做初始化操作，往下看。
secondActivityMembersInjector是接口，哪里實(shí)現(xiàn)這個接口的呢？見初始化的initialize方法，里面SecondActivity_MembersInjector實(shí)現(xiàn)了secondActivityMembersInjector接口。
之后看SecondActivity_MembersInjector：

@Override

?
public void injectMembers(SecondActivity instance) {
?
  if (instance == null) {
?
    throw new NullPointerException("Cannot inject members into a null reference");
?
  }
?
  instance.thirdUserInfo = thirdUserInfoProvider.get();
?
  instance.thirdUserInfo2 = thirdUserInfo2Provider.get();
?
  instance.loginInfo = loginInfoProvider.get();
?
}

這里對SecondActivity中的對象完成了賦值，此時完成了注入的操作。
經(jīng)過上述過程，完成了對SecondActivity依賴對象的注入。

簡介：APT(AnnotationProcessing Tool)
現(xiàn)在很多主流庫都使用了APT,比如Dagger2,ButterKnife,EventBus3等
代碼樣例參考：http://www.tuicool.com/articles/aIfaum6

dagger2****到底有哪些好****處****？(因地制宜)

增加開發(fā)效率、省去重復(fù)的簡單體力勞動首先new一個實(shí)例的過程是一個重復(fù)的簡單體力勞動，dagger2完全可以把new一個實(shí)例的工作做了，因此我們把主要精力集中在關(guān)鍵業(yè)務(wù)上、同時也能增加開發(fā)效率上。省去寫單例的方法，并且也不需要擔(dān)心自己寫的單例方法是否線程安全，自己寫的單例是懶漢模式還是餓漢模式。因?yàn)閐agger2都可以把這些工作做了。

更好的管理類實(shí)例每個app中的ApplicationComponent管理整個app的全局類實(shí)例，所有的全局類實(shí)例都統(tǒng)一交給ApplicationComponent管理，并且它們的生命周期與app的生命周期一樣。每個頁面對應(yīng)自己的Component，頁面Component管理著自己頁面所依賴的所有類實(shí)例。因?yàn)镃omponent，Module，整個app的類實(shí)例結(jié)構(gòu)變的很清晰。

解耦假如不用dagger2的話，一個類的new代碼是非常可能充斥在app的多個類中的，假如該類的構(gòu)造函數(shù)發(fā)生變化，那這些涉及到的類都得進(jìn)行修改。設(shè)計(jì)模式中提倡把容易變化的部分封裝起來。假如是通過用Inject注解標(biāo)注的構(gòu)造函數(shù)創(chuàng)建類實(shí)例，則即使構(gòu)造函數(shù)變的天花亂墜，我們基本上都不需要修改任何代碼。

最后編輯于 ：
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡書系信息發(fā)布平臺，僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容