java注解

1.1 基本介绍

定义：注解（Annotation），也叫元数据。一种代码级别的说明。它是JDK1.5及以后版本引入的一个特性，与类、接口、枚举是在同一个层次。它可以声明在包、类、字段、方法、局部变量、方法参数等的前面，用来对这些元素进行说明，注释。

作用分类：

①编写文档：通过代码里标识的元数据生成文档【生成文档doc文档】

②代码分析：通过代码里标识的元数据对代码进行分析【使用反射】

③编译检查：通过代码里标识的元数据让编译器能够实现基本的编译检查【Override】

1.2元注解

元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解： 　　　　1.@Target, 　　　　2.@Retention, 　　　　3.@Documented, 　　　　4.@Inherited 　　这些类型和它们所支持的类在java.lang.annotation包中可以找到。下面我们看一下每个元注解的作用和相应分参数的使用说明。

1.2.1 @Target

@Target说明了Annotation所修饰的对象范围：Annotation可被用于 packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。

　　*作用：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）*

　　*取值(ElementType)有：*

　　　　1.CONSTRUCTOR:用于描述构造器 　　　　2.FIELD:用于描述域 　　　　3.LOCAL_VARIABLE:用于描述局部变量 　　　　4.METHOD:用于描述方法 　　　　5.PACKAGE:用于描述包 　　　　6.PARAMETER:用于描述参数 　　　　7.TYPE:用于描述类、接口(包括注解类型) 或enum声明

示例：

@Target(ElementType.TYPE)
@Retention(value=RetentionPolicy.RUNTIME)
public @interface Table {
   public String tableName()   default  "classname" ;
   public int id() default 1;
}
​

注意：我们这里自定义了一个注解 @Table ，里面定义了两个属性tableName,和id属性,我们定义属性的时候其实给的就是一个抽象方法，方法的名字就是属性值，default 后面给出默认值。

1.属性的返回值类型有下列取值

基本数据类型

String

枚举

注解

以上类型的数组

2.定义了属性，在使用时需要给属性赋值

1. 如果定义属性时，使用default关键字给属性默认初始化值，则使用注解时，可以不进行属性的赋值。

2. 如果只有一个属性需要赋值，并且属性的名称是value，则value可以省略，直接定义值即可。

3. 数组赋值时，值使用{}包裹。如果数组中只有一个值，则{}可以省略。

示例：定义如下的注解.

public @interface TestAnnotation {
    public String[] arrayVal();
}

使用时:

@TestAnnotation(arrayVal ="1")
public class MyTest {
​
}

也可以这样：

@TestAnnotation(arrayVal ={"1"})
public class MyTest {
​
}

 

如果定义的注解中只有一个属性需要赋值时，并且属性的名字为value时。我们也可以像如下方式使用。

@TestAnnotation({"1"})
public class MyTest {
​
}

 

1.2.2 @Retention

*@Retention*定义了该Annotation被保留的时间长短：某些Annotation仅出现在源代码中，而被编译器丢弃；而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。

　　*作用：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有效）*

　　*取值（RetentionPo**l**icy）有：*

　　　　1.SOURCE:在源文件中有效（即源文件保留） 　　　　2.CLASS:在class文件中有效（即class保留） 　　　　3.RUNTIME:在运行时有效（即运行时保留）

　　Retention meta-annotation类型有唯一的value作为成员，它的取值来自 java.lang.annotation.RetentionPolicy的枚举类型值

 

示例：

@Target(ElementType.TYPE)
@Retention(value=RetentionPolicy.RUNTIME)
public @interface Table {
   public abstract String tableName()   default  "classname" ;
   public int id() default 1;
}

 

1.2.3 @Documented

@Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员。

 

1.2.4 @Inherited

　　@Inherited 元注解是一个标记注解，@Inherited阐述了某个被标注的类型是被继承的。如果一个使用了@Inherited修饰的annotation类型被用于一个class，则这个annotation将被用于该class的子类。

　　注意：@Inherited annotation类型是被标注过的class的子类所继承。类并不从它所实现的接口继承annotation，方法并不从它所重载的方法继承annotation。

 

2.注解的读取

注解定义如下:

@Target(ElementType.TYPE)
@Retention(value=RetentionPolicy.RUNTIME)
public @interface Table {
   public abstract String tableName()   default  "classname" ;
   public int id() default 1;
}

使用注解：

@Table(tableName="user",id=2)
public class TestAnnotion {
​
}

读取注解中的属性值,示例代码如下:

public class Test {
  public static void main(String[] args) throws Exception{
      //获取 加了注解的类的字节码
      Class clazz= TestAnnotion.class;
      //获取字节码上的所有注解
      Annotation[] annotation = clazz.getAnnotations();
      
      for(Annotation a : annotation){
          //  a.annotationType() 讲会返回一个字节码（注解的字节码）,然后我们可以通过字节码来获取类名方法对象等。
          String annotationName = a.annotationType().getName(); //获取注解的名字
          System.out.println("注解的名字:"+annotationName);
          //获取注解中所有的方法对象
          Method[] methods = a.annotationType().getMethods();
          for(Method m :methods){
               String name =m.getName();
              //如果方法名为 tableName或者 id 方法我们就反射调用.
               if("tableName".equals(name) ||"id".equals(name)){
                   Object value = m.invoke(a,null);
                   System.out.println(name+":"+value);
               }
          }
      }
}
}