程序员历小冰
2016-02-24
791浏览量
原文请看摸我
这是有关注解代码生成技术系列博文的第二部分。在第一部分(摸我)中,我们介绍了注解的基本概念与用法。
在本篇博文中我们将介绍注解处理器的基本概念和使用运行方法。
注解功能强大。你可以使用注解来设置各类元数据或者配置信息,语法格式优雅并且功能强大。
从目前我们了解的知识来看,注解比起Javadoc
来有很多优势,但是这些好像都不足以委员会将其加入java语言之中。那么,我们可以更好的利用和了解注解吗?当然可以啦:
runtime retention policy
的注解可以通过反射获得,Class
类中的getAnnotation()
和getAnnotations()
方法可以做到这些。当注解在Java 5 首次被引入时,注解处理器API还不是很成熟和规范化。处理注解需要一个单独的工具,叫做apt
,注解处理工具;还需要Mirror
API(com.sun.mirror),用于编写自定义处理器。
从java 6开始,注解处理通过JSR 269(2)
被标准化,被集成进标准库并且apt
无缝的集成到java编译器javac中。
因为我们只详细讲述Java 6 中的注解处理器相关API,你可以在这里和这里找到关于java 5中注解的更多信息,并在这里找到一些例子。
自定义注解处理器只是实现了javax.annotation.processing.Processor
接口并准从指定的协议。为了我们的便利,自定义处理器一些常用的功能都由javax.annotation.processing.AbstractProcessor
这个类给出了抽象实现。
自定义注解处理器可以使用到一下三个注解来配置自己:
List<? extends String
,想要深入了解,可以看一下这里)也可以。process()
方法的实现。让我们开始第一个注解处理器的实现。按照之前章节的知识,我们实现了下面这个类来处理第一篇博文中的Complexity
注解:
package sdc.assets.annotations.processors;
import …
@SupportedAnnotationTypes("sdc.assets.annotations.Complexity")
@SupportedSourceVersion(SourceVersion.RELEASE_6)
public class ComplexityProcessor extends AbstractProcessor {
public ComplexityProcessor() {
super();
}
@Override
public boolean process(Set<? extends TypeElement> annotations,
RoundEnvironment roundEnv) {
return true;
}
}
这个未完全完成的类,尽管没有任何操作,但是注册可以支持处理sdc.assets.annotations.Complexity
注解类型。因此,每次java编译器遇到一个被Complexity
标记的类都有执行这个处理器,假设这个处理器在那个路径中可以被获得(具体原由之后会看到)。
process()
方法会受到两个输入参数:
ProcessingEnvironment
对象也可以通过processingEnv
实例获得。这个对象可以提供一些关于日志,文件读写的通用工具类;它的一些功能之后会讨论到。RoundEnvironment
对象和Element
接口的反射相关的函数,我们可以实现一个打印Complexity
标注元素名的注解处理器。for (Element elem :roundEnv.getElementsAnnotatedWith(Complexity.class)) {
Complexity complexity = elem.getAnnotation(Complexity.class);
String message = "annotation found in " + elem.getSimpleName() + " with complexity " + complexity.value(); processingEnv.getMessager().printMessage(Diagnostic.Kind.NOTE, message);
return true; // no further processing of this annotation type
}
自定义注解处理器的最后一步就是打包并且向java编译器获取其他可以识别处理器的工具进行注册。
注册处理器的最简单方法就是使用标注java服务机制:
java编译器或者其他工具会搜索这个文件中标记的所有处理器,并且在注解处理过程中使用。
在我们这个例子中,目录结构和文件内容如下:
想象一下你在一个项目中使用了一些自定义注解并且可以使用注解处理器。在java 5中,编译和注解处理是不同的两步,但是在java 6中,两个任务都集成到java编译器工具javac中。
如果你把注解处理器加入到javac的路径中并且他们使用服务机制进行了注册,他们就会被javac执行调用啦。
在我们这个例子中,下边这个命令会编译并且执行注解处理:
>javac -cp sdc.assets.annotations-1.0-SNAPSHOT.jar;
sdc.assets.annotations.processors-1.0-SNAPSHOT.jar
SimpleAnnotationsTest.java
用于处理的java类文件内容如下:
package sdc.startupassets.annotations.base.client;
import ...
@Complexity(ComplexityLevel.VERY_SIMPLE)
public class SimpleAnnotationsTest {
public SimpleAnnotationsTest()
{
super();
}
@Complexity() // this annotation type applies also to methods // the default value 'ComplexityLevel.MEDIUM' is assumed
public void theMethod()
{
System.out.println("consoleut");
}
}
上述执行结果如下:
有一些javac的选项可以在一些特殊的情况下使用:
SupportedOptions
注解注册的选项。proc:none
选项,将不执行注解处理;使用proc:only
选项将只执行注解处理过程-当你在注解处理器中运行验证或者质量检查工具或者代码审查工具时。版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。
集结各类场景实战经验,助你开发运维畅行无忧