用dagger2煮咖啡

配制dagger2开发环境

• 配制project下的build.gradle

buildscript {  
     repositories {    
         jcenter()   
     }

    dependencies {        
        classpath 'com.android.tools.build:gradle:2.1.0'        
        classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'            
        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files    
    }
}

• 配制module下的build.gradle

• 添加apt插件 apply plugin: 'com.neenbedankt.android-apt'
• 添加dagger依赖

dependencies {
        ...
 
        apt 'com.google.dagger:dagger-compiler:2.5'    
        compile 'com.google.dagger:dagger:2.5'
}

说明：gradle中的依赖分为两种：一种是gradle自身需要的依赖，另一种是构建工程需要的依赖。
在buildscript下的dependencies结点添加gradle自身需要的依赖，如：

/Dagge2Coffee/build.gradle

直接在dependencies结点下添加构建工程需要的依赖，如：

/Dagge2Coffee/app/build.gradle

apt是由android-apt插件提供的，添加android-apt插件的方法为 apply plugin: 'com.neenbedankt.android-apt' 其中apply plugin是gradle语法，所在包为'com.android.tools.build:gradle:2.1.0'即在buildscript－depenpendencs下classpath 'com.android.tools.build:gradle:2.1.0'引入的。添加android-apt插件后就可以使用apt命令了。apt 'com.google.dagger:dagger-compiler:2.5'的含意是，编译时使用dagger－compiler，打包时不需要将dagger-compiler包打包到apk中。因为dagger2在编译时根据注解生成相应代码，所以在打包时没有必要将不需要的三方包(dagger-compiler)打包到apk里。

这里说一下dagger-compiler与dagger的区别

• dagger-compiler.jar有8M左右，dagger.jar有27K左右
• dagger-compiler.jar是根据注解生成代码的主体，dagger.jar里基本上只包含工厂类和注解类
• dagger-compiler.jar在编译时使用，不需要打包到apk里；dagger.jar提供注解和抽象，需要打包到apk里

根据Dagger1的CoffeeSimple写一个Dagger2程序

Dagger2有很多注解，而且可以自定义注解。本次任务是用最少的代码写出一个最小的程序。用到Module，Provides，Inject，Component，Singleton五个最基本的注解，以下是它们的简单介绍：

• Module作用于类上，表明该是一个工厂类，产生各种活生生的类
• Provides作用于Module中的方法上，表示该方法可以提供一个类
• Singleton表示提供的类为单列
• Inject标记需要注入的变量
• Component作用于接口类上，使该类相当于一个纽带，连接Module和需要注入实例的类（如：Activity）。就是将Module中生成的类注入（赋值）到Activity中使用Inject标记的变量上

由于CoffeeSimple是基于Dagger1写的，主要意图是将CoffeeMaker注入到CoffeeApp的coffeeMaker变量，是一个java程序。我们用Dagger2在android程序上重新演绎一下该过程，所以这个CoffeeApp.java类就没有用了(用MainActivity.java代替)。看一下CoffeeSimple里的类

/CoffeeSimple/*.java

暂时先不管CoffeeApp，根据名字可以将它们简单分一下类，其中Heater, ElectricHeater, Pump, Thermosiphon, CoffeeMaker属于实体类(Model)，DripCoffeeModule, PumpModule属于提供类的工厂(Module)。
简单建立一个android demo，结构如下：

/Dagge2Coffee/app/src/main/java/rubo/dagge2coffee

接下来逐一介绍上面说到的五个注解在Dagger2Coffee中起到的作用
首先查看 实体类的UML类图，使用plantUML画的，各类图位置不好调整凑合着看吧。

model.puml

从图中可以看出model类中只使用了一个注释Inject，分别标记了CoffeeMaker里的heater、pump字段、构造器和Thermosiphon的构造器，Inject作用之前已经提到了。
然后查看module的UML类图，如下

module.puml

这里看不出注解，因为我不知道如何使用plaintUml给类图添加注解~~ 但是还是可以看出Module就是一个工厂类，只提供生成类的方法。现在进入module类里查看使用了什么注解

//DripCoffeModul.java

@Module
public class DripCoffeeModule {
    @Provides
    @Singleton
    Heater provideHeater() {
            return new ElectricHeater();
    }
}

//PumpModule.java

@Module
public class PumpModule {
        @Provides
        @Singleton
        Pump providePump(Thermosiphon pump) {
            return pump;
        }
}

这里使用了三个注释，Module、Provides、Singleton 它们各自的作用之前已经提到了。
基本的材料都已经做好了，接下来该使用了。
小插曲，用过ButterKnife的同学都应该知道以下代码片段的作用

sample

我们如何使用Dagger2达到同样的效果呢，比如这样

sample2

直接这样肯定是不行的，因为ButterKnife是根据传入的context定位到需要注入的字段mButton，然后通过资源加载器将实例赋值给mButton。ButterKnife能如此干净利落的完成注入主要完成两个操作：定位需要注入的view，通过资源加载器注入实例。Dagger2也需要这两步操作才能像ButterKnife那样优雅的完成注入，现在已经完成第一个操作（定位需要进入注入的字段），接下来完成第二个操作——添加“资源加载器”。其实我们已经写好这个“资源加载器”了，就是之前写的那两个module类。但是如何把它们关联起来呢？这时候该Component就出场了。
由于MainActivityComponent只是一个接口，这里直接给出它的源码

//MainActivityComponent.class

@Singleton
@Component(modules = {DripCoffeeModule.class, PumpModule.class})
public interface MainActivityComponent {
        void inject(MainActivity activity);
}

就是在这里activity与modules建立了联系，当然这里只是定义的接口，但是通过dagger-compiler库(配制dagger开发环境时配制好的)可以为该接口生成一个实现DaggerMainActivityComponent。activity与module有了联系，module提供的实例自然可以注入到activity中需要注入的字段(用@Inject标记的字段)上。注意，每次编辑Component接口（如MainActivityComponent）时，apt会自动调用dagger-compile重新编译DaggerComponent（如DaggerMainActivityComponent）。好了，现在可以使用Dagger2煮咖啡了，代码如下：

public class MainActivity extends AppCompatActivity {
        
        @Inject    
        CoffeeMaker mCoffeeMaker;
        
        @Override
        protected void onCreate(Bundle savedInstanceState) {
            super.onCreate(savedInstanceState);
            setContentView(R.layout.activity_main);
            DaggerMainActivityComponent.builder()
                    .dripCoffeeModule(new DripCoffeeModule())
                    .pumpModule(new PumpModule())
                    .build().inject(this);
            mCoffeeMaker.brew();
        }
}

输出

console output

如果代码没有错误，但是没有发现DaggerMainActivityComponent类时，重新build一下项目就可以了

rebuild path

如果想看一下DaggerMainActivityComponent或者查看由apt根据dagger-compile规则自动生成的代码时，到这个目录下去找

/Dagger2Coffee/app/build/generated/source/apt/debug

这个Demo只是最最基本的Dagger2的用法，还有很多高级用法自己慢慢体会吧。我相信只要入了门，其它的用的多了自然就会了。
咖啡煮完了，回家歇息吧... 这里是Dagger2Coffee源码。
以下是扩展阅读

更加强大的Dagger2