本文将尝试列出@Inject注解的各种用法。后面的一系列文章都会对Dagger2的用法进行各个点逐一击破,以便更好的理解Dagger2。
请注意,本文将省略启动注入过程的方法的调用,即本文是不完整的用法,我们仅仅会看到@Inject的使用点而忽略掉其他一些必要的调用。
使用@Inject注解变量
这个是使用Dagger过程中必须出现的写法。因为注解了@Inject的变量表示该变量要求Dagger为其注入值。对于没有注解@Inject的变量,Dagger是不会为其注入值的。下面是@Inject注解变量的写法:
@Inject
public String str;
这样写表示变量str请求Dagger为其注入一个String值。该值可能从注解了@Inject的构造方法获取(这个我们下面会用到),也可能从注解了@Provides的方法的返回值获取(这个我们可以从前面的Dagger2 Android入门一文中看到相关用法)。
需要注意的是使用@Inject注解的变量不能是private变量,否则会报以下错误:
Error:(13, 20) 错误: Dagger does not support injection into private fields
原因是Dagger2是采用编译时产生注入代码(一个注入工具类)来为变量注入值,注入过程如下所示:
public void injectMembers(MainActivity instance) {
if (instance == null) {
throw new NullPointerException("Cannot inject members into a null reference");
}
supertypeInjector.injectMembers(instance);
instance.str = strProvider.get();//为变量str注入值,若变量str为private,此处就无法引用到str
}
使用@Inject注解构造方法
使用@Inject注解构造方法的写法之一如下所示:
public class StringGetter {
@Inject
StringGetter(){}
}
这种写法表示StringGetter类将为注解了@Inject的StringGetter对象注入无参构造方法构造的对象。如果同一个项目下其他类有下面的写法,那么Dagger将会为其构造一个对象并注入:
public class MainActivity extends Activity {
@Inject
StringGetter getter;//Dagger会调用StringGetter的无参构造方法创建对象并赋值给此处的getter
...
}
对于有参构造方法,如下所示:
public class StringGetter {
@Inject
StringGetter(OtherGetter getter){
...
}
}
则Dagger会自动为所有构造参数注入值,参数值的来源则与@Inject注解变量的值的来源一样。最后要注意的一点就是,在@Inject注解的变量或者有参构造方法的参数没有值提供方的情况下,其值会为null,大家需要注意这个问题。