深入理解Java 注解原理 深碍√TFBOYSˉ_ 2022-05-27 04:28 179阅读 0赞 ## \*注解的用途 ## 注解(Annotation)是JDK1.5引入的新特性,包含在java.lang.annotation包中,**注解是附加在代码中的一些元信息,将一个类的外部信息与内部成员联系起来,在编 译、运行时进行解析和使用**。Java内置了一些注解(如@Override、@Deprecated等),还支持自定义注解,一些知名的框架 Struts、Hibernate、Spring都有自己实现的自定义注解,也可以自己定义注解供使用。 Annotation十分类似public、final这样的修饰符。每个Annotation具有一个名字和成员个数>=0。每个Annotation的成员具有被称为name=value对的名字和值(就像javabean一样),name=value装载了Annotation的信息。 Annotation类(java.lang.reflect.Annotation): **Annotation类型定义了Annotation的名字、类型、成员默认值**。一个Annotation类型可以说是一个特殊的java接口,它的成员变量是受限制的,而声明Annotation类型时需要使用新语法。当我们通过**java反射api访问Annotation**时,返回值将是一个实现了该 annotation类型接口的对象,通过访问这个对象我们能方便的访问到其Annotation成员。后面的章节将提到在java5.0的 java.lang包里包含的3个标准Annotation类型。其子类如下图所示: ![Center][] 注解处理器类库(java.lang.reflect.AnnotatedElement): Java使用Annotation接口来代表**程序元素(Class、Method和Constructor)**前面的注解,**Annotation接口是所有Annotation类型的父接口**。除此之外,Java在java.lang.reflect 包下新增了**AnnotatedElement接口,该接口代表程序中可以接受注解的程序元素**,该接口主要有如下几个实现类(如下图所示): Class:类定义 Constructor:构造器定义 Field:累的成员变量定义 Method:类的方法定义 Package:类的包定义 **java.lang.reflect 包下主要包含一些实现反射功能的工具类**,实际上,java.lang.reflect (该包支持对运行时注解的解析)包所有提供的反射API扩充了读取运行时Annotation信息的能力。**当一个Annotation类型被定义为运行时的Annotation后,该注解才能是运行时可见,当class文件被装载时被保存在class文件中的Annotation才会被虚拟机读取。** AnnotatedElement 接口是所有程序元素(Class、Method和Constructor)的父接口,所以程序通过反射获取了某个类的AnnotatedElement对象之后,程序就可以调用该对象(AnnotatedElement)的如下四个个方法来访问Annotation信息: ***方法1:*<T extends Annotation> T getAnnotation(Class<T> annotationClass): 参数:传入一个指定的注解类, 如果该程序元素上存在指定类型的注解,那么就返回该注解实例,****如果该类型注解不存在,则返回null。** ** 例如 A.class 中存在 @Controller一个注解 ** ** Controller c = a.getAnnotation(Controller.class) //存在该注解** ** Compent c = a.getAnnotation(Compent.class);//该注解不存在 返回null** ** ** ***方法2:*Annotation\[\] getAnnotations():返回该程序元素上存在的所有注解。包括他继承的父类上的注解** ** *方法3:*boolean is AnnotationPresent(Class<?extends Annotation> annotationClass):判断该程序元素上是否包含指定类型的注解,存在则返回true,否则返回false. *方法4:*Annotation\[\] getDeclaredAnnotations():返回直接存在于此元素上的所有注释。与此接口中的其他方法不同,该方法将忽略继承的注释。(如果没有注释直接存在于此元素上,则返回长度为零的一个数组。)该方法的调用者可以随意修改返回的数组;这不会对其他调用者返回的数组产生任何影响。** ![Center 1][] ## \*注解类型 ## 注解的一般格式是\[修饰符\] @interface \[名称\]\{元素\}, 元素是无方法体的方法声明,可以有默认值,如@Target的注解如下所示: **\[java\]** [view plain][] [copy][view plain] 1. @Documented 2. @Retention(RetentionPolicy.RUNTIME) 3. @Target(ElementType.ANNOTATION\_TYPE) 4. public @interface Target \{ 5. ElementType\[\] value(); 6. \} 元注解的作用就是负责注解其他注解。Java5.0定义了4个标准的meta-annotation类型,它们被用来提供对其它 annotation类型作说明。Java5.0定义的元注解: 1.@Target, 2.@Retention, 3.@Documented, 4.@Inherited 这些类型和它们所支持的类在java.lang.annotation包中可以找到。下面我们看一下每个元注解的作用和相应分参数的使用说明。 @Target: @Target说明了Annotation所修饰的对象范围:Annotation可被用于 packages、types(类、接口、枚举、Annotation类型)、类型成员(方法、构造方法、成员变量、枚举值)、方法参数和本地变量(如循环变量、catch参数)。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。 作用:用于描述注解的使用范围(即:被描述的注解可以用在什么地方) 取值(ElementType)是来源于Java.lang.annotation.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)来源于java.lang.annotation.RetentionPolicy的枚举类型值: 1.SOURCE:在源文件中有效(即源文件保留 .java) 2.CLASS:在class文件中有效(即class保留 .class) 3.RUNTIME:在运行时有效(即运行时保留 被jvm载入加载生成Class解析运行中) @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类型被发现,或者到达类继承结构的顶层。 ## \*注解实现实例 ## 实现注解需要三个条件:注解声明、使用注解的元素、操作注解使其起作用(注解处理器)。 定一个MyTag注解类: **\[java\]** [view plain][] [copy][view plain] 1. import java.lang.annotation.ElementType; 2. import java.lang.annotation.Inherited; 3. import java.lang.annotation.Retention; 4. import java.lang.annotation.RetentionPolicy; 5. import java.lang.annotation.Target; 6. 7. @Target(\{ElementType.METHOD,ElementType.FIELD\}) 8. @Inherited 9. @Retention(RetentionPolicy.RUNTIME) 10. public @interface MyTag \{ 11. 12. String name() default "车"; 13. int size() default 10; 14. \} 定义一个实体Car类: **\[java\]** [view plain][] [copy][view plain] 1. public class Car \{ 2. 3. private String name; 4. private int size; 5. public String getName() \{ 6. return name; 7. \} 8. public void setName(String name) \{ 9. this.name = name; 10. \} 11. public int getSize() \{ 12. return size; 13. \} 14. public void setSize(int size) \{ 15. this.size = size; 16. \} 17. 18. public Car()\{ 19. 20. \} 21. public Car(String name, int size)\{ 22. this.size = size; 23. this.name = name; 24. \} 25. @Override 26. public String toString() \{ 27. return "Car \[name=" + name + ", size=" + size + "\]"; 28. \} 29. 30. \} 定义一个使用注解的类AnnotationDemo类: **\[java\]** [view plain][] [copy][view plain] 1. public class AnnotationDemo\{ 2. 3. @MyTag(name = "audi", size = 10) 4. private Car car; 5. 6. public Car getCar() \{ 7. return car; 8. \} 9. 10. public void setCar(Car car) \{ 11. this.car = car; 12. \} 13. 14. @Override 15. public String toString() \{ 16. return "Annotation \[car=" + car + "\]"; 17. \} 18. \} 定义一个操作注解即让注解起作用的类AnnotationProccessor类: **\[java\]** [view plain][] [copy][view plain] 1. import java.lang.reflect.Field; 2. 3. public class AnnotationProccessor \{ 4. 5. public static void annoProcess(AnnotationDemo annotation)\{ 6. 7. for(Field field : annotation.getClass().getDeclaredFields())\{ //获取该class类中的所有字段属性 8. if(field.isAnnotationPresent(MyTag.class))\{ //如果存在MyTag标签 判断属性中是否存在指定注解 9. MyTag myTag = field.getAnnotation(MyTag.class); // 获取该字段上的指定注解,并返回 10. annotation.setCar(new Car(myTag.name(),myTag.size())); //获取注解中传入的值 11. \} 12. \} 13. \} 14. public static void main(String\[\] args) \{ 15. AnnotationDemo ann = new AnnotationDemo(); 16. annoProcess(ann); 17. System.out.println(ann.getCar()); 18. 19. \} 20. \} **\[java\]** [view plain][] [copy][view plain] 1. 版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/zhang0558/article/details/52643016 [Center]: /images/20220527/4833147e664741acb251601fc89b8036.png [Center 1]: /images/20220527/31fa8bc1ffef4ce0a2b6d92a03b9d03d.png [view plain]: https://blog.csdn.net/zhang0558/article/details/52643016#
还没有评论,来说两句吧...