dagger2的使用小结

简介

dagger2目前由谷歌进行维护的一个注入式框架，优点在于组件之间的解耦，有助于程序的扩展性。

使用步骤

• 配置

  • 2.2以上：

      app/build.gradle
          compile 'com.google.dagger:dagger:2.8'
          annotationProcessor 'com.google.dagger:dagger-compiler:2.8'
    

  • 2.2以下的版本

      project/build.gradle 文件中按下图所示添加代码:
          classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
      app/build.gradle 文件中按下图所示添加代码:
          apply plugin: 'com.neenbedankt.android-apt'
          compile 'com.google.dagger:dagger:2.2'
          apt 'com.google.dagger:dagger-compiler:2.2'
          provided 'org.glassfish:javax.annotation:10.0-b28'
    

• 1 创建一个javabean类，需要创建的对象，被注入者

• 2 创建一个module类，生成被注入者的对象，修饰类

  • 命名建议为：需要注解的对象Module，例如：MainAcitivityModule；

  • 类名需要注解@Module，@Provides注解在@Module内部

      @Module
      public class MainAcitityModule {
          @Provides
          public User getBean(){
              return new User(23,"张三");
          }
      }
    

• 3 创建一个DI容器，是接口类型的，建议命名规则：需要注解对象moduleComponent，例如：MainActivityComponent

  • 注解为模块的字节码文件

  • inject方法参数为module对象

      @Component(modules = MainAcitityModule.class)
      public interface MainActivityComponent {
          public void inject(MainActivity activity);
      }
    

• 4 Rebuild工程,生成对应的以Dagger开始的工具类（否则，无法生成 DaggerMainActivityComponent类 ）

• 5 在需要使用bean的地方，先注解@Inject，然后使用第四步生成的类创建组件对象，通过组件对象的inject的方法，进行调用。

    public class MainActivity extends AppCompatActivity {
        @Inject
        User user;
        @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_main);
  
            MainActivityComponent build = DaggerMainActivityComponent
                    .builder()
                    .mainAcitityModule(new MainAcitityModule())
                    .build();
            build.inject(this);
  
            Log.e("TAG", "onCreate:  " + user.toString());
        }
    }