配制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

/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

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

model.puml

從圖中可以看出model類中只使用了一個注釋Inject，分別標記了CoffeeMaker里的heater、pump字段、構造器和Thermosiphon的構造器，Inject作用之前已經提到了。
然后查看module的UML類圖，如下

module.puml

//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

//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

rebuild path

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

更加強大的Dagger2