初步认识注解，用反射来读取自定义注解

来源：互联网发布：c语言函数头编辑：程序博客网时间：2024/05/24 04:38

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

　　　　1.@Target,
　　　　2.@Retention,
　　　　3.@Documented,
　　　　4.@Inherited

-----------------------------------------------------------------------------------------------------------

@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声明

-----------------------------------------------------------------------------------------------------------

@Retention：

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

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

　　取值（RetentionPoicy）有：

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

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

-----------------------------------------------------------------------------------------------------------

@Documented:

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

-----------------------------------------------------------------------------------------------------------

@Inherited：

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

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

　　当@Inherited annotation类型标注的annotation的Retention是RetentionPolicy.RUNTIME，则反射API增强了这种继承性。如果我们使用java.lang.reflect去查询一个@Inherited annotation类型的annotation时，反射代码检查将展开工作：检查class和其父类，直到发现指定的annotation类型被发现，或者到达类继承结构的顶层。

-----------------------------------------------------------------------------------------------------------

自定义注解：

　　使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。

　　定义注解格式：
　　public @interface 注解名 {定义体}

　　注解参数的可支持数据类型：

　　　　1.所有基本数据类型（int,float,boolean,byte,double,char,long,short)
　　　　2.String类型
　　　　3.Class类型
　　　　4.enum类型
　　　　5.Annotation类型
　　　　6.以上所有类型的数组

　　Annotation类型里面的参数该怎么设定:
　　第一,只能用public或默认(default)这两个访问权修饰.例如,String value();这里把方法设为defaul默认类型；　　
　　第二,参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String;　　
　　第三,如果只有一个参数成员,最好把参数名称设为"value",后加小括号.例:下面的例子FruitName注解就只有一个参数成员。

-----------------------------------------------------------------------------------------------------------

package Demo;    import java.lang.annotation.ElementType;  import java.lang.annotation.Retention;  import java.lang.annotation.RetentionPolicy;  import java.lang.annotation.Target;    @Target(value = {ElementType.TYPE})  @Retention(RetentionPolicy.RUNTIME)  public @interface SxtTable {      String value();  }  [java] view plain copySxtField.java  [java] view plain copypackage Demo;    import java.lang.annotation.ElementType;  import java.lang.annotation.Retention;  import java.lang.annotation.RetentionPolicy;  import java.lang.annotation.Target;    @Target(value = {ElementType.FIELD})  @Retention(RetentionPolicy.RUNTIME)  public @interface SxtField {      String name() default "";      String type() default "";      int length() default 1;  }  AnnotaionTest.java[java] view plain copypackage Demo;    @SxtTable(value = "student001")  public class AnnotationTest {      @SxtField(name = "id",type = "int",length = 10)      private int id;            @SxtField(name = "studentName",type = "Varchar",length = 10)      private String studentName;            @SxtField(name = "age",type = "int",length = 3)      private int age;                  public int getId() {          return id;      }            @SxtMethod(Mname="setId")      public void setId(int id) {          this.id = id;      }      public String getStudentName() {          return studentName;      }      public void setStudentName(String studentName) {          this.studentName = studentName;      }      public int getAge() {          return age;      }      public void setAge(int age) {          this.age = age;      }        }  [java] view plain copySxtMethod.java  [java] view plain copypackage Demo;    import java.lang.annotation.ElementType;  import java.lang.annotation.Retention;  import java.lang.annotation.RetentionPolicy;  import java.lang.annotation.Target;    @Target(value = {ElementType.METHOD})  @Retention(RetentionPolicy.RUNTIME)  public @interface SxtMethod {      String Mname();  }  [java] view plain copypackage Demo;    import java.lang.annotation.Annotation;  import java.lang.reflect.Field;  import java.lang.reflect.Method;    public class Test01 {      public static void main(String[] args) {                    try {              Class clazz = Class.forName("Demo.AnnotationTest");              Annotation[] ann =  clazz.getAnnotations();              for (Annotation annotation : ann) {                  System.out.println(annotation);              }            System.out.println("----------------------------");          SxtTable st = (SxtTable) clazz.getAnnotation(SxtTable.class);          System.out.println(st.value());                    System.out.println("----------------------------");          //Field f = clazz.getDeclaredField("studentName");          //SxtField aff = f.getAnnotation(SxtField.class);          //System.out.println(aff.name()+"  "+aff.type()+"  "+aff.length());                    Field[] f01 = clazz.getDeclaredFields();          for (Field field : f01) {              SxtField aff = field.getAnnotation(SxtField.class);              System.out.println(aff.name()+"  "+aff.type()+"  "+aff.length());          }                    Method[] methods = clazz.getMethods();          for (Method method : methods) {                             SxtMethod sm =method.getAnnotation(SxtMethod.class);               if(sm == null){                   System.out.println("*****null*****");               }else{                   System.out.println(sm.Mname());               }                         }                                        } catch (Exception e) {              e.printStackTrace();          }        }  }

运行结果为：

@Demo.SxtTable(value=student001)
----------------------------
student001
----------------------------
id int 10
studentName Varchar 10
age int 3
*****null*****
setId
*****null*****
*****null*****
*****null*****
*****null*****
*****null*****
*****null*****
*****null*****
*****null*****
*****null*****
*****null*****
*****null*****
*****null*****
*****null*****
----------------------------------------------------------------------

在获取Method和Field的注解时，要注意空指针问题

0 0