#翻译#使用注解处理器生成代码-1 注解类型

简介:  原文地址如下:摸我 我希望以此篇博文作为基于注解处理器生成代码系列博文的开篇,给大家展示注解处理器有多么强大,并在最后使用这项技术来在编译时刻生成android代码 在这个系列博文中,我们会:介绍Java语言中的注解理解注解的基本用法和作用...

 原文地址如下:摸我
 我希望以此篇博文作为基于注解处理器生成代码系列博文的开篇,给大家展示注解处理器有多么强大,并在最后使用这项技术来在编译时刻生成android代码
 在这个系列博文中,我们会:

  • 介绍Java语言中的注解
  • 理解注解的基本用法和作用域
  • 了解Annotation Processor基础知识和作用
  • 学习如何在命令行,Eclipse,Maven中运行Annotation Processors
  • 学习如何使用Annotation Processors来生成代码
  • 学习如何Apache Velocity模版来生成代码

简介

 注解首先在第三版Java Language Specification中被提出,并在java 5中被实现。
 使用注解我们可以给源代码添加元数据信息,比如构造或者部署信息,配置属性,编译特性或者代码质量检查。
 不像Javadocs,注解是强类型的,每个注解都对应一个预先定义好的注解类型。除此之外,程序可以在运行时获得注解信息,Javadocs不行。

注解语法

 注解通常出现在被注解代码片段之前,单独成行,并且和代码片段有相同的缩进。
 注解可以应用到包,类型(类,接口,枚举,注解类型),变量(对象,局部变量-包括定义在循环结构中的变量),构造函数,方法,和参数。
 注解的最简单形式是不带任何元素,比如:

@Override()
    public void theMethod() {…}

 在这种情况下,括号可以被省略。

@Override
    public void theMethod() {…}

 注解可以包括通过冒号分离的键值对数据,类型可以是基础类型,字符串,枚举,和数组:

@Author(name = "Albert",
            created = "17/09/2010",
            revision = 3,
            reviewers = {"George", "Fred"})
    public class SimpleAnnotationsTest {…}

 当注解只有一个元素并且其名字是value,那么它就可以被省略:

@WorkProduct("WP00000182")
    @Complexity(ComplexityLevel.VERY_SIMPLE)
    public class SimpleAnnotationsTest {…}

 注解可以定义它的元素的默认值,有默认值的元素可以在注解声明使用时被省略。
 比如,假设注解Author定义了revision(默认为1)和reviewers(默认为空的字符串数组),下边的两个注释声明是相同的:

@Author(name = "Albert",
            created = "17/09/2010",
            revision = 1,
            reviewers = {})
    public class SimpleAnnotationsTest() {…}
    @Author(name = "Albert",        // defaults are revision 1
            created = "17/09/2010") // and no reviewers
    public class SimpleAnnotationsTest() {…}

注解的典型使用

 有三类注解类型在Java Language Specification中被定义,它们提供给java的编译器使用:

  • @Deprecated:表明被标记的元素不应该再被使用。当你使用被标记元素时,编译器会给出警告。也可以使用在Javadoc中,解释标记元素不能在使用的原因。
  • @Override:表面被标记元素为重载了超类中的元素
  • @SuppressWarnings:让编译器忽略标记元素会产生的一些特定警告

 自从注解被引入,很多库和框架都在其最新版本中添加了注解。通过在代码中使用注解,这些库或者框架可以减少或者去除配置文件的使用。
 最有代表性的几个库或框架如下:

  • Java Enterprise Edition and its main components – Enterprise JavaBeans, Java Persistence API or Web Services API’s.
  • Spring Framework – used thoroughly for configuration, dependency injection and inversion of control in the core framework and in other Spring projects.
  • Seam, Weld, Guice.
  • Apache Struts 2.

注解类型

 注解类型(Annotation Type)是定义自定义注解的特殊接口(interface)。
 一个注解类型使用@interface来定义:

public @interface Author {
        String name();
        String created();
        int revision() default 1;
        String[] reviewers() default {};
    }
    public @interface Complexity {
        ComplexityLevel value() default ComplexityLevel.MEDIUM;
    }
    public enum ComplexityLevel {
        VERY_SIMPLE, SIMPLE, MEDIUM, COMPLEX, VERY_COMPLEX;
    }

 注解类型和常规的接口有一些不同的地方:

  • 只有基础类型,字符串,枚举,类常量和上述类型的数组允许在注解定义中使用,一般的类和对象不允许使用,双重数组也不允许。
  • 注解元素的定义语法和类方法的语法相似,但是注意,注解元素的定义不包括修饰符和参数。
  • 默认值是使用default关键字定义的,其后的值必须是字面量,数组初始器和枚举值。

 枚举类型可以在注解内部进行定义:

public @interface Complexity {
        public enum Level {
            VERY_SIMPLE, SIMPLE, MEDIUM, COMPLEX, VERY_COMPLEX;
        }
    …

用来定义注解的注解

 JDK中预先定义了一些用来修改自定义注解行为的注解:

  • @Retention:表明被标记的注解信息会保存多长时间,一些可能的值如下:CLASS (默认选项,注解信息保存到class文件中,但是无法在运行时获得), SOURCE (当class文件被创建时被编译器抛弃) and RUNTIME (在程序运行时可以获得).
  • @Target:表明注解可以标记元素的类型,可能的值为枚举类型ElementType的值:ANNOTATION_TYPE, CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER and TYPE.
     下一篇博文为《注解处理器》,稍后会给出。


(1) ”The Java Language Specification, Third Edition” is available for free download here.
 Update: new link to relevant JLS section in his new home at Oracle site here.

相关文章
|
Java 微服务 Spring
@EnableDiscoveryClient注解的作用
@EnableDiscoveryClient注解的作用 @EnableDiscoveryClient 及@EnableEurekaClient 类似,都是将一个微服务注册到Eureka Server(或其他 服务发现组件,例如Zookeeper、Consul等)
1565 0
|
4月前
|
Java 编译器
Java编译器注解运行和自动生成代码问题之指定一个注解处理器处理所有类型的注解的问题如何解决
Java编译器注解运行和自动生成代码问题之指定一个注解处理器处理所有类型的注解的问题如何解决
|
4月前
|
Java Spring
@GrpcServise 注解的作用和使用
@GrpcServise 注解的作用和使用
50 0
|
6月前
|
Java 程序员 编译器
Java注解概述及解析注解
Java注解概述及解析注解
72 1
|
安全 Java 编译器
Java注解(一) 注解的属性,格式,说明
Java注解(一) 注解的属性,格式,说明
116 0
|
Java 编译器 API
Java注释和注解的区别
Java注释和注解的区别
159 0
|
Java
java注解(作用于注解)
java注解(作用于注解)
119 0
AOP + 注解 实现通用的接口参数校验
写移动端接口的时候,为了校验参数,传统的做法是加各种判断,写了很多重复的代码,而且也不美观。为了增加代码复用性,美观的校验参数,采用AOP + 注解的方式来实现接口的参数校验(使用拦截器也可以实现),在需要校验参数的方法上加上自定义的注解即可。
305 0
AOP + 注解 实现通用的接口参数校验
|
XML Java 程序员
标记接口,注解和注解处理器的前世今生
标记接口,注解和注解处理器的前世今生
标记接口,注解和注解处理器的前世今生
|
Java Spring
自定义注解实现方式解析
自定义注解实现方式解析
238 0
自定义注解实现方式解析