当前位置： 首页 > news >正文

javaSE学习笔记24-注解（annotation）

news 来源：原创 2025/5/22 8:06:45

注解（Java.Annotation）


什么是注解
Annotation是从JDK5.0开始引入的新技术
Annotation的作用
    不是程序本身，可以对程序作出解释.(这一点和注释（comment）没什么区别)
    可以被其他程序（比如：编译器等）读取
Annotation的格式
    注解是以“@注释名”在代码中存在的，还可以添加一些参数值，例如：
    @SuppressWarning(value = "unchecked").
Annotation在哪里使用？
    可以附加在package，class，method，field等上面，相当于给他们添加了额外的辅助信息，
    我们可以通过反射机制编程实现对这些元数据的访问

内置注解
@Override：定义在java.lang.Override中，此注释只适用于修辞方法，表示一个声明打赏重写超类中的另一个方法声明
@Deprecated：定义在java.lang.Deprecated中，此注释可以用于修辞方法，属性，类，表示不鼓励程序员使用这样的元素，
通常是因为它很危险或者存在更好的选择
@SuppressWarnings：定义在java.lang.SuppressWarnings中，用来抑制编译时的警告信息，
    与前两个注释有所不同，你需要添加一个参数才能正确使用，这些参数都是已经定义好了的，我们选择性的使用就好了
    @SuppressWarnings("all")
    @SuppressWarnings("unchecked")
    @SuppressWarnings(value = {"unchecked","deprecation"})
    等等

学习理解代码：

package com.kuang.annotation;

/*
注解（Java.Annotation）
什么是注解
Annotation是从JDK5.0开始引入的新技术
Annotation的作用
    不是程序本身，可以对程序作出解释.(这一点和注释（comment）没什么区别)
    可以被其他程序（比如：编译器等）读取
Annotation的格式
    注解是以“@注释名”在代码中存在的，还可以添加一些参数值，例如：
    @SuppressWarning(value = "unchecked").
Annotation在哪里使用？
    可以附加在package，class，method，field等上面，相当于给他们添加了额外的辅助信息，
    我们可以通过反射机制编程实现对这些元数据的访问

内置注解
@Override：定义在java.lang.Override中，此注释只适用于修辞方法，表示一个声明打赏重写超类中的另一个方法声明
@Deprecated：定义在java.lang.Deprecated中，此注释可以用于修辞方法，属性，类，表示不鼓励程序员使用这样的元素，
通常是因为它很危险或者存在更好的选择
@SuppressWarnings：定义在java.lang.SuppressWarnings中，用来抑制编译时的警告信息，
    与前两个注释有所不同，你需要添加一个参数才能正确使用，这些参数都是已经定义好了的，我们选择性的使用就好了
    @SuppressWarnings("all")
    @SuppressWarnings("unchecked")
    @SuppressWarnings(value = {"unchecked","deprecation"})
    等等
 */

import java.util.ArrayList;
import java.util.List;

//测试学习什么是注解
@SuppressWarnings("all")
public class Test01 extends Object{

    //@Override 重写的注解
    @Override
    public String toString() {
        return super.toString();
    }

    //Deprecated  不推荐程序员使用，但是可以使用，或者存在更好的方式
    @Deprecated
    public static void test(){
        System.out.println("Deprecated");
    }

    @SuppressWarnings("all")
    public void test02(){
        List list = new ArrayList();
    }

    public static void main(String[] args) {
        test();
    }
}

@Override  重写注解 --》打开jdk文档搜索

Annotation Type Override 是一个注解的类型

@Deprecated 已过时的注解

@SuppressWarnings

 查看源码：ctrl + 鼠标左键 点击SuppressWarnings即可进入

元注解

Java提供了几个元注解（用于注解其他注解的注解）：

  • @Retention：指定注解的保留策略。

  • @Target：指定注解可以应用的目标。

  • @Documented：指定注解是否包含在JavaDoc中。

  • @Inherited：指定注解是否可以被继承。


元注解的作用就是负责其他注解，Java定义了4个标准的meta-annotation类型
他们被用来提供对其他annotation类型作说明
这些类型和它们所支持的类在java.lang.annotation包中可以找到（@Target，
@Retention，@Documented，@Inherited）
    @Target：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）
    @Retention：表示需要在什么级别保存该注释信息，用于描述注解的生命周期
        （SOURCE < CLASS < RUNTIME）
    @Document：说明该注解将被包含在Javadoc中
    @Inherited：说明子类可以继承父类中的该注解

理解代码：

package com.kuang.annotation;

/*
元注解
元注解的作用就是负责其他注解，Java定义了4个标准的meta-annotation类型
他们被用来提供对其他annotation类型作说明
这些类型和它们所支持的类在java.lang.annotation包中可以找到（@Target，
@Retention，@Documented，@Inherited）
    @Target：用于描述注解的使用范围（即：被描述的注解可以用在什么地方）
    @Retention：表示需要在什么级别保存该注释信息，用于描述注解的生命周期
        （SOURCE < CLASS < RUNTIME）
    @Document：说明该注解将被包含在Javadoc中
    @Inherited：说明子类可以继承父类中的该注解
 */

import java.lang.annotation.*;

/*
1.自定义了一个注解MyAnnotation{}
2.Target注解，ctrl + 鼠标左键进入Target查看源码，可以看到需要一个参数value
ctrl + 鼠标左键进入ElementType查看源码，可以看到有很多

 */

//测试元注解
@MyAnnotation
public class Test01 {

    @MyAnnotation
    public void test01(){

    }


}


//Target注解 表示我们的注解可以用在哪些地方，可以用在方法METHOD，TYPE：类、接口、枚举  掌握
@Target(value = {ElementType.METHOD,ElementType.TYPE})
//Retention注解，表示我们的注解在什么地方还有效，runtime > class > sources 掌握
@Retention(value = RetentionPolicy.RUNTIME)
//Documented 表示是否将我们的注解生成在Javadoc中
@Documented
//Inherited 子类可以继承父类的注解
@Inherited
//定义一个注解MyAnnotation
@interface MyAnnotation{}

在Java中，@Target(ElementType.ANNOTATION_TYPE) 用于指定某个注解只能被应用到其他注解的声明上，表明这是一个元注解（meta-annotation），即用于修饰其他注解的注解。以下是详细解释和示例：

核心概念

  1. @Target 的作用
    它是Java的元注解之一，用于限制某个注解可以应用的位置（如类、方法、字段等），通过ElementType枚举来指定目标类型。

  2. ElementType.ANNOTATION_TYPE 的含义
    它表示被修饰的注解只能用来注解其他注解，而不是普通的类、方法或字段等。这使得该注解成为元注解。

示例说明

import java.lang.annotation.*;

// 使用@Target(ANNOTATION_TYPE)表示该注解只能修饰其他注解
@Target(ElementType.ANNOTATION_TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MetaAnnotation {
    String description() default "这是一个元注解";
}

// 使用MetaAnnotation修饰另一个注解
@MetaAnnotation(description = "用于标记需要日志记录的注解")
public @interface Loggable {
    // Loggable注解的具体定义
}

// 错误用法：尝试用@MetaAnnotation修饰类（编译报错）
@MetaAnnotation
public class MyClass { }

  • MetaAnnotation 被标记为只能修饰其他注解（ANNOTATION_TYPE）。

  • Loggable 是一个普通注解，但通过@MetaAnnotation添加了元数据。

  • 若尝试将@MetaAnnotation用于类（如MyClass），编译器会报错。

典型应用场景

  1. 定义元注解
    如Java内置的元注解@Retention、@Target自身就是用ANNOTATION_TYPE修饰的：

    @Target(ElementType.ANNOTATION_TYPE)
public @interface Retention {
    RetentionPolicy value();
}

  2. 组合注解功能
    通过元注解为其他注解添加通用行为。例如，Spring Security的@WithMockUser可以结合自定义元注解，简化配置。

其他ElementType类型

  • TYPE：类、接口、枚举

  • METHOD：方法

  • FIELD：字段

  • PARAMETER：方法参数

  • 其他如CONSTRUCTOR、LOCAL_VARIABLE等。

总结

使用@Target(ElementType.ANNOTATION_TYPE)的注解只能修饰其他注解，使其成为元注解。这是构建注解层次结构或为其他注解添加元数据的关键机制。

自定义注解


使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口
    分析
        @interface用来声明一个注解，格式：public @interface 注解名{定义内容}
        其中的每一个方法实际上是声明了一个配置参数
        方法的名称就是参数的名称
        返回值类型就是参数的类型（返回值只能是基本类型，Class，String，enum）
        可以通过default来声明参数的默认值
        如果只有一个参数成员，一般参数名为value
        注解元素必须要有值，我们定义注解元素时，经常使用空字符串，0作为默认值

练习理解代码：

package com.kuang.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

//自定义注解
public class Test03 {
    //注解可以显示赋值，如果没有默认值，我们就必须给注解赋值
    @MyAnnotation2(name = "小明",school = "",age = 18,id = 11)
    public void test1(){
    }

    @MyAnnotation3("宿命")
    public void test2(){

    }
}

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{
    //注解的参数：参数类型 + 参数名();
    String name() default "";
    int age() default 0;
    int id() default -1;//如果默认值为-1，代表不存在

    String[] school() default {"开源","社会大学"};
}

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3{
    String value();//如果注解只有一个值，可以用value定义，这样调用注解的时候@MyAnnotation3括号里就不用写value
//    String name();
}

代码解析

1.1 MyAnnotation2 注解
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2 {
    // 注解的参数：参数类型 + 参数名();
    String name() default "";
    int age() default 0;
    int id() default -1; // 如果默认值为-1，代表不存在
    String[] school() default {"开源", "社会大学"};
}

  • @Target：指定注解可以应用的目标类型。ElementType.TYPE 表示可以应用于类、接口、枚举等类型，ElementType.METHOD 表示可以应用于方法。

  • @Retention：指定注解的保留策略。RetentionPolicy.RUNTIME 表示注解在运行时保留，可以通过反射读取。

  • 注解参数：

    • name()：字符串类型，默认值为空字符串。

    • age()：整数类型，默认值为 0。

    • id()：整数类型，默认值为 -1，表示如果未显式赋值，则视为不存在。

    • school()：字符串数组类型，默认值为 {"开源", "社会大学"}。

 1.2 MyAnnotation3 注解
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3 {
    String value(); // 如果注解只有一个值，可以用 value 定义
    // String name(); // 如果需要多个值，可以定义其他参数
}

  • value()：这是一个特殊的注解参数。如果注解只有一个参数，且参数名为 value，那么在使用注解时可以省略参数名，直接赋值。

    • 例如：@MyAnnotation3("宿命") 等价于 @MyAnnotation3(value = "宿命")。

2.1 使用 MyAnnotation2 
@MyAnnotation2(name = "小明", school = "", age = 18, id = 11)
public void test1() {
}

  • 这里为 MyAnnotation2 注解的所有参数显式赋值：

    • name = "小明"

    • school = ""（覆盖了默认值）

    • age = 18

    • id = 11

2.2 使用 MyAnnotation3
@MyAnnotation3("宿命")
public void test2() {
}

  • 由于 MyAnnotation3 只有一个参数 value，因此可以直接赋值，无需写参数名。

总结

  • 自定义注解：通过 @interface 关键字定义，可以包含多个参数。

  • 注解参数：

    • 可以设置默认值（使用 default 关键字）。

    • 如果只有一个参数且命名为 value，可以省略参数名直接赋值。

  • 元注解：

    • @Target：指定注解可以应用的目标。

    • @Retention：指定注解的保留策略。

在Java中，自定义注解允许你定义自己的注解类型，这些注解可以用于类、方法、字段等元素上，以提供额外的元数据信息。自定义注解通过@interface关键字来定义。

1. 定义自定义注解

下面是一个简单的自定义注解示例：

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

// 定义注解的保留策略（RetentionPolicy）
@Retention(RetentionPolicy.RUNTIME)
// 定义注解可以应用的目标（ElementType）
@Target({ElementType.TYPE, ElementType.METHOD})
public @interface MyCustomAnnotation {
    // 定义注解的元素（类似于方法）
    String value() default "default value";
    int count() default 0;
}

  • @Retention(RetentionPolicy.RUNTIME)：指定注解的保留策略。RetentionPolicy.RUNTIME表示注解在运行时保留，可以通过反射读取。

  • @Target({ElementType.TYPE, ElementType.METHOD})：指定注解可以应用的目标。ElementType.TYPE表示可以应用于类、接口、枚举等类型，ElementType.METHOD表示可以应用于方法。

  • String value() default "default value";：定义了一个名为value的注解元素，默认值为"default value"。

  • int count() default 0;：定义了一个名为count的注解元素，默认值为0。

2. 使用自定义注解

定义好注解后，你可以在类、方法等元素上使用它：

@MyCustomAnnotation(value = "example", count = 5)
public class MyClass {

    @MyCustomAnnotation(count = 10)
    public void myMethod() {
        // 方法体
    }
}

3. 通过反射读取注解信息

你可以通过反射在运行时读取注解信息：

import java.lang.reflect.Method;

public class AnnotationExample {
    public static void main(String[] args) throws NoSuchMethodException {
        // 获取类上的注解
        MyCustomAnnotation classAnnotation = MyClass.class.getAnnotation(MyCustomAnnotation.class);
        if (classAnnotation != null) {
            System.out.println("Class Annotation value: " + classAnnotation.value());
            System.out.println("Class Annotation count: " + classAnnotation.count());
        }

        // 获取方法上的注解
        Method method = MyClass.class.getMethod("myMethod");
        MyCustomAnnotation methodAnnotation = method.getAnnotation(MyCustomAnnotation.class);
        if (methodAnnotation != null) {
            System.out.println("Method Annotation value: " + methodAnnotation.value());
            System.out.println("Method Annotation count: " + methodAnnotation.count());
        }
    }
}

4. 注解元素的类型

注解元素可以是以下类型：

  • 基本数据类型（int, float, boolean等）

  • String

  • Class

  • 枚举类型

  • 注解类型

  • 以上类型的数组

5. 默认值

注解元素可以指定默认值，使用default关键字。如果使用注解时没有指定该元素的值，则会使用默认值。

 

相关文章：

  • SBOM情报预警 | 恶意NPM组件窃取Solana智能合约私钥
  • Docket Desktop 安装redis 并设置密码
  • 【c++】【线程池】线程池概述
  • CPU安装pytorch（别点进来）
  • 番茄工作法html实现
  • 大模型知识蒸馏技术（5）——在线蒸馏
  • Linux·spin_lock的使用
  • ClickHouse分布式高可用实战：ReplicatedMergeTree引擎深度解析与代码实践
  • 毕设 - 眼镜店供销系统（vue+springboot）项目分享
  • 亚远景-ISO PAS 8800:2024与其他道路车辆安全标准有何不同？
  • Android 布局系列（一）：LinearLayout 使用指南
  • 空字符串““、空白字符串“ “和 null 三者的区别
  • 零基础学python------第四节：Python的序列（seq）：字符串+列表+元祖
  • 政安晨的AI大模型训练实践 九 - 熟悉LLaMA Factory的详细参数含义-基本概念理解一下
  • 【知识】深度学习中，应该先zero_grad还是先backward？
  • go io.Pipe
  • 【拜读】Tensor Product Attention Is All You Need姚期智团队开源TPA兼容RoPE位置编码
  • 三、动规_子数组系列
  • python学智能算法（一）|模拟退火算法：原理解释和最小值求解
  • Python内置函数详解
  • 姜再冬会见巴基斯坦空军参谋长：中方欢迎并支持巴印通过对话妥善处理分歧
  • 董明珠孟羽童官宣，5月23日将合体直播
  • 以色列“全面接管”加沙“雷声大雨点小”：援助政策引内讧，美欧失去耐心
  • 人民日报：莫让“假自杀”淹没“真求助”
  • 专家：新冠病毒流行高峰无明显季节性特征，与人群抗体水平有关
  • 西安市长安区与航天基地区政合一管理，党政一把手分任基地党工委正副书记