java自定义注解实现「建议收藏」

大家好，又见面了，我是你们的朋友全栈君。

引言

去杭州第一次面试的时候问及到自定义注解，那时候不清楚，现在简单写下，算是对过去的一个交代。

自定义注解

关于注解的定义这里就不解释了，自定义注解的场景有很多，比如登录、权限拦截、日志、以及各种框架，下面我们就一起来了解下具体如何实现，下面直接来看java提供的四个元注解（作用：负责注释其它注解）。

1、@Target（用于描述修饰对象的范围）

范围取值于ElementType这个枚举类：

ANNOTATION_TYPE（注释类型声明）

CONSTRUCTOR(构造方法声明)

FIELD (字段声明)

LOCAL_VARIABLE(局部变量声明)

METHOD (方法声明)

PACKAGE(包声明)

PARAMETER(参数声明)

TYPE(类、接口（包括注释类型）或枚举声明)

2、@Retention（注释类型的注释要保留多久）

范围取值于RetentionPolicy这个枚举类：

CLASS 编译器将把注释记录在类文件中，但在运行时 VM 不需要保留注释

RUNTIME 编译器将把注释记录在类文件中，在运行时 VM 将保留注释，因此可以反射性地读取

SOURCE 编译器要丢弃的注释

3、@Document（进行文档转化）

4、@Inhrited(被标注的类型是被继承的)

示例：

上面的定义解释比较繁琐，下面来看看一段简单的示例代码，相信立马就可以理解了：

步骤一：定义两个自定义注解，用来修饰属性，一个标注名字，一个标注性别。

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

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Name {//名字自定义注解

    public String value() default "";
}

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

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Sex {//性别自定义注解

    public enum GenderType {
        Male("男"),
        Female("女");
        private String genderStr;
        private GenderType(String arg0) {
            this.genderStr = arg0;
        }
        @Override
        public String toString() {
            return genderStr;
        }
    }
    GenderType gender() default GenderType.Male;
}

步骤二：自定义注解标注在属性上

public class Person {

    @Name(value = "cool_summer_moon")
    public String name;
    public String age;
    @Sex(gender = Sex.GenderType.Male)
    public String sex;

    public String getName() { return name; }
    public void setName(String name) {
        this.name = name;
    }
    public String getAge() {
        return age;
    }
    public void setAge(String age) {
        this.age = age;
    }
    public String getSex() {
        return sex;
    }
    public void setSex(String sex) {
        this.sex = sex;
    }
}

步骤三：定义一个测试工具类，取刚才标注的属性值

import java.lang.reflect.Field;

public class AnnotionUtils {

    public static String getInfo(Class<?> cs){
        String result = "";
        Field[] declaredFields = cs.getDeclaredFields();
        for (Field field : declaredFields){
            if(field.isAnnotationPresent(Name.class)){
                Name annotation = field.getAnnotation(Name.class);
                String value = annotation.value();
                result += (field.getName() + ":" + value + "\n");
            }
            if(field.isAnnotationPresent(Sex.class)){
                Sex annotation = field.getAnnotation(Sex.class);
                String value = annotation.gender().name();
                result += (field.getName() + ":" + value + "\n");
            }
        }
        return result;
    }

    public static void main(String[] args){
        String info = getInfo(Person.class);
        System.out.println(info);
    }
}

运行上面程序，结果如下：