Dagger2最簡單入門

什么是Dagger2

Dagger2是Android上的一個依賴注入框架，那么什么是依賴注入，通俗一點來說就是我們不用去主動創建（new）某個對象，需要某個對象時，直接去Dagger2中去取即可，取個例子：

  • 不使用依賴注入
    <pre>
    public class AActivity extends Activity {
    private Account account;
    @Override
    public void onCreate(Bundle savedInstanceState, PersistableBundle persistentState) {
    super.onCreate(savedInstanceState, persistentState);
    // 這里需要使用到account對象，必須先創建account對象
    account = new Account();
    System.out.println(account);
    }
    }
    </pre>
  • 使用依賴注入
    <pre>
    public class AActivity extends Activity {
    // 如果需要使用依賴注入的形式，需要用到Inject的注解
    @Inject
    Account account;
    @Override
    public void onCreate(Bundle savedInstanceState, PersistableBundle persistentState) {
    super.onCreate(savedInstanceState, persistentState);
    // 在這里需要一些初始化的代碼，才能通過注解的形式創建account對象，這里主要描述什么是依賴注入，后面再講這一塊
    這是初始化dagger2的代碼
    // 這里需要使用到account對象
    System.out.println(account.toString());
    // 如果dagger2的環境配置成功，這里是不會報錯的
    }
    }
    </pre>

不知道現在對dagger2的概念有沒有一定的了解。

Dagger2集成

dagger2的集成主要修改兩個文件
1、項目的build.gradle文件
<pre>
buildscript {
repositories {
jcenter()
}
dependencies {
classpath 'com.android.tools.build:gradle:2.1.2'
// 添加android-apt的支持
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
}
}
</pre>
2、module的build.gradle文件
<pre>
apply plugin: 'com.android.application'
// 應用android-apt插件
apply plugin: 'com.neenbedankt.android-apt'
android {
compileSdkVersion 23
buildToolsVersion "23.0.2"
defaultConfig {
applicationId "com.yzd.dagger2demo"
minSdkVersion 18
targetSdkVersion 23
versionCode 1
versionName "1.0"
}
buildTypes {
release {
minifyEnabled false
proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
}
}
}
dependencies {
compile fileTree(dir: 'libs', include: ['*.jar'])

compile 'com.google.dagger:dagger:2.0.2'
apt 'com.google.dagger:dagger-compiler:2.0.2'
compile 'org.glassfish:javax.annotation:10.0-b28' // dagger2用到的Java標注

}
</pre>

Dagger2的簡單用法

使用Dagger2至少需要用到下面四個注解：

  • @Inject
    用在變量上時，表示該變量使用依賴注入；
    用在構造函數上時表示Dagger2使用該構造函數實例化該對象
  • @Component
    一般使用在類上面：用來連接@Module和@Inject
  • @Module
    一般使用在類上面：用來表示當前類是為Dagger2提供實例的地方
  • @Provides
    用在@Module類的方法上面：表示Dagger2根據有@Provides的地方來實例化對象

另外還有一個比較常見的注解：

  • @Singleton
    用在類或者方法上面，表示該類在Dagger2中是一個單例

下面開始使用Dagger2

1、創建一個Component接口，命名推薦用XXX+Component，并添加@Component注解，因為Component是用來連接@Module和@Inject，@Inject一般在Activity和其它我們需要用到的類中，所以Component寫法如下
<pre>
@Component(modules = AppModule.class)
public interface ApplicationComponent {
void inject(DemoApplication application);
void inject(MainActivity mainActivity);
}
DemoApplication和MainActivity是我們需要采用依賴注入實例化對象的地方，
@Component的參數就是Dagger2實例化DemoApplication和MainActivity中@Inject標注的對象的地方
</pre>
ApplicationComponent是一個接口，在編譯過程中Dagger2會生成這個接口的實現，該實現的類名為：Dagger + ApplicationComponent，即：Dagger + 接口的名稱。
DaggerApplicationComponent是我們后面需要使用的對象，所以我們在寫完Component之后最好編譯一下，編譯完成之后，我們會在module的build/generated/source/apt下面看到DaggerApplicationComponent這個類。
<p>
2、創建@Module類，開始是一個空的類，后面根據需要實例化的對象來添加相關依賴
<pre>
@Module
public class AppModule {

}
</pre>

3、創建實體對象
<pre>
public class User {
private String username;
public User(String username) {
this.username = username;
}
public String getUsername() {
return username;
}
}
</pre>

4、根據實體對象來完善@Module類
<pre>
@Module
public class AppModule {
@Provides
public User provideUser() {
return new User("李四");
}
}
</pre>

5、在Activity中使用依賴注入
<pre>
public class MainActivity extends AppCompatActivity {
@Inject
User user;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
DaggerApplicationComponent.builder().appModule(new AppModule()).build().inject(this);
System.out.println(user.getUsername());
}
}
</pre>

DaggerApplicationComponent.builder().appModule(new AppModule()).build().inject(this);
這是一個固定寫法，其中，appModule的方法是根據@Component中的參數AppModule.class的類名生成的一個方法，方法參數為AppModule，如果你的Module名是其它的名稱，這里會變成相應的名字。
inject的方法名可以隨便取，推薦使用inject表示把當前類注入到component中，返回值為void或者inject的參數

編譯運行，如果打印出"李四"，就說明Dagger2就使用成功了。

如果想要User為單例，則在@Module中提供User的地方加上@Singleton注解，另外@Component也要添加@Singleton注解

6、如果實體的構造函數需要依賴其它的類
當上面的User在實例化時需要其它的對象，比如：Context，或者其它類，的時候，我們需要在@Module中也提供Context和其它類的@Provides的方法
<pre>
User類：
public class User {
private String username;
private Context context;
public User(Context context, String username) {
this.context = context;
this.username = username;
}
public String getUsername() {
return username + context.toString();
}
}

@Module類
Context需要外面傳遞進來，所以為AppModule添加一個構造函數
@Module
public class AppModule {
private Context mContext;
public AppModule(Context application) {
this.mContext = context;
}
@Provides
public Context provideContext() {
return mContext;
}
@Provides
public User provideUser(Context context) {
// 這里的context不能直接使用類的mContext
return new User(context, "李四");
}
}
MainActivity類
public class MainActivity extends AppCompatActivity {
@Inject
User user;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
DaggerApplicationComponent.builder().appModule(new AppModule(getApplicationContext())).build().inject(this);
System.out.println(user.getUsername());
}
}
</pre>

如果User需要其它對象，跟上面情況類似。

到這里Dagger2最基本的用法就介紹完了，希望對想入門Dagger2的朋友一個幫助。

有什么問題，大家可以留言。

最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發布，文章內容僅代表作者本人觀點，簡書系信息發布平臺，僅提供信息存儲服務。

推薦閱讀更多精彩內容