APT(Annotation Processing Tool
)即注解处理器,是一种注解处理的工具,用来在编译器扫描以及处理注解。以注解作为桥梁,通过预先设定好的代码规则来生成对应的Java代码。实际开发中有很多开源框架都是用到APT,例如:ButterKnife,Dagger2,EventBus,Spring框架等。
APT原理:在注解了某些代码元素(字段、函数、类)后,编译器检查
AbstractProcessor
的子类,自动调用process()
方法,将所有添加了指定注解的元素传递给该函数,在根据这些元素通过Java规则生成对应的Java代码。
现在我就简单的实现一个仿ButterKnife的功能。
实现ButterKnife中绑定View的功能
我们先观察在ButterKnife中生成的注解绑定的代码,寻找其规律后仿造即可:
package com.wdl.aptdemo;
public class MainActivityViewBinding {
public static void bind(MainActivity _mainActivity) {
_mainActivity.btn = (android.widget.Button) (_mainActivity.findViewById(2131165218));
_mainActivity.textView = (android.widget.TextView) (_mainActivity.findViewById(2131165326));
}
}
规律:依照规律指定Java生成规则
- 生成的Java文件与对应的Activity在同一个包下
- 类名Source+ViewBinding
- 方法名为bind,参数为Source _source静态方法
- _source.fieldName = (Type)(_source.findViewById(value));
实现的步骤:
- 创建名为
apt_annotation
的Java Library(Moudle),用于存放定义的注解(创建过程省略) - 创建名为
apt_processor
的Java Library(Moudle),并引用apt_annotation,用于处理注解以及生成Java代码
在apt_processor下
的build.gradle
中如下依赖:(看注释)
apply plugin: 'java-library'
dependencies {
implementation fileTree(dir: 'libs', include: ['*.jar'])
// 注解注册处理器
implementation 'com.google.auto.service:auto-service:1.0-rc2'
// square 开源的代码生成框架,通过API生成指定格式(修饰符 返回值 参数 函数体)的代码
implementation 'com.squareup:javapoet:1.10.0'
implementation project(':apt_annotation')
}
sourceCompatibility = "7"
targetComp