首页 > 编程语言 >Java 自定义注解笔记总结(油管)

Java 自定义注解笔记总结(油管)

时间:2024-08-07 16:26:26浏览次数:15  
标签:Java 自定义 油管 class 注解 annotation ElementType public

Java系列文章目录

Java 抽象相关知识笔记


文章目录

一、前言

目的:学习自定义注解相关内容

  • 对油管博主John讲解的注解相关知识进行笔记总结

二、学习内容:

  • 自定义注解的使用

三、问题描述

  • 自定义注解没有实践经验

四、解决方案:

4.1 自定义注解引入

参考代码如下:

package org.example;

import java.lang.reflect.Field;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;

public class Main {
    public static void main(String[] args) throws InvocationTargetException, IllegalAccessException {
        Cat mycat = new Cat("Kitty");
        Dog mydog = new Dog("Jerry");
        if (mydog.getClass().isAnnotationPresent(VeryImportant.class))
        {
            System.out.println("This is a very important dog!");
        } else {
            System.out.println("This is not a very important dog!");
        }

        for (Method method :mycat.getClass().getDeclaredMethods())
        {
            if (method.isAnnotationPresent(RunImmediately.class))
            {
                RunImmediately annotation = method.getAnnotation(RunImmediately.class);
                for (int i = 0; i < annotation.times(); i++) {
                    method.invoke(mycat);
                }
            }
        }

        for (Field declaredField : mycat.getClass().getDeclaredFields()) {
            if (declaredField.isAnnotationPresent(ImportantString.class))
            {
                Object value = declaredField.get(mycat);
                if (value instanceof String)
                {
                    System.out.println(value.toString().toUpperCase());
                }

            }
        }
    }
}
  • 对这三个分别在类,方法与字段上的注解进行讲解
package org.example;
@VeryImportant
public class Cat {
    @ImportantString
    String name;
    int age;
    public Cat(String name) {
        this.name = name;
    }
    @RunImmediately(times = 3)
    public void meow() {
        System.out.println("Meow");
    }

    public void eat() {
        System.out.println("Eating");
    }
}
@Target(ElementType.METHOD) 
@Retention(RetentionPolicy.RUNTIME)
public @interface RunImmediately {
    int times();
}
@Target({ElementType.TYPE, ElementType.METHOD})
//实际运行时保留此注解,其他代码可以查看这个注释并在运行时通过反射使用他
//Source 开始编译代码前删除这个注释 处理警告
//CLASS 编译过程保留注释 运行时抛弃
@Retention(RetentionPolicy.RUNTIME)
public @interface VeryImportant {

}

Dog是参考类

在这里插入图片描述

  • 我们学习使用像下面这样的自定义注解

在这里插入图片描述

4.2 自定义注解使用

4.2.1 自定义注解概念

自定义注解在编程中主要用于提供额外的信息或元数据,它们并不直接参与程序的运行,而是供编译器、构建工具或其他处理程序在编译期间或运行时解析

使用场景:

  • 增强代码可读性:通过注解,开发者可以为特定代码块添加上下文相关的描述,帮助其他人更好地理解代码的功能。
  • 配置信息传递:在框架或库中,注解可以作为配置选项,用于指定组件的行为、路径或者其他需要动态设置的属性。
  • AOP(面向切面编程)支持:一些注解用于通知AOP框架进行切面的插入,比如@AspectJ注解。
  • 元数据收集:注解可以帮助系统收集关于代码结构、依赖关系等非功能性信息,便于分析、调试和性能优化。
  • 未来扩展:如果需要为现有代码预留扩展空间,自定义注解可以避免硬编码,方便后续修改。

主要学习下面两个元注解

@Target 定义注解作用的位置

  • ElementType.ANNOTATION_TYPE: 说明该注解只能应用于其他注解类型。
  • ElementType.FIELD: 用于字段(变量)上。
  • ElementType.METHOD: 用于方法上。
  • ElementType.PARAMETER: 用于方法参数上。
  • ElementType.CONSTRUCTOR: 用于构造函数上。
  • ElementType.TYPE: 用于类、接口或异常声明上。
  • ElementType.PACKAGE: 用于包上。
  • ElementType.LOCAL_VARIABLE: 用于局部变量上。
  • ElementType.MEMBER_CLASS: 用于成员内部类上。

@Retention 定义了注解应该在哪些级别保留其有效性

  • RUNTIME: 表示该注解在运行时仍然可见,并且可以通过反射API获取到。

  • SOURCE: 只在源代码级别有效,编译后会被丢弃。这种类型的注解通常用于编译器插件或生成其他源代码的时候。

  • CLASS: 仅在类加载时生效,在类加载完成并初始化后就不再可用。这意味着只有类文件级别的注解才会被保留。

在这里插入图片描述

  • 如果没有ElementType.METHOD就会报错

在这里插入图片描述

  • 观察结果

在这里插入图片描述

4.2.2 自定义注解内部的属性

  • 观察可知自定义注解里面参数是函数形式的

如果没有默认值则使用的时候必须写出

在这里插入图片描述

  • 同理关于字段的注解

在这里插入图片描述
在这里插入图片描述


五、总结:

5.1 学习总结:

  1. 注解的定义

自定义注解使用@interface关键字进行定义,并可以包含一些成员方法,通常用于定义额外的参数。

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

@Retention(RetentionPolicy.RUNTIME) // 指定注解的保留策略  
public @interface MyAnnotation {  
    String value() default ""; // 默认值  
    int number() default 0; // 另一个属性  
}  
  1. 注解的保留策略

RetentionPolicy.SOURCE:注解只会保留在源代码中,编译后会被丢弃。
RetentionPolicy.CLASS:注解会被保留在class文件中,但在运行时不可用。
RetentionPolicy.RUNTIME:注解会被保留在class文件中,在运行时可以通过反射读取。

  1. 注解的使用

可以将自定义注解应用于类、方法、字段、参数等。

@MyAnnotation(value = "example", number = 5)  
public class MyClass {  
    @MyAnnotation(value = "method")  
    public void myMethod() {  
    }  
}  
  1. 读取注解

可以通过Java反射机制读取注解的信息。

import java.lang.reflect.Method;  

public class AnnotationProcessor {  
    public static void main(String[] args) {  
        Class<MyClass> obj = MyClass.class;  

        // 读取类的注解  
        if (obj.isAnnotationPresent(MyAnnotation.class)) {  
            MyAnnotation annotation = obj.getAnnotation(MyAnnotation.class);  
            System.out.println("Class Annotation: " + annotation.value() + ", " + annotation.number());  
        }  

        // 读取方法的注解  
        try {  
            Method method = obj.getMethod("myMethod");  
            if (method.isAnnotationPresent(MyAnnotation.class)) {  
                MyAnnotation annotation = method.getAnnotation(MyAnnotation.class);  
                System.out.println("Method Annotation: " + annotation.value());  
            }  
        } catch (NoSuchMethodException e) {  
            e.printStackTrace();  
        }  
    }  
}  
  1. 注解的元注解

在定义自定义注解时,可以使用元注解来指定注解的特性,常见的元注解有:

@Retention:指定注解的保留策略。
@Target:指定注解可以应用在什么地方(类、方法、字段等)。
@Documented:表明将注解包含在JavaDoc中。
@Inherited:允许子类继承超类的注解。

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

@Target(ElementType.METHOD) // 该注解只能用在方法上  
@Retention(RetentionPolicy.RUNTIME)  
public @interface MethodInfo {  
    String author() default "unknown";  
    String date();  
    int revision() default 1;  
}  
  1. 注解示例

以下是一个简单的自定义注解示例,展示了如何定义和应用注解:

@Target(ElementType.METHOD)  
@Retention(RetentionPolicy.RUNTIME)  
public @interface Test {  
    String value() default "default test";  
}  
应用示例:

public class Example {  

    @Test(value = "This is a test method")  
    public void testMethod() {  
        System.out.println("Executing test method.");  
    }  
}  

(后续有遇到问题再添加)


声明:如本内容中存在错误或不准确之处,欢迎指正。转载时请注明原作者信息(麻辣香蝈蝈)。

标签:Java,自定义,油管,class,注解,annotation,ElementType,public
From: https://blog.csdn.net/m0_66070037/article/details/140992450

相关文章

  • Java的单例模式其实跟C的面向过程没什么区别
    这个我觉得倒也没有那么好笑,Java里面Singleton用的的确是有点多得离谱了,实际上把一个Singleton类的所有成员(包括字段和方法)都换成静态也没有什么不可以的,用Singleton主要是这样几个优点:1、Singleton类可以用接口和继承,static不行2、因此,Singleton类稍微保留了一点多态能力,例如可以......
  • [Java基础]Java8新特性
    Interfaceinterface的设计初衷是面向抽象,提高扩展性。这也留有一点遗憾,Interface修改的时候,实现它的类也必须跟着改。为了解决接口的修改与现有的实现不兼容的问题。新interface的方法可以用default或static修饰,这样就可以有方法体,实现类也不必重写此方法。一个interf......
  • 保存/加载自定义 tf.keras.Model 时出现问题
    我正在构建一个作为自定义tf.keras.Model实现的自动编码器。虽然训练后的模型表现良好,但我无法正确保存并重新加载它。我已经尝试过model.save()方法和save_weights()但在这两种情况下,模型完全无法执行其任务。此自动编码器正在调用另外两个tf.keras.Model,即编码器和......
  • JavaScript中的异步编程:Promise、async 和 await
    JavaScript中的异步编程:Promise、async和await在JavaScript中,Promise、async和await是处理异步操作的关键技术。这些技术允许开发者以更清晰、更可维护的方式编写异步代码,特别是在面对复杂的异步逻辑时。下面我会详细解释每个概念并展示它们是如何协同工作的。Prom......
  • 通过go自定义alertmanager 发送通知的webhook
    本文主要是大体介绍webhook的代码以及涉及到的服务部署,详细配置需要自己弄Prometheus、alertmanager部署先创建alertmanager、Prometheus的docker-composeyaml文件,下面只是把服务运行起来,具体功能需要自己配置,如果有就跳过version:'3'services:prometheus:ima......
  • [Java基础]包装类
    为什么需要包装类Java中的包装类是为了解决基本数据类型(如int、char、boolean等)和对象之间的转换问题而引入的。基本数据类型是Java语言中的基础类型,它们不是对象,不能直接参与面向对象编程的特性,如方法调用、继承和多态等。然而,在某些情况下,我们需要将基本数据类型作为对象来处理......
  • Java实现字符串中字符出现次数统计
    在编程过程中,我们经常需要对字符串进行处理。今天,我将为大家分享一个Java示例,用于统计字符串中每个字符出现的次数。让我们一起来看看吧!在日常生活中,我们经常会遇到需要统计字符串中字符出现次数的场景。例如,统计一篇文章中各个字母的出现次数,以便进行词频分析。本文将带大家......
  • Java面试题及答案(就业教程)
    最新常见Java开发面试题、面试常问Java面试题整理(附白话答案)一、Java基础部分面试题1.Java面向对象的三个特征封装:对象只需要选择性的对外公开一些属性和行为。继承:子对象可以继承父对象的属性和行为,并且可以在其之上进行修改以适合更特殊的场景需求。多态:允许不同类的对象......
  • java笔记6
    10.多态多态的概念多态(Polymorphism)是面向对象编程的核心概念之一,它指的是同一个接口可以被多个不同的类实现,或者同一个操作作用于不同的对象时可以有不同的解释和行为。为何要用多态多态的使用使得代码更加灵活和可扩展,它允许编写的代码可以对不同类型的对象执行不同的操作。......
  • 高频Java面试题集锦(含答案)
    第一章-Java篇1、Object中有哪些方法   难度系数:⭐protectedObjectclone()--->创建并返回此对象的一个副本。booleanequals(Objectobj)--->指示某个其他对象是否与此对象“相等protectedvoidfinalize()--->当垃圾回收器确定不存在对该对象的更多引用时,由对象的垃圾......