手把手教你使用Android APT

Annotation(注解)

如果想学习APT(注解处理工具),那么就必须先了解Annotation的基础,对于不了解java注解基础的朋友们,请先学习java注解,再看本文。

APT

APT(Annotation Processing Tool)是一种处理注释的工具,它对源代码文件进行检测找出其中的Annotation,使用Annotation进行额外的处理。

Annotation处理器在处理Annotation时可以根据源文件中的Annotation生成额外的源文件和其它的文件(文件具体内容由Annotation处理器的编写者决定),APT还会编译生成的源文件和原来的源文件,将它们一起生成class文件。

创建Annotation Module

android studio 现在是最主流的安卓开发工具,而且也是最好用的,所有我这里讲的是apt在studio上的使用教程。

首先,我们需要新建一个Java Library,用来定义注解,所以库名最好为annotation,见名知意。注意,库一定要为Java Library,因为android Library不会引入javax.annotation等包,新建java Library 的方式如下图:

image

此库的build.gradle如下:

image

可根据自己的需求,修改jdk版本。

创建apt Module

创建一个名为apt的Java Library,见名知意,此库是用来编写如何处理注解的代码,同时通过注解自动生成代码。


配置build.gradle
apply plugin: 'java'
sourceCompatibility = 1.7
targetCompatibility = 1.7
dependencies {
    compile fileTree(dir: 'libs', include: ['*.jar'])
    compile 'com.google.auto.service:auto-service:1.0-rc2'
    compile 'com.squareup:javapoet:1.7.0'
    compile project(':annotation')
}
  1. jdk同上库

  2. AutoService 主要的作用是注解 processor 类,自动生成。

  3. JavaPoet 这个库的主要作用就是帮助我们通过类调用的形式来生成代码。

  4. 依赖上面创建的annotation Module。

    到这里所有的配置都完了,接下来编写代码。

定义注解

  在annotation库新建一个Test接口,定义注解
     ```
    @Target(ElementType.TYPE)
    @Retention(RetentionPolicy.CLASS) 
     public @interface Test {   }
         ```

定义Processor类

@AutoService(Processor.class)//自动生成 javax.annotation.processing.IProcessor 文件
@SupportedSourceVersion(SourceVersion.RELEASE_8)//java版本支持
@SupportedAnnotationTypes({"com.tuodao.annotation.Test"})//标注注解处理器支持的注解类型,就是我们刚才定义的接口Test,可以写入多个注解类型。
public class AnnotationProcessor extends AbstractProcessor {

   public Messager mMessager;
   public Elements mElements;
   public Filer mFiler;

   @Override
   public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
       mFiler = processingEnv.getFiler();//文件相关的辅助类
       mElements = processingEnv.getElementUtils();//元素相关的辅助类
       mMessager = processingEnv.getMessager();//日志相关的辅助类
     
      MethodSpec methodMain = MethodSpec.methodBuilder("main")//创建main方法
               .addModifiers(Modifier.PUBLIC, Modifier.STATIC)//定义修饰符为 public static
               .addJavadoc("@  此类由apt自动生成")//在生成的代码前添加注释
               .returns(void.class)//定义返回类型
               .addParameter(String[].class, "args")//定义方法参数
               .addStatement("$T.out.println($S)", System.class, "helloWorld")//定义方法体
               .build();
       TypeSpec helloWorld = TypeSpec.classBuilder("HelloWorld")/创建HelloWorld类
               .addModifiers(Modifier.PUBLIC, Modifier.FINAL)//定义修饰符为 public final
               .addMethod(methodMain)//添加方法
               .addJavadoc("@  此方法由apt自动生成")//定义方法参数
               .build();
       JavaFile javaFile = JavaFile.builder("com.tuodao.apt", helloWorld).build();// 生成源   代码
       try {
           javaFile.writeTo(mAbstractProcessor.mFiler);//// 在 app module/build/generated/source/apt 生成一份源代码
       } catch (IOException e) {
           e.printStackTrace();
       }
       return true;
   }
}

在App中使用

   配置app的build.gradle
      

     dependencies {
             //..
             compile project(':annotation')
             annotationProcessor project(':apt')//核心,有了这个app才会处理apt的代码
             }
 
     
           在随意一个类添加@Test注解
         
                 @Test
                  public class MainActivity extends AppCompatActivity {
                       @Override
                       protected void onCreate(Bundle savedInstanceState) {
                                    super.onCreate(savedInstanceState);
                                    setContentView(R.layout.activity_main);
                          }
                     }
         
        
     然后编译,在app的build/generated/source/apt目录下,可看到生成的代码

如下 :

                    /**
                     * @  此方法由apt自动生成 */
                         public final class HelloWorld {
                           /**
                           * @  此类由apt自动生成 */
                               public static void main(String[] args) {
                                    System.out.println("helloWorld");
                                }
                           }

至此,一个简单的HelloWorld就完成了

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

推荐阅读更多精彩内容