JAVA注解_概述内置注解RetentionTargetDocumentedInherited

Posted 2022-08-16 所得皆惊喜

文章目录

• ①. 注解(Annotation)概述
• ②. 常见的Annotation
• ③. JDK内置的三个基本注解
• ④. 自定义Annotation
• ⑤. @Retention: 生命周期
• ⑥. @Target:目标
• ⑦. @Documented:文档
• ⑧. @Inherited:继承

①. 注解(Annotation)概述

• ①. 从JDK 5.0 开始, Java 增加了对元数据(MetaData) 的支持, 也就是Annotation(注解),目前非常的流行,很多主流框架都支持注解,而且自己编写尽量的去用注解,代码更加简洁。

• ②. Annotation其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理。通过使用Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息。代码分析工具、开发工具和部署工具可以通过这些补充信息进行验证或者进行部署。

• ③. Annotation可以像修饰符一样被使用, 可用于修饰包,类, 构造器, 方法, 成员变量, 参数, 局部变量的声明, 这些信息被保存在Annotation 的“name=value” 对中。

• ④. 未来的开发模式都是基于注解的,JPA是基于注解的,Spring基于注解的,Hibernate3.x以后也是基于注解的,注解是一种趋势,一定程度上可以说：框架=注解+反射+设计模式

• ⑤. 注解的原理
  注解本质是一个继承了Annotation 的特殊接口,其具体实现类是Java运行时生成的动态代理类。而我们通过反射获取注解时,返回的是Java 运行时生成的动态代理对象

②. 常见的Annotation

• ①. @author标明开发该类模块的作者,多个作者之间使用,分割

• ②. @version标明该类模块的版本

• ③. @see参考转向,也就是相关主题

• ④. @since从哪个版本开始增加的

• ⑤. @param对方法中某参数的说明,如果没有参数就不能写

• ⑥. @return对方法返回值的说明,如果方法的返回值类型是void就不能写

• ⑦. @exception对方法可能抛出的异常进行说明,方法没有用throws显式抛出的异常就不能写

• ⑧. @param@return和@exception这三个标记都是只用于方法的
  @param的格式要求：@param形参名形参类型形参说明
  @return的格式要求：@return返回值类型返回值说明
  @exception的格式要求：@exception异常类型异常说明
  @param和@exception可以并列多个

③. JDK内置的三个基本注解

• ①. @Override: 限定重写父类方法, 该注解只能用于方法

• ②. @Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构危险或存在更好的选择

• ③. @SuppressWarnings: 关闭不当编译器警告信息

• ④. Servlet3.0提供了注解(annotation),使得不再需要在web.xml文件中进行Servlet的部署。spring框架中关于“事务”的管理

④. 自定义Annotation

• ①. 定义新的Annotation类型使用@interface关键字,自定义注解自动继承了java.lang.annotati on.Annotation接口。Annotation的成员变量在Annotation定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组

• ②. 可以在定义Annotation的成员变量时为其指定初始值,指定成员变量的初始值可使用default关键字。如果只有一个参数成员,建议使用参数名为value。如果定义的注解含有配置参数,那么使用时必须指定参数值,除非它有默认值。格式是“参数名=参数值”,如果只有一个参数成员,且名称为value,可以省略“value=”。没有成员定义的Annotation称为标记;包含成员变量的Annotation称为元数据Annotation

@MyAnnotation(value = "牛大圣")
public class MyAnnotationTest 
    public static void main (String[] args) 
        Class c = MyAnnotationTest.class;
        Annotation annotation = c.getAnnotation(MyAnnotation.class);
        MyAnnotation m = (MyAnnotation) annotation;
        String value = m.value();
        System.out.println(value);
    

 
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@interface MyAnnotation 
    String value () default "xiaozhi";

⑤. @Retention: 生命周期

• ①. JDK 的元Annotation 用于修饰其他Annotation 定义,JDK5.0提供了4个标准的meta-annotation类型,分别是：Retention,Target,Documented, Inherited

• ②. 能用于修饰一个Annotation 定义, 用于指定该Annotation 的生命周期, @Rentention包含一个RetentionPolicy类型的成员变量, 使用@Rentention时必须为该value 成员变量指定值:

• ③. RetentionPolicy.SOURCE:在源文件中有效(即源文件保留),编译器直接丢弃这种策略的注释

• ④. RetentionPolicy.CLASS:在class文件中有效(即class保留),当运行Java 程序时, JVM 不会保留注解。这是默认值

• ⑤. RetentionPolicy.RUNTIME:在运行时有效(即运行时保留),当运行Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释

⑥. @Target:目标

• ①. 用于修饰Annotation 定义, 用于指定被修饰的Annotation能用于修饰哪些程序元素。@Target 也包含一个名为value 的成员变量。表示该注解可以用于什么地方,可能的ElementType参数有：

CONSTRUCTOR：构造器的声明
FIELD：域声明(包括enum实例)
LOCAL_VARIABLE：局部变量声明
METHOD：方法声明
PACKAGE：包声明
PARAMETER：参数声明
TYPE：类、接口(包括注解类型)或enum声明

• ②. JDK1.8之后,关于元注解@Target的参数类型ElementType枚举值多了两个：TYPE_PARAMETER,TYPE_USE

1. 在Java8之前,注解只能是在声明的地方所使用,Java8开始,注解可以应用在任何地方
2. ElementType.TYPE_PARAMETER表示该注解能写在类型变量的声明语句中(如：泛型声明)
3. ElementType.TYPE_USE表示该注解能写在使用类型的语句中

⑦. @Documented:文档

• ①. 用于指定被该元Annotation 修饰的Annotation 类将被javadoc工具提取成文档。

• ②. 测试加和不加注解的区别

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RestMapping 
    String[] value() default ;
    String[] path() default ;

@RestMapping("/terminal")
public class TerminalController 

⑧. @Inherited:继承

• ①. 被它修饰的Annotation 将具有继承性。如果某个类使用了被@Inherited 修饰的Annotation, 则其子类将自动具有该注解

• ②. 比如：如果把标有@Inherited注解的自定义的注解标注在类级别上,子类则可以继承父类类级别的注解,实际应用中,使用较少