Java注解

Zayn~

于 2024-07-28 12:17:26 发布

阅读量938

点赞数 29

文章标签： java 开发语言

本文链接：https://blog.csdn.net/qq_32473523/article/details/140742589

版权

概念

Java注解用于为Java代码提供元数据，作为元数据，注解不直接影响代码的执行，但也有一些类型的注解实际上可以用于这一目的。

分类

Java注解可以分为2种，第一种是元注解，第二种是自定义注解。

所谓元注解就是用来描述注解的注解，这里的元是由Meta翻译过来的。我们可以把元注解理解为J DK为了让我们自定义注解而提供的一些注解，在Java体系中，元注解只有5个，分别为@Target、@Retention、@Documented、@Inherited以及JDK1.8中新增的@Repeatable，除此之外的所有注解都是基于这5个注解定义出来的，所以也叫自定义注解。自定义注解又可以分为JDK内置注解以及开发者自定义的注解等多种。

五个元注解

1、@Target

用来指定一个注解的使用范围，如是用在方法还是成员变量等。参考该注解的源码可以看到，该注解有一个成员变量 ElementType[] value(); 其中的ElementType表示的是一个枚举类，所以说该属性可以定义多个ElementType，即可以指定多个范围，如指定类型和方法两个范围，就可以写成如下格式：

Target注解的源码如下图所示：

其中的ElementType如下所示：

2、@Documented

使用该注解会被JavaDoc工具类提取成文档。默认情况下JavaDoc中是不包含注解的，如果定义注解时指定了@Documented，则表明这个注解信息需要包含在JavaDoc中。

3、@Retention

用于描述注解的保留策略，表示在什么级别保存该注解信息。其中有一个RetentionPolicy类型的成员变量用来指定保留策略，RetentionPolicy也是一个枚举。

RetentionPolicy枚举只有3个枚举项：

我们经常看到的RetentionPolicy.RUNTIME ，很多时候是因为要在运行期通过反射读取。

4、@Inherited

用来指定该注解可以被继承。如当我们用@Inherited注解修饰了A类，这时候A的子类B类也会自动具有该注解。

应注意的是，@Inherited只会影响类上的注解，而方法和属性上的注解的继承性是不受@Inherited影响的。而声明在方法、成员变量处的注解，即使该注解没有使用@Inherited标注，默认都是可以继承的，除非子类重写了父类的方法或者父类中的成员变量。

5、@Repeatable

Java8新增的一个元注解，使用该注解来标识允许一个注解在一个元素上使用多次。如果不使用@Repeatable注解修饰自定义注解，那么该自定义注解默认是不能在同一元素上多次使用的。

如我想定义一个NoTXSql注解，这个注解可以在一个方法上用多次，其定义如下：

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
// 注意这里用的是新定义的注解NoTXSqlGroup
@Repeatable(NoTXSqlGroup.class)
public @interface NoTXSql {

    // 

}



@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
public @interface NoTXSqlGroup {
    /**
     * value
     *
     * @return NoTXSql[]
     */
    // 新定义的注解NoTXSqlGroup的value 是数组NoTXSql
    NoTXSql[] value();
}