手把手教你使用Android APT

转载

Liuqz2009 2023-01-05 11:50:34

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 的方式如下图：

手把手教你使用Android APT_Test

image

此库的build.gradle如下：

手把手教你使用Android APT_自动生成_02

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')
}

jdk同上库
AutoService 主要的作用是注解 processor 类，自动生成。
JavaPoet 这个库的主要作用就是帮助我们通过类调用的形式来生成代码。
依赖上面创建的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就完成了