java中实现自定义注解方式

 更新时间:2024年11月04日 14:40:13   作者:YD_1989  
注解是Java中的一种元数据,可以修饰方法、类、参数和包等,自定义注解需要public修饰符、@interface关键字,以及注解名称和类型元素,元注解如@Target、@Retention等用于修饰注解,指定注解的适用范围和生命周期,自定义注解的使用涉及到通过反射解析注解

一、什么是注解?

注解是一种能被添加到java源代码中的元数据,方法、类、参数和包都可以用注解来修饰。

注解可以看作是一种特殊的标记,可以用在方法、类、参数和包上,程序在编译或者运行时可以检测到这些标记而进行一些特殊的处理。

二、自定义注解需要的基本元素

自定义注解需要用到的东西:

  • 修饰符:访问修饰符必须为public,不写默认为pubic;
  • 关键字:关键字为@interface
  • 注解名称: 注解名称为自定义注解的名称,使用时还会用到;
  • 注解类型元素: 注解类型元素是注解中内容,可以理解成自定义接口的实现部分
public @interface Info {
    String value() default "tracy";
    boolean isDelete();
}

三、自定义注解用到的元注解

JDK中有一些元注解,主要有@Target@Retention,@Document,@Inherited用来修饰注解。

  • @Target:表明该注解可以应用的java元素类型

  • @Retention:表明该注解的生命周期

  • @Document:表明该注解标记的元素可以被Javadoc 或类似的工具文档化
  • @Inherited:表明使用了@Inherited注解的注解,所标记的类的子类也会拥有这个注解
@Target({ElementType.FIELD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Info {
      String value() default "tracy";
      boolean isDelete();
}

四、自定义注解的使用

定义一个People类:

@Data
@Builder
@Define(isDelete = true)
public class People {

    /**
     * 姓名
     */
    private String name;

    /**
     * 年龄
     */
    private int age;

    /**
     * 是否有效
     */
    private boolean isDelete;

}

自定义注解:

import java.lang.annotation.*;

@Target({ElementType.FIELD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Define {

    String value() default "tracy";
    boolean isDelete();
}

利用反射解析注解

public static void main(String[] args) {

        try {
            //获取Person的Class对象
            People person = People.builder().build();
            Class clazz = person.getClass();
            //判断person对象上是否有Info注解
            if (clazz.isAnnotationPresent(Define.class)) {
                System.out.println("People类上配置了Define注解!");
                //获取该对象上Info类型的注解
                Define infoAnno = (Define) clazz.getAnnotation(Define.class);
                System.out.println("person.name :" + infoAnno.value() + ",person.isDelete:" + infoAnno.isDelete());
            } else {
                System.out.println("People类上没有配置Define注解!");
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

打印结果:

People类上配置了Define注解!

person.name :tracy,person.isDelete:true

对于一个类或者接口来说,Class类(java.lang包下)中提供了一些方法用于反射注解,当然对于字段、方法来说反射注解的方式很类似。

//返回指定的注解
getAnnotation
//判断当前元素是否被指定注解修饰
isAnnotationPresent
//返回所有的注解
getAnnotations

使用注解注意点:

自定义注解中,设置了默认值的属性在使用时可以不用定义值,但是没被设置默认值的属性使用时一定要定义属性值。

示例:

如上图,isTest注解没有设置默认值,使用Log注解没定义isTest属性值会报错。

总结

以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • springboot2.0 配置时间格式化不生效问题的解决

    springboot2.0 配置时间格式化不生效问题的解决

    这篇文章主要介绍了springboot2.0 配置时间格式化不生效问题的解决,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-09-09
  • 解决Netty解码http请求获取URL乱码问题

    解决Netty解码http请求获取URL乱码问题

    这篇文章主要介绍了解决Netty解码http请求获取URL乱码问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-06-06
  • Spring中七种事务传播机制详解

    Spring中七种事务传播机制详解

    这篇文章主要介绍了Spring中七种事务传播机制详解,Spring在TransactionDefinition接口中规定了7种类型的事务传播行为,Propagation枚举则引用了这些类型,开发过程中我们一般直接用Propagation枚举,需要的朋友可以参考下
    2024-01-01
  • Java8的default方法详细介绍

    Java8的default方法详细介绍

    这篇文章主要介绍了Java8的default方法,详细介绍了什么是default方法,在多继承时的处理等,需要的朋友可以参考下
    2014-04-04
  • IDEA教程创建SpringBoot前后端分离项目示例图解

    IDEA教程创建SpringBoot前后端分离项目示例图解

    在使用spring、mybatis等框架时,配置文件很复杂,有时复杂的让人想放弃Java,使用C#。springboot出现这一切问题就都不是问题
    2021-10-10
  • RocketMQ线程池创建实现原理详解

    RocketMQ线程池创建实现原理详解

    这篇文章主要为大家介绍了RocketMQ线程池创建实现原理详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-12-12
  • SpringBoot3整合mybatis-plus的实现

    SpringBoot3整合mybatis-plus的实现

    MyBatis-Plus是一个MyBatis的增强工具,在MyBatis的基础上只做增强不做改变,本文主要介绍了Mybatis-Plus3.x的具体使用,具有一定的参考价值,感兴趣的可以了解一下
    2023-10-10
  • springboot整合 xxl-job及使用步骤

    springboot整合 xxl-job及使用步骤

    XXL-JOB是一个分布式任务调度平台,用于解决分布式系统中的任务调度和管理问题,文章详细介绍了XXL-JOB的架构,包括调度中心、执行器和Web管理控制台,并提供了使用步骤,包括下载、配置、启动和创建执行器和任务,感兴趣的朋友一起看看吧
    2025-01-01
  • Java线程中的interrupt详解

    Java线程中的interrupt详解

    这篇文章主要介绍了Java线程中的interrupt详解,interrupt翻译成中文为“打断”的意思,但实际上,interrupt()方法并非将一个线程打中断的意思,本文提供了部分实现代码,需要的朋友可以参考下
    2023-09-09
  • Java几个重要的关键字详析

    Java几个重要的关键字详析

    这篇文章主要介绍了Java几个重要的关键字详析,文章围绕主题展开详细的内容介绍,具有一定的参考一下,需要的小伙伴可以参考一下,希望对你的学习有所帮助
    2022-07-07

最新评论