JAVA 注解

概念

Annotation（注解）是 Java 提供的一种对元程序中元素关联信息和元数据（metadata）的途径和方

法。Annatation(注解)是一个接口，程序可以通过反射来获取指定程序中元素的 Annotation 对象，然后

通过该 Annotation 对象来获取注解中的元数据信息。

 

4 种标准元注解

元注解的作用是负责注解其他注解。 Java5.0 定义了 4 个标准的 meta-annotation 类型，它们被用来提

供对其它 annotation 类型作说明。

@Target 修饰的对象范围

@Target说明了Annotation所修饰的对象范围： Annotation可被用于 packages、types（类、接口、枚

举、Annotation 类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如

循环变量、catch 参数）。在 Annotation 类型的声明中使用了 target 可更加明晰其修饰的目标

@Retention 定义 被保留的时间长短

Retention 定义了该 Annotation 被保留的时间长短：表示需要在什么级别保存注解信息，用于描述注解

的生命周期（即：被描述的注解在什么范围内有效），取值（RetentionPoicy）由：

n SOURCE:在源文件中有效（即源文件保留）

n CLASS:在 class 文件中有效（即 class 保留）

n RUNTIME:在运行时有效（即运行时保留）

@Documented 描述-javadoc

@ Documented 用于描述其它类型的 annotation 应该被作为被标注的程序成员的公共 API，因此可以

被例如 javadoc 此类的工具文档化。

@Inherited 阐述了某个被标注的类型是被继承的

@Inherited 元注解是一个标记注解，@Inherited 阐述了某个被标注的类型是被继承的。如果一个使用

了@Inherited 修饰的 annotation 类型被用于一个 class，则这个 annotation 将被用于该 class 的子

类。

 

注解处理器

如果没有用来读取注解的方法和工作，那么注解也就不会比注释更有用处了。使用注解的过程中，很重

要的一部分就是创建于使用注解处理器。Java SE5扩展了反射机制的API，以帮助程序员快速的构造自定

义注解处理器。下面实现一个注解处理器。

 

 Demo：

1.定义一个自定义注解

 1 /**
 2  * 定义注解
 3  */
 4 @Target(ElementType.FIELD)
 5 @Retention(RetentionPolicy.RUNTIME)
 6 @Documented
 7 public @interface FruitProvider {
 8 
 9     /**
10      * 供应商编号
11      * @return
12      */
13     public int id() default -1;
14 
15     /**
16      * 供应商名称
17      * @return
18      */
19     public String name() default "";
20 
21     /**
22      * 供应商地址
23      * @return
24      */
25     public String address() default "";
26 
27 }

2.定义一个实体类，定义一个属性，编写set/get方法，在属性上用上一步自定义的注解

 1 /**
 2  * 注解使用
 3  */
 4 public class Apple2 {
 5 
 6     @FruitProvider(id = 1, name = "陕西红富士集团", address = "陕西省西安市延安路")
 7     private String appleProvider;
 8 
 9     public void setAppleProvider(String appleProvider) {
10         this.appleProvider = appleProvider;
11     }
12 
13     public String getAppleProvider() {
14         return appleProvider;
15     }
16 
17 }

3.编写注解处理器类，判断一个类的属性上是否有特定注解，如有则打印注解的属性值，用main方法测试注解

 1 /**
 2  * 注解处理器
 3  */
 4 public class FruitInfoUtil {
 5 
 6     public static void getFruitInfo(Class<?> clazz) {
 7         String strFruitProvicer = "供应商信息：\n";
 8         Field[] fields = clazz.getDeclaredFields();//通过反射获取处理注解
 9         for (Field field : fields) {
10             if (field.isAnnotationPresent(FruitProvider.class)) {
11                 FruitProvider fruitProvider = (FruitProvider) field.getAnnotation(FruitProvider.class);
12                 //注解信息的处理地方
13                 strFruitProvicer += "供应商编号：" + fruitProvider.id() + "\n供应商名称：" + fruitProvider.name() + "\n供应商地址："+ fruitProvider.address();
14                 System.out.println(strFruitProvicer);
15             }
16         }
17     }
18 
19 }
20 
21 class FruitRun{
22     public static void main(String[] args){
23         FruitInfoUtil.getFruitInfo(Apple2.class);
24         /****************输出结果***************/
25         // 供应商编号：1 供应商名称：陕西红富士集团 供应商地址：陕西省西安市延安路
26     }
27 }