Java中的注解

Java中的注解

这应该是Java基础部分的最后一篇了。这一篇中我们来详细了解一下什么是注解,注解到底有什么用

什么是注解

ava中的注解(Annotation)是一种元数据机制,能够为代码元素(如类、方法、变量等)添加额外的信息,而不会直接影响代码的运行逻辑。注解为编译器、工具和运行时环境提供信息,通常用于以下目的:

  1. 编译时检查(例如,@Override 检查方法是否正确重写)。
  2. 生成文档(例如,Javadoc 支持的 @author)。
  3. 运行时行为的改变(例如,依赖注入框架中的 @Autowired)。
  4. 代码生成(例如,Lombok 通过注解生成代码)。

不知道你是否能看懂,让我们接下来详细解释一下

原生注解

jdk中存在以下的原生注解

  • @Override - 检查(仅仅是检查,不保留到运行时)该方法是否是重写方法。如果发现其父类,或者是引用的接口中并没有该方法时,会报编译错误。

  • @Deprecated - 标记过时方法。如果使用该方法,会报编译警告。

  • @SuppressWarnings - 指示编译器去忽略注解中声明的警告(仅仅编译器阶段,不保留到运行时)

  • @FunctionalInterface - Java 8 开始支持,标识一个匿名函数或函数式接口。

  • @SafeVarargs - Java 7 开始支持,忽略任何使用参数为泛型变量的方法或构造函数调用产生的警告。

这些注解你应当或多或少在jdk的源码中都可以发现

元注解

什么是元注解,就是用来定义注解的注解,包括以下几种

  • @Retention - 标识这个注解怎么保存,是只在代码中,还是编入class文件中,或者是在运行时可以通过反射访问。

  • @@Document - 标记这些注解是否包含在用户文档中。

  • @Target - 标记这个注解应该用于哪种 Java 成员。

  • @Inherited - 标记这个注解是继承于哪个注解类(默认 注解并没有继承于任何子类)

  • @Repeatable - Java 8 开始支持,标识某注解可以在同一个声明上使用多次。

这些注解用来规定一个注解的使用规则

例如我们最常用的@Orverride的定义

1
2
3
4
@Target(ElementType.METHOD)//标识用于方法
@Retention(RetentionPolicy.SOURCE)//标识只在源码中保留
public @interface Override {
}

我们一个个来

  1. @Retention注解标记了这个注解到底该被保存到什么时候,可以选择以下三种

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    public enum RetentionPolicy {

    SOURCE,//只保留在源码中,编译时移除


    CLASS,//保留到编译后的Class文件中,但运行时不可见


    RUNTIME//一直保留,运行时仍然可见
    }

  2. @Document.这个注解被用来生成Javadoc文档,也就是我们在使用idea时将光标对准jdk提供的方法时出现的对方法的规定,比如每个方法都有的

    1
    @author  xxx

    用来说明这个方法的作者

  3. @Target这个注解标识注解该用于那种Java成员,包括

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    29
    30
    31
    32
    33
    34
    public enum ElementType {

    TYPE,//包括所有的类,接口,枚举类


    FIELD,//所有的属性


    METHOD,//所有的方法


    PARAMETER,//所有的参数


    CONSTRUCTOR,//构造器或者构造方法


    LOCAL_VARIABLE,//局部变量


    ANNOTATION_TYPE,//元注解


    PACKAGE,//包


    TYPE_PARAMETER,//泛型类型参数


    TYPE_USE,//任何的类型,包括泛型,数组,变量


    }

  4. @Inherited用于注解之间的继承

  5. @Repeatable - Java 8 开始支持,标识某注解可以在同一个声明上使用多次。

创建注解

接下来我们先自己创建一个注解

1
2
3
4
5
@Retention(RetentionPolicy.RUNTIME)//保留到运行时
@Target(ElementType.TYPE)//在类上使用
public @interface Myanno {
String value() default "666";//有一个String,默认值为666(默认值不是必须的)
}

注解中指允许有成员变量而不允许存在方法,且成员变量的格式为”无形参方法”,方法名为成员变量名

接下来是注解的使用

注解的使用

1
2
3
4
5
6
7
@Myanno("sss")
public class People {
private int age=10;
public int getAge() {
return age;
}
}

看不出来有什么作用吗,别急,先讲讲注解的使用规则

  1. 如果注解中只有一个成员变量且名称为value,那么可以直接在括号内输入想要赋的值,如果想使用默认值,可以直接不加括号

  2. 如果单一变量但名称不为value,需要使用如下格式

    1
    @Myanno(name = "666")
  3. 如果有多个变量且有默认值,对有默认值的变量不强制要求赋值,多个变量赋值时用逗号分隔

  4. 如果某个变量为数组类型,则赋值时用大括号标识集合

注解的内容可以通过反射获取

1
2
3
4
5
6
7
8
9
public class Main {
public static void main(String[] args) throws Exception {
Class clazz = People.class;
Annotation[] annotations = clazz.getAnnotations();
for (Annotation annotation : annotations) {
System.out.println(annotation);
}
}
}

这意味着我们通过注解的形式在不该变类的结构的同时给类贴上来某些标签,而框架正是通过这些标签来判断怎样处理一个类的

结语

总的来说这部分是比较简单的,就这样简单的结束吧

cab47c06 b2e5 41ad 844d c1d1c1be7fb6


Java中的注解
http://soulmate.org.cn/2024/12/31/Java中的注解/
作者
Soul
发布于
2024年12月31日
许可协议