Dagger2依赖注入解析

Android Studio中配置

Tips:
在Dagger2的使用中，按照ButterKnife和Dagger2 guthub上readme配置会出现ButterKnife找不到控件的问题，所以在讲Dagger2的时候顺便将ButterKnife的配置再重新说一遍。找到具体的原因，解决问题。

• dagger2：
  • app中的build.gradle 中添加 ：

  apply plugin: 'com.neenbedankt.android-apt'
  

  • dependencies中添加：

  apt 'com.google.dagger:dagger-compiler:2.10-rc4'
  

  • 在整个project的build.gradle中添加：

  buildscript {
               ....
       dependencies {
               ...
           classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
               }
   }
  

• butterKnife:
  • 在app的build.gradle中：

       android{
            ...
            //dagger2和butterknife冲突
            packagingOptions{
                exclude 'META-INF/services/javax.annotation.processing.Processor'       
            }
        }

      dependencies  {
          ...
          compile 'com.jakewharton:butterknife:+'
          apt 'com.jakewharton:butterknife-compiler:+'
      }

集成dagger2和butterKnife后，使用butterKnife找不到控件，其原因在于注释工具：android-apt和annotationProcessor。

• android-apt是安卓处理注释的工具，是个人开发的一个apt框架。
• annotationProcessor是google推出替代android-apt的，后面android-apt也停止更新了。
• 这两个注释工具只能用其中一个，dagger2用的apt，我们就把butterKnife的改成apt就能正常使用butterKnife了。

四种基础的注解

• @Inject
  @Inject 注解主要有两个作用：
  • 在使用类的构造函数上进行依赖注入，在我们需要使用这个类的时候，通过@Inject注解就能注入，得到该类的实例化对象。
  • 在使用某个类（需要某个类的实例化对象）时，在使用的类中通过@Inject注解让Daager2为其提供依赖。

这样说起来太过于抽象，来举个例子：

• 在类的构造函数上使用@Inject：
  要获得adapter的实例化对象，那么我们可以通过@Inject依赖注入，在Activity中就能得到adapter的实例化对象了。

@Inject
public MyAdapter() {

  }
@Inject
MyAdapter mAdapter;

得到adapter的实例化对象后，再去设置context和数据源：

@OnClick(R.id.b_test)
  public void onViewClicked() {
      List list = new ArrayList<>();

      for (int i = 0; i < 5; i++) {

          list.add("这是第  " + (i+1)  + "  条数据！");
      }

      DaggerTestActivityComponent.create().inject(this);
      mAdapter.setContext(this);
      mAdapter.setList(list);

      mRvName.setLayoutManager(new LinearLayoutManager(this));
      mRvName.setHasFixedSize(true);

      mRvName.setAdapter(mAdapter);

  }

• 使用某个类的实例化对象
  假如，有一个Student的类，我们需要在某个时候使用它，那么，我们可以直接在使用的地方，直接用：

  @Inject
  Student mStudent;

• @Model
  @Model这个注解使用在Module标注的类中的，第一个@Inject注解是使用在类中的构造函数上。当然使用@Inject注解的，同样可以使用@Model来进行依赖注入。

• @Provides
  @Provides是用来标注类中的方法的，一般配合@Model使用。通过依赖注入获取实例化对象时，@Provide可以直接调用标注的方法，完成赋值或者其他的一些操作。

@Module
public class StudentModel {
    @Provides
    public Student getStudent(){
        Student student = new Student();
        student.setId(1);
        student.setAge(24);
        student.setName("Leo");
        student.setGender("male");
        return student;
    }
}

• @Component
  我们在被使用的类中标注了注解，那么，我们使用时，是怎么将依赖方和被依赖方关联起来的？所以，这个时候就要使用到@Component了，它是依赖方和需要依赖方之间的桥梁，把相关依赖注入到其中。

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

这个时候，我们就可以在activity中使用student这个对象了。

@OnClick(R.id.b_student)
public void onViewClicked() {
      Toast.makeText(this, mStudent.toString(), Toast.LENGTH_SHORT).show();
  }

值得注意的是相关依赖写好后，需要rebuild工程才能使用，因为Dagger2是使用的是RunTime注解。

@Override
  protected void onCreate(Bundle savedInstanceState) {
      super.onCreate(savedInstanceState);
      setContentView(R.layout.activity_main);
      ButterKnife.bind(this);
      //Rebuild Poject生成的类 注入到MainActivity中
      DaggerMainActivityComponent.create().inject(this);
  }

文中的代码已上传至github
Dagger2Demo