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