前言:隨著一些如ButterKnife狞换,dagger等的開(kāi)源注解框架的流行蒜绽,APT的概念也越來(lái)越被熟知歧胁。這篇文章將介紹APT的概念滋饲,以及我們?cè)趺蠢肁PT來(lái)自定義一個(gè)注解。
一喊巍,APT的介紹
APT英文全稱(chēng):Android annotation process tool是一種處理注釋的工具屠缭,它對(duì)源代碼文件進(jìn)行檢測(cè)找出其中的Annotation,使用Annotation進(jìn)行額外的處理崭参。
Annotation處理器在處理Annotation時(shí)可以根據(jù)源文件中的Annotation生成額外的源文件和其它的文件(文件具體內(nèi)容由Annotation處理器的編寫(xiě)者決定)呵曹,APT還會(huì)編譯生成源文件和原來(lái)的源文件,將它們一起生成class文件何暮。簡(jiǎn)言之:APT可以把注解奄喂,在編譯時(shí)生成代碼。
二海洼,APT的處理要素
注解處理器(AbstractProcess)+代碼處理(javaPoet)+處理器注冊(cè)(AutoService)+apt
三跨新,使用APT來(lái)處理annotation的流程
1.定義注解(如@automain)
2.定義注解處理器
3.在處理器里面完成處理方式,通常是生成java代碼坏逢。
4.注冊(cè)處理器
5.利用APT完成如下圖的工作內(nèi)容域帐。
四,使用APT的簡(jiǎn)單項(xiàng)目
1.新建項(xiàng)目APTProject
2.在項(xiàng)目對(duì)應(yīng)的build.gradle文件中添加APT工具依賴(lài)词疼。位置如下所示:
dependencies {
classpath 'com.android.tools.build:gradle:2.2.3'
//添加APT依賴(lài)
classpath 'com.neenbedankt.gradle.plugins:android-apt:1.8'
}
3.在對(duì)應(yīng)的module的build.gradle文件中添加下面的依賴(lài):
apply plugin: 'com.android.application'
//添加APT plugin
apply plugin: 'com.neenbedankt.android-apt'
4.創(chuàng)建java Library Module俯树,命名為apt-lib,并把這個(gè)module引入到app中贰盗。
編寫(xiě)如下的類(lèi):
@Target(ElementType.TYPE) //作用在類(lèi)上
@Retention(RetentionPolicy.RUNTIME)//存活時(shí)間
public @interface AutoCreate {
}
5.再創(chuàng)建一個(gè)java Library Module,命名為apt-process阳欲,并把這個(gè)module引入到app中舵盈。
6.編寫(xiě)下面的類(lèi)來(lái)處理注解
package com.wjstudio;
import com.example.AutoCreat;
import com.google.auto.service.AutoService;
import com.squareup.javapoet.JavaFile;
import com.squareup.javapoet.MethodSpec;
import com.squareup.javapoet.TypeSpec;
import java.io.IOException;
import java.util.Collections;
import java.util.Set;
import javax.annotation.processing.AbstractProcessor;
import javax.annotation.processing.Processor;
import javax.annotation.processing.RoundEnvironment;
import javax.lang.model.element.Modifier;
import javax.lang.model.element.TypeElement;
/**
* 注解處理器
* 完成注解的處理
* 1.處理哪個(gè)注解
* 2.如何處理
*/
//注冊(cè)處理器陋率,告知APT,AutoCrate是由TestProcess處理@AutoService(Processor.class)public class TestProcess extends AbstractProcessor {
@Override
public Set<String> getSupportedAnnotationTypes() {
//定義需要處理的注解
return Collections.singleton(AutoCreat.class.getCanonicalName());
}
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
//如何處理該注解
/*
* hello.java
public final class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello, JavaPoet!");
}
}
*/
//文件
//文件內(nèi)容--java代碼生成工具javapoet
//MethodSpec:定義方法
//TypeSec:定義類(lèi)
//JavaFile:生成.java文件
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;
}
}
需要再改lib中引入
compile 'com.squareup:javapoet:1.8.0'
compile 'com.google.auto.service:auto-service:1.0-rc2'
這里為了方便解釋加了漢字秽晚,在AndroidStudio中編譯的時(shí)候不能加漢字瓦糟。
7.在使用注解的地方添加依賴(lài)
compile project(':apt-process')
apt project(':apt-process')
8.使用生成的注解
在app Module對(duì)應(yīng)的 MainActivity上加上注解,如下赴蝇,編譯之后可以看到生成的java類(lèi)菩浙。
@AutoCreatpublic
class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
}
}
Rebuild之后,生成如下源代碼:
至此完成了Apt的介紹和簡(jiǎn)單的應(yīng)用句伶。
例子詳見(jiàn)https://github.com/songwenju/APTProject劲蜻,如果對(duì)您有幫助,歡迎star和fork考余。
版權(quán)聲明:本文為博主原創(chuàng)文章先嬉,轉(zhuǎn)載請(qǐng)注明出處。