java中实现自定义注解方式

目录

• 一、什么是注解？
• 二、自定义注解需要的基本元素
• 三、自定义注解用到的元注解
• 四、自定义注解的使用
• 总结

一、什么是注解？

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

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

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

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

• 修饰符：访问修饰符必须为public,不写默认为pubic；
• 关键字：关键字为@interface；
• 注解名称： 注解名称为自定义注解的名称，使用时还会用到；
• 注解类型元素： 注解类型元素是注解中内容，可以理解成自定义接口的实现部分；

public @interface Info {
    String value() default "tracy";
    boolean isDelete();
}

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

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

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

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

• @Document：表明该注解标记的元素可以被Javadoc 或类js似的工php具文档化
• @Inherited：表明使用了@Inherited注解的注解，所标记的类的子类也会拥有这个注解

@Target({ElementType.FIELD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Info {
      St编程客栈ring 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 staticjavascript 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);
                S编程客栈ystem.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属性值会报错。

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持编程客栈(www.devze.com)。