自定义注解之编译时注解(RetentionPolicy.CLASS)(二)——JavaPoet

原创 2016年08月07日 13:24:59

在使用编译时注解时,需要在编译期间对注解进行处理,在这里我们没办法影响程序的运行逻辑,但我们可以进行一些需处理,比如生成一些功能性代码来辅助程序的开发,最常见的是生成.java 源文件,并在程序中可以调用到生成的文件。这样我们就可以用注解来帮助我们处理一些固定逻辑的重复性代码(如butterknife),提高开发的效率。

通过注解处理器来生成 .java 源文件基本上都会使用javapoet 这个库,JavaPoet一个是用于产生 .java 源文件的辅助库,它可以很方便地帮助我们生成需要的.java 源文件,下面来看下具体使用方法。

JavaPoet

在使用前需要先引入这个库,和 AutoService一样可以通过AndroidStudio 直接添加,如下:


下面以最简单的 HelloWorld 例子来看下怎么使用JavaPoet

先定义一个注解:

/**
 * JavaPoet HelloWorld 例子
 */
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.TYPE)
public @interface JPHelloWorld {
}

在定义个注解处理器来处理这个注解:

/**
 * 处理HelloWorld注解.
 */
@AutoService(Processor.class)
public class HelloWorldProcess extends AbstractProcessor {

    private Filer filer;

    @Override
    public synchronized void init(ProcessingEnvironment processingEnv) {
        super.init(processingEnv);
        // Filer是个接口,支持通过注解处理器创建新文件
        filer = processingEnv.getFiler();
    }

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        for (TypeElement element : annotations) {
            if (element.getQualifiedName().toString().equals(JPHelloWorld.class.getCanonicalName())) {
                // 创建main方法
                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();
                // 创建HelloWorld类
                TypeSpec helloWorld = TypeSpec.classBuilder("HelloWorld")
                        .addModifiers(Modifier.PUBLIC, Modifier.FINAL)
                        .addMethod(main)
                        .build();

                try {
                    // 生成 com.example.HelloWorld.java
                    JavaFile javaFile = JavaFile.builder("com.example", helloWorld)
                            .addFileComment(" This codes are generated automatically. Do not modify!")
                            .build();
                    // 生成文件
                    javaFile.writeTo(filer);
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }
        return true;
    }

    @Override
    public Set<String> getSupportedAnnotationTypes() {
        Set<String> annotations = new LinkedHashSet<>();
        annotations.add(JPHelloWorld.class.getCanonicalName());
        return annotations;
    }

    @Override
    public SourceVersion getSupportedSourceVersion() {
        return SourceVersion.latestSupported();
    }
}

JavaPoet 来生成一个HelloWorld.java文件之前,我们还必须在 init()方法里获取到 Filer,这是一个用来辅助创建文件的接口,我们生成文件都通过它来处理。在 process()方法先创建了个 MethodSpec 表示一个方法,再创建一个 TypeSpec 表示一个类并添加上前面创建的方法,最后用 JavaFile 来生成对应的HelloWorld.java 并写入文件。

这是最简单的例子,整个语法结构也很清晰,相信做编程的看到这些使用方法都能猜到是做什么用的,我就没详细说了。除了这个例子,Github上还有很多其它示例,如果你想很好地了解编译时注解的使用的话,还是很有必要把每个例子都过一遍,如果不想自己敲粘贴复制下很容易的。

在代码中使用定义的注解:

@JPHelloWorld
public class MainActivity extends AppCompatActivity{
    // ...
}

重新 Make 下工程就可以看到生成的 HelloWorld.java 文件了,目录如下:


可以看到已经成功生成了 HelloWorld.java 文件,注意生成文件所在的目录,现在我们就可以在项目中直接使用这个 java 类了。当然了,这个例子没有什么实际的使用价值,你可以参考其它例子来生成你想要的代码,用法是很多的。

这里只写了个最简单的例子,没有深入更详细的使用方法,等后面有时间再来整理个更详细的介绍。

自定义注解之编译时注解(RetentionPolicy.CLASS)(三)—— 常用接口介绍

源码:AnnotationSample

自定义注解之编译时注解(RetentionPolicy.CLASS)(三)—— 常用接口介绍

前面介绍了关于编译时注解的使用方式,这里再补充一个关于注解处理器开发中的一些常用类、接口的使用方式和概念。 Element和TypeMirror 我觉得这两个是开发注解处理器最重要的两个概念,理解这两...
  • github_35180164
  • github_35180164
  • 2016年08月10日 17:33
  • 3583

自定义注解之编译时注解(RetentionPolicy.CLASS)(一)

说到编译时注解(RetentionPolicy.CLASS)都要和注解处理器(Annotation Processor)扯上关系,因为这里是真正体现编译时注解价值的地方。需要注意的一点是,运行时注解(...
  • github_35180164
  • github_35180164
  • 2016年08月05日 13:54
  • 9709

编译期注解之JavaPoet

0x00 概述上一篇限于篇幅只介绍了APT,这篇来继续介绍javapoet,是square公司的开源库。正如其名,java诗人,通过注解来生成java源文件,通常要使用javapoet这个库与File...
  • XSF50717
  • XSF50717
  • 2017年01月10日 23:14
  • 1918

深入理解编译注解(五)RetentionPolicy.SOURCE 和 RetentionPolicy.CLASS区别讨论

前言这篇我觉得应该是一个讨论篇,因为我自己还没有找到一个非常满意的答案,希望大家一起来讨论。正文元注解RetentionPolicy,表明注解的生命周期: 1、SOURCE:在原文件中有效,被编译...
  • u011315960
  • u011315960
  • 2017年03月22日 14:19
  • 2010

自定义注解之编译时注解(RetentionPolicy.CLASS)(二)——JavaPoet

在使用编译时注解时,需要在编译期间对注解进行处理,在这里我们没办法影响程序的运行逻辑,但我们可以进行一些需处理,比如生成一些功能性代码来辅助程序的开发,最常见的是生成.java 源文件,并在程序中可以...
  • vite_s
  • vite_s
  • 2016年11月24日 17:31
  • 162

Annotation注解APT(二):自定义注解

引言前文介绍了什么是注解?那如何使用注解?以及自定义注解?还有注解有什么用呢?一、注解的作用 编写文档:通过代码里标识的元数据生成文档,常用的有@param、@return等; 代码分析:通过代码里标...
  • xuewend
  • xuewend
  • 2017年06月20日 19:17
  • 298

自定义注解之编译时注解(RetentionPolicy.CLASS)(一)

关联内容: java注解基础概念总结 自定义注解之运行时注解(RetentionPolicy.RUNTIME) 自定义注解之源码注解(RetentionPolicy.SOURCE...
  • vite_s
  • vite_s
  • 2016年11月24日 17:29
  • 432

Android 打造编译时注解解析框架 这只是一个开始

转载请标明出处:http://blog.csdn.net/lmj623565791/article/details/43452969 ,本文出自:【张鸿洋的博客】1、概述记得很久以前,写过几篇博客,容...
  • lmj623565791
  • lmj623565791
  • 2015年02月05日 09:49
  • 61796

Android如何开发自定义编译时注解

前言      最近给公司写android的公司开发库,自写了一个注解库,用于方便公司写某些重复代码(findviewbyId、setOnClickListener、setOnTouchListe...
  • zhangxinjin
  • zhangxinjin
  • 2017年01月11日 16:02
  • 972

Android编译时注解框架系列1-什么是编译时注解

概述 Android编译时注解框架从入门到项目实践。该系列将通过5篇博客一步步教你打造一个属于自己的编译时注解框架,并在之后开源出基于APT的编译时注解框架。 提到注解,普遍都会有两种态度...
  • u010405231
  • u010405231
  • 2016年08月15日 13:46
  • 486
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:自定义注解之编译时注解(RetentionPolicy.CLASS)(二)——JavaPoet
举报原因:
原因补充:

(最多只允许输入30个字)