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属性值会报错。

总结

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

相关文章

  • 基于JDK动态代理原理解析

    基于JDK动态代理原理解析

    这篇文章主要介绍了基于JDK动态代理原理解析,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-05-05
  • SpringBoot整合SpringDataRedis的示例代码

    SpringBoot整合SpringDataRedis的示例代码

    这篇文章主要介绍了SpringBoot整合SpringDataRedis的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-05-05
  • 使用spring框架实现数据库事务处理方式

    使用spring框架实现数据库事务处理方式

    这篇文章主要介绍了使用spring框架实现数据库事务处理方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-10-10
  • springboot实现自动邮件发送任务详解

    springboot实现自动邮件发送任务详解

    这篇文章主要介绍了Springboot中的邮件任务,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2022-04-04
  • Java下载文件的四种方式详细代码

    Java下载文件的四种方式详细代码

    这篇文章介绍了Java下载文件的四种方式,文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-12-12
  • 详解springboot通过Async注解实现异步任务及回调的方法

    详解springboot通过Async注解实现异步任务及回调的方法

    这篇文章主要介绍了springboot通过Async注解实现异步任务及回调,文中通过一个简单示例来直观的理解什么是同步调用,在单元测试用例中,注入 SyncTask 对象,并在测试用例中执行 doTaskOne(),doTaskTwo(),doTaskThree() 三个方法,具体实现方式跟随小编一起看看吧
    2022-05-05
  • SpringMVC运行时出现404错误的解决办法汇总(基本包含所有错误可能)

    SpringMVC运行时出现404错误的解决办法汇总(基本包含所有错误可能)

    初学SpringMVC基本都会碰到404问题(确实也困扰了我好长时间),但出现404问题的原因有很多,如果确认路径,代码没问题,并且服务器可以正常启动,依然出现404问题的话,就根据本篇步骤逐一排查,需要的朋友可以参考下
    2024-04-04
  • Java中stream是什么及如何使用

    Java中stream是什么及如何使用

    在Java中,Stream(流)是一种用于操作集合(Collection)、数组等数据源的API,Stream的主要作用是进行数据的转换、筛选、聚合等操作,可以极大地简化对数据的处理,本文给大家介绍Java中stream是什么?有什么作用?如何使用?感兴趣的朋友一起看看吧
    2023-10-10
  • Java实现批量导入excel表格数据到数据库中的方法

    Java实现批量导入excel表格数据到数据库中的方法

    这篇文章主要介绍了Java实现批量导入excel表格数据到数据库中的方法,结合实例形式详细分析了java导入Excel数据到数据库的具体步骤与相关操作技巧,需要的朋友可以参考下
    2017-10-10
  • Spring中@RequestMapping、@RestController和Postman

    Spring中@RequestMapping、@RestController和Postman

    本文介绍了Spring框架中常用的@RequestMapping和@RestController注解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-10-10

最新评论