Dagger 2 极速入门

Github地址

Dagger是一个快速的依赖注入框架，供Android和Java开发使用。之前由Square维护，如今转交给Google，Github连接为：github.com/google/dagg…

依赖注入

Dagger为依赖注入而生。什么是依赖？什么是注入？为何要使用依赖注入？这是咱们学习Dagger以前必须了解的。
依赖就是一个类中要使用其余的类来完成某些工做，这样一个类就依赖了另一个类。好比在MainActivity中必须使用一个User类的对象，那么MainActivity就依赖了User类。

public class MainActivity extends AppCompatActivity {

    User mUser;//MainActivity依赖User类

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        mUser = new User();//初始化mUser
        setContentView(R.layout.activity_main);
    }
}复制代码

通常咱们直接在MainActivity中直接初始化mUser对象，但若是有天User类的构造方法中增长了一个参数，好比用户名，那么全部调用User的无参构造方法的地方所有要修改，这显然不是咱们但愿看到的。因而咱们思考可不能够提供一个User的工厂类或者容器类专门负责User对象的建立，这样User对象的建立就不会跟MainActivity发生耦合，无论User的构造方法如何变，都不会影响到MainActivity。那么代码多是这样：

public class MainActivity extends AppCompatActivity {

    User mUser;//MainActivity依赖User类

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        mUser = UserFactory.getUser()//经过工厂类注入mUser
        setContentView(R.layout.activity_main);
    }
}复制代码

那么mUser对象就不是在MainActivity建立，而是由UserFactory建立，设置给mUser对象，这就能够称之为mUser被注入了，这样MainActivity就不须要关心User对象是怎样建立出来，对User对象建立的修改就不会影响到MainActivity里面的代码，这就是依赖注入的好处的。这就比如咱们打针，人体依赖药液来治疗疾病，但药液并非人体本身生产的，而是医药公司生产而后经过注射器注入到人体，而咱们人体根本就无需关心药液是如何被制造出来的。

Dagger的做用就是经过注解的方式，帮咱们自动生成建立对象的工厂类。

Dagger 2使用

1. 添加依赖

可经过连接github.com/google/dagg…查找最新版本

dependencies {
    compile 'com.google.dagger:dagger:2.11'
    annotationProcessor 'com.google.dagger:dagger-compiler:2.11'
}复制代码

2. 添加注解@Inject

分别在MainActivity的User成员变量和User的构造方法上添加@Inject依赖。

public class MainActivity extends AppCompatActivity {

    //成员变量上添加注解
    @Inject
    User mUser;
}


public class User {

    String name;

    //构造方法上添加注解
    @Inject
    public User() {
        this.name  = "Leon";
    }

}复制代码

3. 建立Component类

事实上完成第二步后，MainActivity中成员mUser并无调用构造方法完成初始化，还须要一个类来完成注入，这就是Component类。
咱们建立一个MainComponent接口，提供一个inject方法，其参数为将被注入的类MainActivity

public interface MainComponent {

    void inject(MainActivity activity);
}复制代码

而后，咱们在Android Studio下选择菜单build->Make Project，这时候，会在app模块下build/generated/source/apt/debug/包名/目录下生成三个文件DaggerMainComponent，MainActivity_MembersInjector，User_Factory。DaggerMainComponent即为接口MainComponent的实现类。

4. 注入

最后，咱们可使用生成的DaggerMainComponnet完成注入，成员变量mUser将被赋值。若是是老司机，是否是会以为这跟ButterKnife.bind(this)有殊途同归之妙呢？

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    //注入，内部会调用User的构造方法完成成员变量mUser的初始化
    DaggerMainComponent.builder().build().inject(this);
    //打印结果，mUser不为null
    Log.d(TAG, "onCreate: " + mUser.name);
}复制代码

Module使用

假如我想在一个Activity里面注入一个TextView，以下：

public class MainActivity extends AppCompatActivity {

    @Inject
    TextView mTextView;
}复制代码

若是按照上述步骤，就须要找到TextView的构造方法，加上一个@Inject注解，这个显然是没法作到的。Module就是为了解决不可以经过注解构造方法来建立一个实例的问题。咱们建立一个TextViewMoudle类，使用@Module注解。另外须要提供一个方法返回一个TextView实例，而且用@Provides注解。

@Module
public class TextViewModule {

    @Provides
    TextView provideTextView(Context context) {
        return new TextView(context);
    }
}复制代码

provideTextView方法有个Context参数，须要外界传入到TextViewModule，这里给TextViewModule提供一个带有Context参数的构造方法。另外还须要提供个provideContext方法返回上下文，由于Dagger框架调用provideTextView方法获取一个TextView实例时，发现要传一个Context类型的参数，这时候他会查找被@Provides注解而且返回值为Context类型的方法获取一个Context实例传入provideTextView方法。

@Module
public class TextViewModule {
    //保存一个上下文成员变量
    private Context mContext;

    //构造方法接收一个上下文
    public TextViewModule(Context context) {
        this.mContext = context;
    }

    @Provides
    TextView provideTextView(Context context) {
        return new TextView(context);
    }


    @Provides
    Context provideContext() {
        return mContext;
    }
}复制代码

接下来还须要在MainComponent接口上指定TextViewModule。而后点击菜单选项build->Make Project，这时又会在build/generated/source/apt/debug/包名/目录下生成两个新文件TextViewModule_ProvideContextFactory和TextViewModule_ProvideTextViewFactory。

@Component(modules = TextViewModule.class)
public interface MainComponent {

    void inject(MainActivity activity);
}复制代码

最后在注入时建立一个TextViewModule传入，表示告诉Dagger框架能够从TextViewModule中获取TextView实例。

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    //传入TextViewMoudle
    DaggerMainComponent.builder().textViewModule(new TextViewModule(this)).build().inject(this);
    FrameLayout frameLayout = (FrameLayout) findViewById(R.id.frame);
    //mTextView已被注入，不为null
    mTextView.setText(mUser.name);
    frameLayout.addView(mTextView);
}复制代码