Annotation实战【自定义AbstractProcessor】

   <h3>前言</h3>    <p>在使用Java的过程中，每个开发人员都接触过@Override, @Deprecated等等各式各样的注解，这些东西是java最基础的一些原生定义好的annotation。本文通过一个实例演示如果自定义自己的annotation，使得在编译源码代码阶段进行额外操作。<a href="/misc/goto?guid=4959672848926030221">案例源码</a></p>    <h3>预热</h3>    <p>简单说一下annotation的基本知识，从java的官方技术文档可以直接找到annotation的技术点。</p>    <pre>  <code class="language-java">Annotations, a form of metadata, provide data about a program that is not part of the program itself. Annotations have no direct effect on the operation of the code they annotate.</code></pre>    <p>Annotations是一种元数据，其作用在于提供程序本身以外的一些数据信息，也就是说Annotation他不会属于程序代码本身，不参与逻辑运算，故而不会对原程序代码的操作产生直接的影响。</p>    <p>一般来说Annotation有如下三种使用情形：</p>    <ul>     <li><strong>Information for the compiler</strong> — Annotations can be used by the compiler to detect errors or suppress * warnings.</li>     <li><strong>Compile-time and deployment-time processing</strong> — Software tools can process annotation information to generate code, XML files, and so forth.</li>     <li><strong>Runtime processing</strong> — Some annotations are available to be examined at runtime.</li>     <li><strong>为编译器提供辅助信息</strong> — Annotations可以为编译器提供而外信息，以便于检测错误，抑制警告等.</li>     <li><strong>编译源代码时进行而外操作</strong> — 软件工具可以通过处理Annotation信息来生成原代码，xml文件等等.</li>     <li><strong>运行时处理</strong> — 有一些annotation甚至可以在程序运行时被检测，使用.</li>    </ul>    <p>具体annotation的详细知识点可以参考技术文档，本文案例针对的是<strong>编译源代码时进行而外操作</strong>。</p>    <h3>目标</h3>    <p>用过顶顶大名的Dagger，Butterknife等依赖注入的童鞋可能知道，他们就通过运行时annotation预处理技术实现动态的生成代码。现在我们先做一个简单的案例：</p>    <pre>  <code class="language-java">通过定义一个annotation，在编译代码的时候，凡是用该annotation声明过的类，方法，我们都要在控制台输出他们的信息</code></pre>    <p>下文涉及的编码等工作是基于IntelliJ Idea和Android Studio，读者也可以根据自己的实际情况选用其他诸如Eclipse的工具。</p>    <h3>开工</h3>    <p>首先用IntelliJ新建一个java标准工程，同时勾选maven支持，我们需要新建一个自己的AbstractProcessor类, 其中process为主要方法，在里面处理接收到的所有被PrintMe修饰过的元素，这里是直接输出器信息。</p>    <pre>  <code class="language-java">@SupportedAnnotationTypes({"com.avenwu.annotation.PrintMe"})  public class MyProcessor extends AbstractProcessor {      public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment env) {          Messager messager = processingEnv.getMessager();          for (TypeElement te : annotations) {              for (Element e : env.getElementsAnnotatedWith(te)) {                  messager.printMessage(Diagnostic.Kind.NOTE, "Printing: " + e.toString());              }          }          return true;      }        @Override      public SourceVersion getSupportedSourceVersion() {          return SourceVersion.latestSupported();      }  }</code></pre>    <p>现在新建PrintMe，简单起见现在可以什么不写，仅需标注其使用策略为RetentionPolicy.SOURCE</p>    <pre>  <code class="language-java">@Retention(RetentionPolicy.SOURCE)  public @interface PrintMe {  }</code></pre>    <p>现在我们需要生成jar文件，修改pom.xml，默认生成的pom.xml需要再添加jar，和maven-compiler-plugin，修改完毕后应该如下：</p>    <pre>  <code class="language-xml"><?xml version="1.0" encoding="UTF-8"?>  <project xmlns="http://maven.apache.org/POM/4.0.0"       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"       xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">      <modelVersion>4.0.0</modelVersion>        <groupId>groupId</groupId>      <artifactId>AnnotationProcessorTest</artifactId>      <version>1.0-SNAPSHOT</version>      <packaging>jar</packaging>      <build>          <plugins>              <plugin>                  <artifactId>maven-compiler-plugin</artifactId>                  <version>2.3.2</version>                  <configuration>                      <source>1.6</source>                      <target>1.6</target>                      <!-- Disable annotation processing for ourselves. -->                      <compilerArgument>-proc:none</compilerArgument>                  </configuration>              </plugin>          </plugins>      </build>  </project></code></pre>    <p>为了我们的AbstractProcessor内被使用，需要在META-INF中显示标识，在resources资源文件夹下新建META-INF/services/javax.annotation.processing.Processor</p>    <pre>  <code class="language-java">com.avenwu.annotation.MyProcessor</code></pre>    <p>至此可以build生成jar了。<br> <img alt="Annotation实战【自定义AbstractProcessor】" src="https://simg.open-open.com/show/335b12426425c9c384ae3fe7c4218af6.png" width="382" height="549"></p>    <p>同时我们可以看一下生成的jar里面都有什么东西：<br> <img alt="Annotation实战【自定义AbstractProcessor】" src="https://simg.open-open.com/show/ad7ff4401d2ccdf204ee45ecdcb81439.png" width="609" height="247"></p>    <h3>测试</h3>    <p>现在我们需要测试一下生成的jar包是不是如预期能输出信息。将AnnotationProcessorTest.jar拷贝置一个测试项目的libs，然后在任意选择几个位置用PrintMe修饰：<br> <img alt="Annotation实战【自定义AbstractProcessor】" src="https://simg.open-open.com/show/9ccb361f727c026e0bf6b8fb28d72329.png" width="273" height="437"><br> <img alt="Annotation实战【自定义AbstractProcessor】" src="https://simg.open-open.com/show/395c7b2b2995a8ee5b749ab38fa962b5.png" width="531" height="367"></p>    <p>现在编译测试项目，在输出console了面观察日志<br> <img alt="Annotation实战【自定义AbstractProcessor】" src="https://simg.open-open.com/show/eaa384ab37ba7c1cc1bc1aa7dc93da8d.png" width="487" height="567"></p>    <h3>参考</h3>    <ol>     <li><a href="/misc/goto?guid=4959622022746580996">http://en.wikipedia.org/wiki/Java_annotation</a></li>     <li><a href="/misc/goto?guid=4959556171930952486">http://docs.oracle.com/javase/tutorial/java/annotations/</a></li>     <li><a href="/misc/goto?guid=4959672849085049266">http://programmaticallyspeaking.com/playing-with-java-annotation-processing.html</a></li>     <li><a href="/misc/goto?guid=4959672849171392432">https://github.com/provegard/aptdemo</a></li>    </ol>    <p>via: http://www.cnblogs.com/avenwu/p/4173899.html </p>