×

Dagger2最简单入门

96
可恶的地瓜
2016.08.05 17:07* 字数 1405

什么是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的朋友一个帮助。

有什么问题,大家可以留言。

学习
Web note ad 1