APT的使用1

APT(Annotation Processing Tool) 注解编译时工具。现在越来越多的框架使用apt技术来实现或重写,如Dagger2、ButterKnight、ARouter。APT技术可以简单理解为在编译时通过处理注解来实现部分代码逻辑,动态生成java class文件,供我们使用。

注解的介绍

APT系列:
APT的使用1(apt的接入)
APT的使用2(实现findViewById功能)


下面通过一个简单的apt接入实例来了解apt的基本用法

1. 新建一个名为lib的java library

lib的build.gradle

apply plugin: 'java-library'

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
}

sourceCompatibility = "1.7"
targetCompatibility = "1.7"

添加一个注解类,如@Test

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.CLASS)
public @interface Test {
    String path();
}

2. 新建一个名为apt-lib的java library,来实现处理注解的逻辑

apt-lib的build.gradle

apply plugin: 'java-library'

dependencies {
    implementation fileTree(dir: 'libs', include: ['*.jar'])
    implementation project(':lib')
    implementation 'com.google.auto.service:auto-service:1.0-rc4'
    implementation 'com.squareup:javapoet:1.11.1'
}

sourceCompatibility = "1.7"
targetCompatibility = "1.7"

其中com.google.auto.service:auto-service:1.0-rc4是google开源的用于注册Processor的工具库,com.squareup:javapoet:1.11.1是一个开源的生产class文件的库。

实现一个简单的处理注解的processor类

@AutoService(Processor.class)
@SupportedSourceVersion(SourceVersion.RELEASE_7)
@SupportedAnnotationTypes({"com.example.lib.Test"})
public class MyProcessor extends AbstractProcessor {
    @Override
    public boolean process(Set<? extends TypeElement> set, RoundEnvironment roundEnvironment) {
        // 生成一个main方法,带参数,并声称语句,传入参数
        MethodSpec main = MethodSpec.methodBuilder("main")
                .addModifiers(Modifier.PUBLIC, Modifier.STATIC)
                .addParameter(String[].class,"args")
                .addStatement("$T.out.println($L)",System.class, "args[0]")   
                .build();
        // 生成一个类、接口,添加一个方法给它
        TypeSpec typeSpec = TypeSpec.classBuilder("HelloWord")
                .addModifiers(Modifier.PUBLIC,
                Modifier.FINAL).addMethod(main).build();
        // 生成java文件,传入类、包名等信息
        JavaFile file = JavaFile.builder("com.jason.test", typeSpec).build();

        try {
            // 写到我们的环境中去
            file.writeTo(processingEnv.getFiler());
        } catch (IOException e) {
            e.printStackTrace();
        }
        return true;
    }
}

上述代码中的 $L,$T 代表不同的字面量类型,具体参考这里

3.在app中配置依赖

打开app的build.gradle文件配置如下:

dependencies {
    xxx...
    compile project(':lib')    // 引入lib
    annotationProcessor project(':apt-lib')  // 指定使用apt处理我们的apt-lib库
}

注意:上述操作在gradle版本3.0.1及以上,如果低于这个版本,在根build.gradle文件中添加

// 在根build.gradle文件添加
classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'

// 在app的build.gralde中添加
apply plugin: 'com.neenbedankt.android-apt'

然后点击rebuild,就会在目录(app/build/generated/source/apt/debug/包名/Test)下生成我们的HelloWord文件了,名字在MyProcessor中指定了,可以很灵活的指定。

4.在app中使用注解类@Test

在项目编译期,annotationProcessor project(':TestCompiler')这里会处理项目中的Processor类。最后也可以在项目中操作Processor里生成的HelloWorld类。

@Test(path = "main")
public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        HelloWord hw = new HelloWord();
        hw.main(new String[]{"我是一个processor"});
    }
}

#APT的运行方式、时机及注意点#

  • 根据sun官方的解释,APT是一个命令行工具,它对源代码文件进行检测并找出其中的RetentionPolicy为CLASS的annotation,然后使用annotation processor来处理,这个annotation processor使用一套反射api并支持JSR175规范。

  • APT在编译时自动查找左右继承自AbstractProcessor的类,然后调用他们的process方法,相当于在编译过程中执行代码。

  • 在Android Studio中找不到AbstractProcessor类是因为android.jar默认不包含javax的包,所以我们需要新建一个Module,指定为java library,然后在其中实现我们的processor。

  • @SupportedAnnotationTypes({"com.example.lib.Test"})通过这段代码指定要处理的注解类;@SupportedSourceVersion(SourceVersion.RELEASE_7)通过这段代码,指定编译的版本,这种通过注解指定编译版本和类型的方式是从Java1.7才有的。对于之前的版本是通过重写AbstractProcessor中的方法来指定的。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,905评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,140评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,791评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,483评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,476评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,516评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,905评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,560评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,778评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,557评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,635评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,338评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,925评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,898评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,142评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,818评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,347评论 2 342

推荐阅读更多精彩内容