【JavaSE】注解简介

简单介绍

一个最简单的注解定义如下：

public @interface Test {
}

跟接口的定义很类似，只是多了一个@符号。我们可以只定义一个空注解（标记注解），但是也可以给注解指定元素：

public @interface UseCase {
	public int id();
	public String desc();
}

定义注解元素就像在接口中声明方法，但是注解元素可以指定默认值：

public @interface UseCase {
	public int id() default -1;
	public String desc() default "This is a desc!";
}

使用注解：

@Test
public class Service {
	@Test
	public void add() {
	}

	@UseCase(id = 1, desc = "new desc!")
	public void get() {
	}

	@UseCase(id = 2)
	public void delete() {
	}
}

需要注意的是，如果在定义注解的时候没有指定元素的默认值，则在使用的时候必须指定一个值。

元注解

Java提供了四种注解，专门负责注解其他注解。

     @Target 表示该注解用于什么地方，可能的值在枚举类 ElemenetType 中，包括： 
          ElemenetType.CONSTRUCTOR----------------------------构造器声明 
          ElemenetType.FIELD --------------------------------------域声明（包括 enum 实例） 
          ElemenetType.LOCAL_VARIABLE------------------------- 局部变量声明 
          ElemenetType.METHOD ----------------------------------方法声明 
          ElemenetType.PACKAGE --------------------------------- 包声明 
          ElemenetType.PARAMETER ------------------------------参数声明 
          ElemenetType.TYPE--------------------------------------- 类，接口（包括注解类型）或enum声明 
           
     @Retention 表示在什么级别保存该注解信息。可选的参数值在枚举类型 RetentionPolicy 中，包括： 
          RetentionPolicy.SOURCE ---------------------------------注解将被编译器丢弃 
          RetentionPolicy.CLASS -----------------------------------注解在class文件中可用，但会被VM丢弃 
          RetentionPolicy.RUNTIME ------- VM将在运行期也保留注释，因此可以通过反射机制读取注解的信息。 
           
      @Documented 将此注解包含在 javadoc 中 ，它代表着此注解会被javadoc工具提取成文档。在doc文档中的内容会因为此注解的信息内容不同而不同。相当与@see,@param 等。
       
      @Inherited 允许子类继承父类中的注解。

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {
}

我们在使用元注解给注解元素赋值的时候，并没有指定元素名称，因为上面两个元注解都只有一个注解元素，所以可以省略元素名称。

使用了元注解后，@Test只能用于类。如果既想在类上使用，又想在方法上使用，可以做如下修改：

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {
}

如果将@Retention设为RetentionPolicy.RUNTIME，就可以在运行期通过反射读取注解。

大多数时候，程序员主要定义自己的注解，并编写自己的处理器来处理它们。

注解元素的类型

注解元素可用的类型如下：

• 所有的基本类型
• String
• Class
• enum
• Annotation
• 以上类型的数组

如果使用了其他类型，编译器会报错。另外基本类型的包装类型也不能用来定义注解元素。