java注解（一）：什么是注解？什么是元注解？如何自定义注解？注解的原理是什么？

news2025/1/11 1:38:58

1、什么是注解？

2、什么是元注解

1、@Target()

2、@Retention()

3、@Documented

4、@Inherited

3、如何自定义注解以解使用

4、注解的原理

本篇文章主要是介绍注解的概念、原理，以及通过代码演示4种元注解、如何自定义注解。通过反编译的形式进一步认识注解的本质。

1、什么是注解？

注释是给人看的，注解是给程序看的

例如我们常见的单元测试@Test注解，实现父类方法的@Override注解

2、什么是元注解

元注解就是负责修饰其他注解的注解

java定义了四种，主要是用于规范当前注解的作用范围，注解生命周期等。

分为@Target()、@Retention()、@Documented、@Inherited

其中@Target()、@Retention()是用得比较多的。

1、@Target()

需要带参数，表示规范这个注解可以用在类上，或者方法等其他地方上。

ElementType这个枚举类定义了很多类型，根据不同类型的定义决定被修饰的注解的使用地方

//表示我们的注解可以用在哪些地方，可以进源码查看
@Target(value = {ElementType.METHOD})

ElementType的类型如下

2、@Retention()

需要带参数，表示注解在什么地方还有效，描述注解的生命周期。有3种情况

SOURCES：只作用在源码阶段，字节码文件种不存在

CLASS：保留到字节码文件阶段，运行阶段不存在

RUNTIME：运行时有效，开发常用

RUNTIME>CLASS>SOURCES

//表示注解在什么地方还有效，一般就3种情况。RUNTIME>CLASS>SOURCES
@Retention(value = RetentionPolicy.RUNTIME)

3、@Documented

表示是否将我们的注解生成在javaDoc中

@Documented

4、@Inherited

说明子类可以继承父类中的该注解

@Inherited

3、如何自定义注解以解使用

以下是自定义一个metaAnnotation注解

自定义注解里面的属性必须要带括号

下面拆分为几种形式学习

情况一：注解值属性为value，且仅有一个属性时，使用该注解可以省略命名

@Target(value = {ElementType.METHOD})//表示该注解是定义在方法上的
@Retention(value = RetentionPolicy.RUNTIME)  //表示该注解生命周期为运行时有效
public @interface metaAnnotation{
    //自定义注解，记得加括号
    String value();  //为value时，注解可以省略命名
 
}

使用方法

@metaAnnotation("value时可以省略命名，只有这个可以，不成名的规范")
    public static void main(String[] args) {
    }

情况二：设置默认值的注解，使用时候可以选择不命名以及不传参数。

@Target(value = {ElementType.METHOD})//表示该注解是定义在方法上的
@Retention(value = RetentionPolicy.RUNTIME)  //表示该注解生命周期为运行时有效
public @interface metaAnnotation{
    //自定义注解，记得加括号
    int id() default 1;
    int index() default -1;  //如果默认值为-1，代表不存在
 
}

使用方法

@metaAnnotation()
public static void main(String[] args) {
}

情况三：多参数定义注解，属性为value的必须要命名传参，

其他属性的无默认值的也必须要命名传参，

设置了默认值的属性也可以选择传参，

参数也可以为数组的方式

@Target(value = {ElementType.METHOD})//表示该注解是定义在方法上的
@Retention(value = RetentionPolicy.RUNTIME)  //表示该注解生命周期为运行时有效
public @interface metaAnnotation{
    //自定义注解，记得加括号
    String value();  //为value时，注解可以省略命名
    int id() default 1;
    int index() default -1;  //如果默认值为-1，代表不存在
    String name();
    int age();
    String[] nameList();
}

使用方法

  @metaAnnotation(value = "value时可以省略命名，只有这个可以，不成名的规范",index = 1,name = "名字",age = 99,nameList = {"名字1","名字1"})
    public static void main(String[] args) {
    }

4、注解的原理

注解的本质：

就是一个接口，java中所有的注解都继承了Annotation接口。

我们使用注解@注解(...)的时候其实就是一个实现类对象，实现了该注解以及Annotation接口

先把注解编译成class再反编译，还是以我们自定义的注解举例子

@Target(value = {ElementType.METHOD})//表示该注解是定义在方法上的
@Retention(value = RetentionPolicy.RUNTIME)  //表示该注解生命周期为运行时有效
public @interface metaAnnotation{
    //自定义注解，记得加括号
    String value();  //为value时，注解可以省略命名
    int id() default 1;
    int index() default -1;  //如果默认值为-1，代表不存在
    String name();
    int age();
}

以下是反编译后注解真正的源代码