java注解annotation

注解

Java注解用于为 Java代码提供元数据。作为元数据，注解不直接影响你的代码执行，但也有一些类型的注解实际上可以用于这一目的。Java注解是从 Java5开始添加到 Java的。

注解语法

注解通过 @interface关键字进行定义。

public @interface TestAnnotation {

}

它的形式跟接口很类似，不过前面多了一个 @符号。上面的代码就创建了一个名字为 TestAnnotaion的注解。

元注解

元注解是可以注解到注解上的注解，或者说元注解是一种基本注解，但是它能够应用到其它的注解上面。

元注解有 @Retention、@Documented、@Target、@Inherited、@Repeatable5种。

@Retention

Retention的英文意为保留期的意思。当 @Retention应用到一个注解上的时候，它解释说明了这个注解的的存活时间。

它的取值如下：

- RetentionPolicy.SOURCE注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。

- RetentionPolicy.CLASS注解只被保留到编译进行的时候，它并不会被加载到 JVM中。

- RetentionPolicy.RUNTIME注解可以保留到程序运行的时候，它会被加载进入到 JVM中，所以在程序运行时可以获取到它们。

@Retention(RetentionPolicy.RUNTIME)

public @interface TestAnnotation {

}

上面的代码中，我们指定 TestAnnotation可以在程序运行周期被获取到，因此它的生命周期非常的长。

@Documented

顾名思义，这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到Javadoc中去。

@Target

Target是目标的意思，@Target指定了注解运用的地方。

你可以这样理解，当一个注解被 @Target注解时，这个注解就被限定了运用的场景。

类比到标签，原本标签是你想张贴到哪个地方就到哪个地方，但是因为 @Target的存在，它张贴的地方就非常具体了，比如只能张贴到方法上、类上、方法参数上等等。@Target有下面的取值

-ElementType.ANNOTATION_TYPE可以给一个注解进行注解

-ElementType.CONSTRUCTOR可以给构造方法进行注解

-ElementType.FIELD可以给属性进行注解

-ElementType.LOCAL_VARIABLE可以给局部变量进行注解

-ElementType.METHOD可以给方法进行注解

-ElementType.PACKAGE可以给一个包进行注解

-ElementType.PARAMETER可以给一个方法内的参数进行注解

-ElementType.TYPE可以给一个类型进行注解，比如类、接口、枚举

@Inherited

Inherited是继承的意思，但是它并不是说注解本身可以继承，而是说如果一个超类被 @Inherited注解过的注解进行注解的话，那么如果它的子类没有被任何注解应用的话，那么这个子类就继承了超类的注解。

说的比较抽象。代码来解释。

@Inherited

@Retention(RetentionPolicy.RUNTIME)

@interface Test {}

 

@Test

public class A {}

 

public class B extends A {}

注解 Test被@Inherited修饰，之后类 A被 Test注解，类 B继承 A,类 B 也拥有 Test这个注解。

@Repeatable

Repeatable自然是可重复的意思。@Repeatable是 java 1.8才加进来的，所以算是一个新的特性。

什么样的注解会多次应用呢？通常是注解的值可以同时取多个。

举个例子，一个人他既是程序员又是产品经理,同时他还是个画家。

@interface Persons {

   Person[] value();

}

 

@Repeatable(Persons.class)

@interface Person{

   String role default "";

}

 

@Person(role="artist")

@Person(role="coder")

@Person(role="PM")

public class SuperMan{

 

}

注意上面的代码，@Repeatable注解了 Person。而 @Repeatable 后面括号中的类相当于一个容器注解。

什么是容器注解呢？就是用来存放其它注解的地方。它本身也是一个注解。

我们再看看代码中的相关容器注解。

@interface Persons {

   Person[] value();

}

按照规定，它里面必须要有一个 value的属性，属性类型是一个被 @Repeatable注解过的注解数组，注意它是数组。

如果不好理解的话，可以这样理解。Persons是一张总的标签，上面贴满了 Person这种同类型但内容不一样的标签。把 Persons给一个 SuperMan贴上，相当于同时给他贴了程序员、产品经理、画家的标签。

我们可能对于 @Person(role=”PM”)括号里面的内容感兴趣，它其实就是给 Person这个注解的 role属性赋值为 PM，大家不明白正常，马上就讲到注解的属性这一块。

注解的属性

注解的属性也叫做成员变量。注解只有成员变量，没有方法。注解的成员变量在注解的定义中以“无形参的方法”形式来声明，其方法名定义了该成员变量的名字，其返回值定义了该成员变量的类型。

@Target(ElementType.TYPE)

@Retention(RetentionPolicy.RUNTIME)

public @interface TestAnnotation {

   int id();

   String msg();

}

上面代码定义了 TestAnnotation这个注解中拥有 id和 msg两个属性。在使用的时候，我们应该给它们进行赋值。

赋值的方式是在注解的括号内以 value=””形式，多个属性之前用 ，隔开。

@TestAnnotation(id=3,msg="helloannotation")

public class Test {

 

}

需要注意的是，在注解中定义属性时它的类型必须是 8种基本数据类型外加 类、接口、注解及它们的数组。

注解中属性可以有默认值，默认值需要用 default关键值指定。比如：

@Target(ElementType.TYPE)

@Retention(RetentionPolicy.RUNTIME)

public @interface TestAnnotation {

   public int id() default -1;

   public String msg() default "Hi";

}

TestAnnotation中 id属性默认值为 -1，msg属性默认值为 Hi。

它可以这样应用。

@TestAnnotation()

public class Test {}