Java自定义注解学习

1.定义一个枚举类，后面自定义注解时使用

package cn.tx.annotation.enums;
/**
 * 定义枚举类型
 * @author Administrator
 *
 */
public enum HttpMethod {

    GET,POST,PUT,INPUT,DELETE;
}

2. 自定义一个注解 AnnoTest 

package cn.tx.annotation;

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

import cn.tx.annotation.enums.HttpMethod;

/**
 * 1.自定义注解，自动实现了java.lang.Annotation接口
 * @author Administrator
 * 2.注解内部可以定义值，这里的值既不是属性，也不是方法
 * 3.语法：数据类型      值的名字();
 * 4.注解的意义：当非标识性注解(内部有值的注解)标注在方法上时，当方法被反射调用时，注解才有意义
 * 5.@Retention 注解
 * @Retention(RetentionPolicy.RUNTIME)
 * @Target(ElementType.ANNOTATION_TYPE) public @interface Retention {
 *                                      RetentionPolicy value(); }
 *                                      RetentionPolicy:注解的策略
 * RetentionPolicy.CLASS 表示这个注解能被编译到class文件里，但是运行时不参与运行
 * 6.@Target注解——指示注解类型所适用的程序元素的种类
 * @Documented
    @Retention(RetentionPolicy.RUNTIME)
    @Target(ElementType.ANNOTATION_TYPE)
    public @interface Target {
    ElementType[] value();
    ElementType是一个枚举类型
    }
 *  7. @Target @Retention 只能用在注解的定义上面
 *  8.@Documented 指明该注解将被包含在javadoc中  
 */

//ElementType.METHOD,表示AnnoTest只能放在方法上面，不能放在类，属性等其他上面
@Target(value = { ElementType.METHOD,ElementType.TYPE })  
@Retention(value = RetentionPolicy.RUNTIME)
public @interface AnnoTest {

    String value();//这里定义了值，在使用注解的地方，就得加上这个值
    
//    Class[]/*String[]*/ location();

//    HttpMethod method();
        
}


// enum ElementType {
//    /**类，接口，枚举声明 Class, interface (including annotation type), or enum declaration */
//    TYPE,
//    /**字段声明，包括枚举常量   Field declaration (includes enum constants) */
//    FIELD,
//    /**方法声明   Method declaration */
//    METHOD,
//    /** Parameter declaration */
//    PARAMETER,
//    /** 构造方法声明  Constructor declaration */
//    CONSTRUCTOR,
//    /**局部变量声明  Local variable declaration */
//    LOCAL_VARIABLE,
//    /**注解类型声明   Annotation type declaration */
//    ANNOTATION_TYPE,
//    /**包声明    Package declaration */
//    PACKAGE
//}

3.  定义一个Claculate类，对方法使用自定义注解（前提是AnnoTest 注解 设置的@Target(value = { ElementType.METHOD,ElementType.TYPE })  ，也就是该注解能被使用在方法上面。）

package cn.tx.annotation.test;

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

import cn.tx.annotation.AnnoTest;

public class Caculate {
//    @AnnoTest(value = "sss") 
    //AnnoTest注解中定义了@Target(value = { ElementType.METHOD,ElementType.TYPE }) 
    //如果在属性a上面加@AnnoTest注解，会报：The annotation @AnnoTest is disallowed for this location
    private int a;

    @AnnoTest(value = "相加的结果是：")
    public int add(int a,int b){
        return a+b;
}

}

4. junit测试类:

package cn.tx.annotation.test;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.List;

import cn.tx.annotation.AnnoTest;
import cn.tx.annotation.enums.HttpMethod;

/**
 * 常用的表标识性注解：@Test @Override @SuppressWarnings
 * 
 * @author Administrator
 * 
 */
public class Test {

    @org.junit.Test
    public void test() {

    }

    // @AnnoTest(value = "tst")
    @Deprecated
    // 过时，不建议使用的注解
    public void method() {

    }

    /**
     * @SuppressWarnings压制警告的注解 unchecked 不检查操作时的警告 rawtypes
     *                          原始类型，也就是不使用泛型，在定义的时候压制泛型的警告
     */
    @SuppressWarnings( { "unchecked", "rawtypes" })
    public void method1() {
        @SuppressWarnings("unused")
        List list = new ArrayList();// 不写泛型类型时，会出现黄色波浪线警告！
        list.add("lisi");
    }

    @org.junit.Test
//    @AnnoTest(value = "test", location = { String.class }, method = HttpMethod.GET)
    // 非标识性注解的意义在于方法被反射调用时
    public void method3() {

    }

    @org.junit.Test
    public void testEnum() {
        System.out.println(HttpMethod.GET); //执行该方法，控制台打印GET
    }
    
    @org.junit.Test
    public void testAdd(){
        new Caculate().add(3, 5); //正常调用，add方法上面的注解不会起作用
    }

    @org.junit.Test
    public void testAdd1(){
        //获取Caculate类的Class对象，进而获得一个实例，然后获取声明的方法及方法上的注解
        Class<?> clazz = Caculate.class; 
        try {
            Object obj = clazz.newInstance();
            //getFields()只能获取public的字段，包括父类的。getDeclaredFields()只能获取自己声明的各种字段，包括public，protected，private。
            Method method = clazz.getDeclaredMethod("add", int.class,int.class);
            //判断一个方法上面是否存在某个注解
            boolean isPres = method.isAnnotationPresent(AnnoTest.class);
            if(isPres){
                //根据一个类获取注解 ,即获得@AnnoTest
                AnnoTest annotation = method.getAnnotation(AnnoTest.class);
                //获得注解上的值
                String value = annotation.value(); //
                //反射的方式调用add()方法
                Object result = method.invoke(obj, 2,3);
                System.out.println(value+result); //控制台输出结果为： 相加的结果是：5
                //如果注解上的@Retention(value = RetentionPolicy.SOURCE),运行时时不会有结果的
            }
            
        } catch (Exception e) {
            e.printStackTrace();
        }
        
    }

}