[转] Java @interface 自定义注解

[From] http://blog.csdn.net/afterlife_qiye/article/details/53748973

1. 注解的好处

注解可以替代配置文件完成对某些功能的描述，减少程序配置；

在没有配置文件的情况下，我们去观察代码，并不需要同时打开两个文件来观察这个字段到底对应数据库的哪个列，减少了程序繁琐性，使得代码更加清晰易懂；

目前市面上流行的框架基本上都包含了注解配置，那么针对于开源项目，我们在阅读项目代码时，不懂注解如何实现，真的是举步难坚，所以，学习注解也可以加强我们对开源项目源码的解读。

 

2. Java自带注解

 

注解是Java1.5，JDK5.0引用的技术，与类，接口，枚举处于同一层次 。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释 。

在Java中，自带了三种注解，这三种注解存在于java.lang包中，首先我们讲一讲这些注解

 Override

它的作用是对覆盖超类中方法的方法进行标记，如果被标记的类并没有实际覆盖超类，则编译器会发出错误警告。 

很常见的一个注解，了解JavaOOP的小伙伴这个注解应该较为常用，告诉编译器，我这个方法是重写了父类方法，当然如果你的方法并没有实际重写父类方法时，那么编译器就会显示警告信息

 Deprecated

它的作用是对不应该再使用的方法添加注解，当编程人员使用这些方法时，将会在编译时显示提示信息 

当一个方法名或者类名上面此注解之后，编译器会认为这个方法属于过期方法，明显的区别在于类名或者方法名上会画一道删除线，标识过期方法不影响方法的继续使用

 SuppressWarnings

这个仅仅是告诉编译器忽略特定的警告信息，例如在泛型中使用原生数据类型 

例如我们在使用一些以Deprecated注解的方法时，编译器会提出黄线警告，那么只要在使用的地方加上@SuppressWarnings(“deprecation”)就可以使编译器忽略这个警告 

此注释常用的参数值有 :

  deprecation(忽略使用过时类或者方法)，

  unchecked(忽略执行了未检查装换时警告) ，

  fallthrough(忽略switch直接指向到下一个case块没有break警告)，

  path(忽略类路径，源文件路径中有不存在路径时警告)，

  serial(忽略可序列化类中没有serialVersionUID时的警告)，

  finally(任何finally不能正常执行时的警告)，

  all(以上所有)

 

 

3. 自定义注解须知

首先，自定义注解我们必须了解四个元注解，什么是元注解？元注解指作用于注解之上的元数据或者元信息，简单通俗的讲，元注解就是注解的注解 .

Documented与Inherited是典型的标识性注解，也就是说在注解内部并没有成员变量，没有成员变量的注解称为标识注解 

 Documented

指明拥有这个注解的元素可以被javadoc此类的工具文档化。这种类型应该用于注解那些影响客户使用带注释的元素声明的类型。如果一种声明使用Documented进行注解，这种类型的注解被作为被标注的程序成员的公共API 。

 Inherited

指明该注解类型被自动继承。如果用户在当前类中查询这个元注解类型并且当前类的声明中不包含这个元注解类型，那么也将自动查询当前类的父类是否存在Inherited元注解，这个动作将被重复执行知道这个标注类型被找到，或者是查询到顶层的父类。

 Retention

指明在什么级别显示此注解

 

Retention主要的参数类型包括以下几种：

RetentionPolicy.SOURCE 注解存在于源代码中，编译时会被抛弃

RetentionPolicy.CLASS 注解会被编译到class文件中，但是JVM会忽略

RetentionPolicy.RUNTIME JVM会读取注解，同时会保存到class文件中

 Target

指明该类型的注解可以注解的程序元素的范围

 

Target主要的参数类型包括以下几种：

ElementType.TYPE 用于类，接口，枚举但不能是注解

ElementType.FIELD 作用于字段，包含枚举值

ElementType.METHOD 作用于方法，不包含构造方法

ElementType.PARAMETER 作用于方法的参数

ElementType.CONSTRUCTOR 作用于构造方法

ElementType.LOCAL_VERIABLE 作用于本地变量或者catch语句

ElementType.ANNOTATION_TYPE 作用于注解

ElementType.PACKAGE 作用于包

 

4. 实例应用

 注解的定义

@Documented  
@Retention(RetentionPolicy.RUNTIME)  
@Target(ElementType.TYPE)   //类上的注解  
public @interface ClassAnnotation {  
  
    String value() default "I am Class Annotation";  
  
}

@Documented  
@Retention(RetentionPolicy.RUNTIME)  
@Target(ElementType.FIELD)  //属性上的注解  
public @interface FieldAnnotation {  
  
    String value() default "I am Field Annotation";  
  
    String operate() default "operate";  
  
}

@Documented  
@Retention(RetentionPolicy.RUNTIME)  
@Target(ElementType.METHOD) //方法上的注解  
public @interface MethodAnnotation {  
  
    String value() default "I am Method Annotation";  
  
    String name() default "laobo";  
  
}

@interface 用于定义注解接口，接口中只能定义成员变量，且定义的成员变量必须以()结尾，可以使用default关键字为成员变量指定默认值，如果不为成员变量指定默认值的情况，则必须在引用注解时，对没有默认值的成员变量进行赋值操作

注解的使用规则

 

//@注解名(变量1=变量1值,变量2=变量2值,...)

//如果注解中拥有数组类型,假设是String类型,那么赋值方式可以如下

//@注解名(String数组名称={"tset1","test2","test3"})

//如果我们的注解中只有一个成员变量,且成员变量的名称为value()

//那么可以使用如下赋值方式

//@注解名(属性值)

//如果我们的注解中没有成员变量,那么此时的注解被称为标识注解  

 注解的使用

@ClassAnnotation  //类上注解  
public class TestAnnotation {  
    //属性注解  
    @FieldAnnotation(value = "老伯", operate = "啥都不干！")  
    public String operate;  
    //方法注解  
    @MethodAnnotation(value = "好人", name = "老伯")  
    public void testMethod(){  
        System.out.println("这个测试方法！");  
    }  
  
}

 解析注解

主要使用Java的反射原理实现对注解的解析

public class Test {  
  
    public static void main(String[] args) throws ClassNotFoundException {  
  
        Class clazz = Class.forName("com.java._interface.blog.TestAnnotation");  
        Method[] methods = clazz.getMethods();  
  
        boolean flag = clazz.isAnnotationPresent(ClassAnnotation.class);  
        if(flag){  
            ClassAnnotation classAnnotation = (ClassAnnotation) clazz.getAnnotation(ClassAnnotation.class);  
            System.out.println(classAnnotation.value());  
        }  
  
        boolean methodFlag = methods[0].isAnnotationPresent(MethodAnnotation.class);  
        if(methodFlag){  
            MethodAnnotation methodAnnotation = (MethodAnnotation) methods[0].getAnnotation(MethodAnnotation.class);  
            System.out.println(methodAnnotation.name() + methodAnnotation.value());  
        }  
  
        Field[] fields = clazz.getDeclaredFields();  
        boolean fieldFlag = fields[0].isAnnotationPresent(FieldAnnotation.class);  
        if(fieldFlag){  
            FieldAnnotation fieldAnnotation = fields[0].getAnnotation(FieldAnnotation.class);  
            System.out.println(fieldAnnotation.value());  
        }  
  
    }  
  
}