Java自定义注解

1.四个元注解解释

@Target 表示作用的范围

@Retention 表示生命周期范围

@Documented 表示注解能被javadoc解析，默认注解是不被javadoc解析的

@Inherited 表示被注解的类的子类能继承该注解。

2.获取注解的方法（案例用了三个注解，更多注解百度查看API）

判断对象是否有这个注解isAnnotationPresent(Class<? extends Annotation> annotationClass)
获取对象的指定注解 getDeclaredAnnotation(Class<A> annotationClass)
获取对象所有的注解 getDeclaredAnnotations()

案例一：熟悉@Target、@Retention和上面三个方法

package com.jtfr.demo1;

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

/**
 * 学生名字注解
 * @author 陈康明 qq：1123181523
 * @date 2019年2月27日
 */
// @Target 表示注解使用的位置(类、字段等区分)
// TYPE 表示作用在 类、接口、注解、enum 上
@Target(ElementType.TYPE)
// @Retention 表示注解生命周期
// RUNTIME 表示在运行时期还有用，可以用于获取注解的值，同时RUNTIME也是生命周期最长的一个。
@Retention(RetentionPolicy.RUNTIME)
public @interface StudentName {
    /**
     * 给了 default 值，注解上去的时候，可以不需要写值了。
     * @return
     */
    String name() default "";
}

package com.jtfr.demo1;

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

/**
 * 学生性别注解
 * @author 陈康明 qq：1123181523
 * @date 2019年2月27日
 */
//@Target 表示注解使用的位置(类、字段等区分)
//TYPE 表示作用在 类、接口、注解、enum 上
@Target(ElementType.TYPE)
//@Retention 表示注解生命周期
//RUNTIME 表示在运行时期还有用，可以用于获取注解的值，同时RUNTIME也是生命周期最长的一个
@Retention(RetentionPolicy.RUNTIME)
public @interface StudentSex {
    /**
     * 性别只有 男、女、不知道 三种情况，所以用 enum 类型。
     */
    public enum Sex{MAN, WOMAN, KNOW};
    /**
     * 给了 default 值，注解上去的时候，可以不需要写值了。
     * @return
     */
    Sex sex() default Sex.KNOW;
    
}

package com.jtfr.demo1;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
/**
 * 老师信息注解
 * @author 陈康明 qq：1123181523
 * @date 2019年2月27日
 */
//@Target 表示注解使用的位置(类、字段等区分)
//FIELD 表示作用 字段 上
@Target(ElementType.FIELD)
//@Retention 表示注解生命周期
//RUNTIME 表示在运行时期还有用，可以用于获取注解的值，同时RUNTIME也是生命周期最长的一个
@Retention(RetentionPolicy.RUNTIME)
public @interface TeacherInfo {

    /**
     * 课程科目假设就两个，语文和数学 ，这样明确的个数用枚举表示。
     * @return
     */
    public enum Course{LANGUAGE, MATHEMATICS};
    Course course() default Course.LANGUAGE;
    
    /**
     * 老师年龄, 一般默认值，字符串用"", 数字用 -1 这样表示默认值，没有写
     */
    int age() default -1;
}

package com.jtfr.demo1;

import com.jtfr.demo1.StudentSex.Sex;
import com.jtfr.demo1.TeacherInfo.Course;

@StudentName(name="钧天府人")
@StudentSex(sex=Sex.MAN)
public class Student {

    @TeacherInfo(course=Course.LANGUAGE, age=18)
    private String teacher;
}

package com.jtfr.demo1;

import java.lang.annotation.Annotation;
import java.lang.reflect.Field;

/**
 * 测试 注解 效果
 * @author 陈康明 qq：1123181523
 * @date 2019年2月27日
 */
public class StudentTest {

    public static void main(String[] args) throws Exception{
        Class<Student> cls = Student.class;
        // 判断类上是否有这个注解 isAnnotationPresent(Class<? extends Annotation> annotationClass)
        if (cls.isAnnotationPresent(StudentName.class)) {
            System.out.println("包含 StudentName 注解");
            // 获取类上的指定注解 getDeclaredAnnotation(Class<A> annotationClass)
            StudentName studentName = (StudentName) cls.getDeclaredAnnotation(StudentName.class);
            System.out.println("输出注解信息："+studentName);
            System.out.println("姓名: "+studentName.name());
        }
        System.out.println("---------------------------------------");
        // 获取类上所有的注解 getDeclaredAnnotations()
        Annotation[] annotations = cls.getDeclaredAnnotations();
        for (Annotation annotation : annotations) {
            System.out.println("输出注解信息："+annotation);
            // instanceof 可以直接判断 被转成 父类的变量 是否是 子类 的实例
            if (annotation instanceof StudentName) {
                System.out.println("姓名: "+((StudentName)annotation).name());
            } else if(annotation instanceof StudentSex){
                System.out.println("性别: "+((StudentSex)annotation).sex());
            }
        }
        System.out.println("---------------------------------------");
        Field field = cls.getDeclaredField("teacher");
        // 判断 字段 上是否有这个注解isAnnotationPresent(Class<? extends Annotation> annotationClass)
        if (field.isAnnotationPresent(TeacherInfo.class)) {
            System.out.println("包含 TeacherInfo 注解");
            // 字段获取指定注解 和 上面一样 getDeclaredAnnotation(Class<A> annotationClass)
            TeacherInfo teacherInfo = field.getDeclaredAnnotation(TeacherInfo.class);
            System.out.println("输出注解信息："+teacherInfo);
            System.out.println("课程: "+teacherInfo.course());
            System.out.println("年龄: "+teacherInfo.age());
        }
        System.out.println("---------------------------------------");
        // 获取 字段 上所有的注解 和 上面一样 获取类上所有的注解 getDeclaredAnnotations()
        Annotation[] declaredAnnotations = field.getDeclaredAnnotations();
        for (Annotation annotation : declaredAnnotations) {
            // 知道这里只有一个 注解 那就判断一次就好了
            if (annotation instanceof TeacherInfo) {
                TeacherInfo t = (TeacherInfo)annotation;
                System.out.println("直接输出注解信息："+t);
                System.out.println("课程: "+t.course());
                System.out.println("年龄: "+t.age());
            }
        }
    }
}

执行输出结果

案例二：@Inherited的使用

package com.jtfr.demo2;

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

// @Target 表示注解使用的位置(类、字段等区分)
// TYPE 表示作用在 类、接口、注解、enum 上
@Target(ElementType.TYPE)
// @Retention 表示注解生命周期
// RUNTIME 表示在运行时期还有用，可以用于获取注解的值，同时 RUNTIME 也是生命周期最长的一个。
@Retention(RetentionPolicy.RUNTIME)
// @Documented 表示注解能被 javadoc 解析，默认注解是不被 javadoc 解析的
@Documented
// @Inherited 表示被注解的类的子类能继承该注解。
@Inherited // 如果注释了 B 就获取不到 注解了。 可以自己注释测试看一下结果
public @interface InheritedTest {

    String value() default "";
}

package com.jtfr.demo2;

@InheritedTest("可以被子类获取到")
public class A {

}

package com.jtfr.demo2;

public class B extends A {

}

package com.jtfr.demo2;

/**
 * 测试 @Inherited 注解效果
 * @author 陈康明 qq：1123181523
 * @date 2019年2月27日
 */
public class MainTest {

    public static void main(String[] args) {
        Class<B> cls = B.class;
        if (cls.isAnnotationPresent(InheritedTest.class)) {
            System.out.println("获取到了父类上的注解");
            System.out.println(cls.getAnnotation(InheritedTest.class).value());
        }
    }
}

执行输出结果

3.组合注解，未完待续......

源码

 https://files.cnblogs.com/files/jtfr/AnnotationDemo.rar