java如何自定义注解

一、什么是注解?

注解是一种能被添加到java源代码中的元数据,方法、类、参数和包都可以用注解来修饰。注解可以看作是一种特殊的标记,可以用在方法、类、参数和包上,程序在编译或者运行时可以检测到这些标记而进行一些特殊的处理。


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

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

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

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

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

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

@Retention:表明该注解的生命周期
@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属性值会报错。

在这里插入图片描述

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

YD_1989

分享不易,非常感谢您的鼓励支持

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值