怎么理解javaapi 怎么理解java注解

转载

数据分析大师 2023-07-10 12:21:20

文章标签 怎么理解javaapi Java 成员变量自定义注解 文章分类 Java 后端开发

注解：字面意思就是标注解释。就是对 Java 中的元素做一些标注，当需要用到这些信息时，用来获取到解释的信息。

首先，非常认同的上面链接的这位博主的观点，可以把注解类比成现实世界中的标签，标签是一张便签纸，上面的内容可以自定义，他可以贴在某件东西上做一个特殊标记，等到需要的时候，可以通过这个标签来获取一些想要的信息，这和 Java 中的注解有这异曲同工之妙。可以想象代码具有生命，注解就是对于代码中某些个体贴上去的一张标签，简单理解为：注解如同一张标签。

1、是什么？

注解（Annotation）是 JDK1.5 开始添加的新特性，是对元数据（MetaData）的支持。其实就是代码里的一种特殊标记。

2、为什么？

这些标记可以在编译、类加载、运行时被读取，并执行相应的处理。Java 很多框架都是基于注解开发的，例如：Spring2.5+、Hibernate3.x+。基于注解开发时一种趋势，一定程度上可以说：框架 = 注解 + 反射 + 设计模式。

3、怎么用？

Java中一些常见注解：

（1）生成文档相关的注解

@author 标明开发该类模块的作者，多个作者之间使用“,”分割 
@version 标明该类模块的版本 
@see 参考转向，也就是相关主题 
@since 从哪个版本开始增加的 
@param 对方法中某参数的说明，如果没有参数就不能写 
@return 对方法返回值的说明，如果方法的返回值类型是void就不能写 
@exception 对方法可能抛出的异常进行说明 ，如果方法没有用throws显式抛出的异常

（2）编译时检查注解

@Override: 限定重写父类方法, 该注解只能用于方法
@Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为所修饰的结构
危险或存在更好的选择
@SuppressWarnings: 抑制编译器警告

（3）自定义注解

@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {

    String value() default "";

}

定义新的 Annotation 类型使用 @interface 关键字
自定义注解自动继承了java.lang.annotation.Annotation接口
Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String类型、Class类型、enum类型、Annotation类型、以上所有类型的数组。
可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始值可使用 default 关键字
如果只有一个参数成员，建议使用参数名为value
如果定义的注解含有配置参数，那么使用时必须指定参数值，除非它有默认值。格式是“参数名 = 参数值”，如果只有一个参数成员，且名称为value，可以省略“value=”
没有成员定义的 Annotation 称为标记; 包含成员变量的 Annotation 称为元数据 Annotation

当我们进行自定义注解是可以参考 JDK 中现有的注解，一般情况下，都会指定 @Retention 和 @Target 两个元注解。

注意：自定义注解必须配上注解的信息处理流程才有意义。

（4）JDK 中的五个元注解

Retention
Target
Documented
Inherited
Repeatable （JDK1.8之后引进）

元注解是一种基本的注解，是注解到注解上注解，和 Java 中的 Class 类相似。

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

RetentionPolicy.SOURCE:在源文件中有效（即源文件保留），编译器直接丢弃这种策略的注释
RetentionPolicy.CLASS:在class文件中有效（即class保留），当运行 Java 程序时, JVM 不会保留注解。这是默认值
RetentionPolicy.RUNTIME:在运行时有效（即运行时保留），当运行 Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释。

b. @Target: 用于指定被修饰的 Annotation 能用于修饰哪些程序元素（类、接口、方法、字段等）。

c. @Documented: 用于指定被该元 Annotation 修饰的 Annotation 类将被 javadoc 工具提取成文档。默认情况下，javadoc是不包括注解的。

定义为Documented的注解必须设置Retention值为RUNTIME

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

e: @Repeatable: 可重复注解，被它修饰的 Annotation 可以在同一个元素上同时写多个值。

//1、添加 @Repeatable
@Repeatable(MyAnnotations.class)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {

    String value() default "";

}

//2、定义另一个注解 @MyAnnotations，并且@MyAnnotations上面的指定的 @Retention、@Target等值必须和 @MyAnnotation 一致
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotations {

    MyAnnotation[] value();

}

//3. 标注在可以修饰的元素上
@MyAnnotation(value = "值1")
@MyAnnotation(value = "值2")
public class MyAnnotationTest {

    @MyAnnotation(value = "值3")
    @MyAnnotation(value = "值4")
    private String name;

    private int desc;

    @MyAnnotation(value = "值5")
    @MyAnnotation(value = "值6")
    public void show() {
        System.out.println("hello!");
    }

}

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

在Java 8之前，注解只能是在声明的地方所使用，Java8开始，注解可以应用在任何地方。