Dagger2中Gradle插件
Dagger2提供了丰富的注解，利用这些注解我们可以轻松的实现依赖注入，这些注解是如何实现的呢？Dagger2自定义了Gradle插件用来处理注解。市面上ButterKnife，EventBus等注解的实现都是基于Gradle插件完成的，他们都是在编译期间根据注解产生代码，最终并将其打包到apk中。
Dagger2自定义注解的要素
自定义注解（Annotation）+注解处理器（AbstractProcess）+代码处理（javaPoet）+处理器注册（AutoService）+APT(annotationProcessor)
APT处理annotaion的流程
- 定义注解（如@automain）
- 继承AbstractProcess)定义注解处理器，自定义需要生成代码
- 指定处理器
- APT自动完成如下工作。
处理注解的工具叫做APT(Annotation Processing Tool),它对源代码文件进行检测找出其中的Annotation，使用Annotation进行额外的处理。 Annotation处理器在处理Annotation时可以根据源文件中的Annotation生成额外的源文件和其它的文件(文件具体内容由Annotation处理器的编写者决定),APT还会编译生成的源文件和原来的源文件，将它们一起生成class文件。
下面我们以一个简单的例子来说明如何使用APT自定义注解
新增一个java Module 名为apt-lib， 定义注解类：
@Target(ElementType.TYPE) //作用在类上
@Retention(RetentionPolicy.RUNTIME)//存活时间
public @interface AutoCreate {
}
新增一个java Module
名为apt-process，编写注解处理器，实现注解的逻辑。
@AutoService(Processor.class)
public class TestProcess extends AbstractProcessor {
@Override
public Set getSupportedAnnotationTypes() {
return Collections.singleton(AutoCreat.class.getCanonicalName());
}
@Override
public boolean process(Set annotations, RoundEnvironment roundEnv) {
MethodSpec main = MethodSpec.methodBuilder("main")
.addModifiers(Modifier.PUBLIC, Modifier.STATIC)
.returns(void.class)
.addParameter(String[].class, "args")
.addStatement("$T.out.println($S)", System.class, "Hello, JavaPoet!")
.build();
TypeSpec helloWorld = TypeSpec.classBuilder("HelloWorld")
.addModifiers(Modifier.PUBLIC, Modifier.FINAL)
.addMethod(main)
.build();
JavaFile javaFile = JavaFile.builder("com.songwenju.aptproject", helloWorld)
.build();
try {
javaFile.writeTo(processingEnv.getFiler());
} catch (IOException e) {
e.printStackTrace();
}
return false;
}
}
可以看到这里使用了注解@AutoService ，这是google的一个工具，需要我们在项目中引入。另外java文件的生成过程也是用了google的工具javapoet，也需要单独引入。
需要使用的lib
dependencies {
compile project(':apt-lib')
compile 'com.squareup:javapoet:1.8.0'
compile 'com.google.auto.service:auto-service:1.0-rc2'
}
至此一个简单的自定义注解类，就完成了，只是生成了一个HelloWorld.java文件，里面只有一个main()函数
自定义注解类的使用
使用的话，更简单。在java文件中使用如下：
@AutoCreat
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
}
}
配置build.gradle文件
dependencies {
//添加下面这句就可以了
compile project(":apt-lib")
annotationProcessor project(':apt-process')
}
编译结果
public final class HelloWorld {
public HelloWorld() {
}
public static void main(String[] args) {
System.out.println("Hello, JavaPoet!");
}
}
自定义注解的好处
自定义注解的功能是很多样的，可以根据需要开发不同的注解处理器。比如：Dagger2利用注解实现依赖注入，ButterKnife利用注解实现view的的实例化和点击事件的设置等。自定义注解在帮助我们自动实现既定的逻辑非常有效，提高了开发效率，通过本文的学习，我们发现如何自定义注解在强大的APT框架下，也很容易实现。