了解Dagger 2 @ Component.Builder注释

时间:2017-09-13 12:19:18

标签: android components dagger-2

我正在阅读this伟大的教程,解释@Component.Builder如何在Dagger 2中发挥作用。作者做得很好,文章很简单,但我仍然有些困惑澄清:Dagger 2的默认实现看起来像这样:

组件:

@Singleton
@Component(modules = {AppModule.class})
public interface AppComponent {

  void inject(MainActivity mainActivity);
  SharedPreferences getSharedPrefs();
}

模块:

@Module
 public class AppModule {

    Application application;

    public AppModule(Application application) {
       this.application = application;
    }

    @Provides
    Application providesApplication() {
       return application;
    }
    @Provides
    @Singleton
    public SharedPreferences providePreferences() {
        return application.getSharedPreferences(DATA_STORE,
                              Context.MODE_PRIVATE);
    }
}

组件实例化:

DaggerAppComponent appComponent = DaggerAppComponent.builder()
         .appModule(new AppModule(this)) //this : application 
         .build();

根据文章,我们可以通过避免使用@Component.Builder@BindsInstance注释将参数传递给模块构造函数来进一步简化此代码,然后代码将如下所示:

组件:

@Singleton
@Component(modules = {AppModule.class})
public interface AppComponent {
   void inject(MainActivity mainActivity);
   SharedPreferences getSharedPrefs();

   @Component.Builder
   interface Builder {
      AppComponent build();
      @BindsInstance Builder application(Application application);      
  }

}

模块:

@Module
 public class AppModule {

     @Provides
     @Singleton
     public SharedPreferences providePreferences(
                                    Application application) {
         return application.getSharedPreferences(
                                    "store", Context.MODE_PRIVATE);
     }
 }

组件实例化:

DaggerAppComponent appComponent = DaggerAppComponent.builder()
           .application(this)
           .build();

我几乎理解上面的代码是如何工作的,但这是我不明白的部分:当我们实例化组件时,我们是如何从appModule(new AppModule(this))application(this)的?

我希望这个问题很明确,谢谢。

2 个答案:

答案 0 :(得分:14)

tl; dr 如果您没有传递任何无参数构造函数模型,Dagger将自行创建任何无参数构造函数模型,并且可能会更好地优化@BindsInstance的使用而不是从模块中提供类型。

首先,您有一个需要构建Application的组件。因此,您构建模块并将其传递给组件。

现在,使用组件构建器,您可以单个对象绑定到组件。这是我们上面所做的替代方案。不再需要模块,我们可以直接将Dagger交给我们在组件中所需的对象 正如@Binds提供接口实现一样,您通常可以假设Dagger可以并且将优化使用模块的简单方法之类的功能,因为意图更清晰。

因此使用@BindsInstance会将类型添加到我们的组件中,以便我们不再需要该模块来提供它。我们现在也可以从模块构造函数中删除参数。

  

当我们实例化组件时,我们是如何从appModule(新的AppModule(this))到应用程序(this)的?

由于Dagger本身可以实例化no-args模块,因此不再需要将模块显式添加到组件中,我们可以用新的.application(this)调用替换该行。

答案 1 :(得分:1)

 @Component.Builder
   interface Builder {
      AppComponent build();
      @BindsInstance Builder application(Application application);      
  }

当我们调用方法时

  

申请(申请表)

来自Application class

  

。应用(本)

它会将我们的应用程序对象设置为AppComponent。因此,在appcomponet中,应用程序实例可用。

因此我们可以从应用程序模块中删除以下代码,因为dagger会在需要的任何地方自动注入应用程序实例。

Application application;
   public AppModule(Application application) {
       this.application = application;
    }

    @Provides
    Application providesApplication() {
       return application;
    }

Dagger也使用默认构造函数实例化所有模块。

如果你想从AppModule中获取Context对象,只需编写

@Module
public class AppModule {

   @Provides
    Context provideContext(Application application) {
        return application;
    }
}