Java自定义注解


学习注解，一是为了更好的理解和使用别人定义好的注解，二是自己自定义注解。下面将介绍如何自定义一个注解以及自定义注解的注意事项：

自定义注解时，需要使用@interface关键字，它将自动继承java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。

定义注解格式：

public @interface 注解名 {定义体}

注解参数的可支持数据类型：

　　　　1.所有基本数据类型（int,float,boolean,byte,double,char,long,short)
　　　　2.String类型
　　　　3.Class类型
　　　　4.enum类型
　　　　5.Annotation类型
　　　　6.以上所有类型的数组

  示例：

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;

/** 
 *
 * @author qxl
 * @date 2016年11月23日 下午1:10:53 
 * @version 1.0.0
 */

@Target(ElementType.METHOD) // 这是一个对方法的注解，还可以是包、类、变量等很多东西  
@Retention(RetentionPolicy.RUNTIME) // 保留时间，一般注解就是为了框架开发时代替配置文件使用，JVM运行时用反射取参数处理，所以一般都为RUNTIME类型  
@Documented // 用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化  
public @interface OneAnnotation {
	// 定义注解的参数，类型可以为基本类型以及String、Class、enum、数组等，default为默认值  
    String parameter1() default "";
    //只能用public或默认(default)这两个访问权修饰
    int parameter2() default -1;  
    public int a() default 0;
    
    //如果只有一个参数成员,最好把参数名称设为"value"
    //当不写default值时，表示此属性为必填值，不给此属性赋值时报错
    String value() default "";
}



注解元素的默认值：

　　注解元素必须有确定的值，要么在定义注解的默认值中指定，要么在使用注解时指定，非基本类型的注解元素的值不可为null。因此, 使用空字符串或0作为默认值是一种常用的做法。这个约束使得处理器很难表现一个元素的存在或缺失的状态，因为每个注解的声明中，所有元素都存在，并且都具有相应的值，为了绕开这个约束，我们只能定义一些特殊的值，例如空字符串或者负数，一次表示某个元素不存在，在定义注解时，这已经成为一个习惯用法。



使用注解代码示例： 

/** 
 *一个用到了自定义的注解的类 
 * @author qxl
 * @date 2016年11月23日 下午1:13:04 
 * @version 1.0.0
 */
public class OneClass {  
      
    @OneAnnotation(parameter1="YES", parameter2=10000)  
    public void oneMethod () {  
    }
    
    public void test(){
    	
    }
}



测试代码： 

import java.lang.reflect.Method;

/** 
 *
 * @author qxl
 * @date 2016年11月23日 下午1:14:21 
 * @version 1.0.0
 */
public class TestThis {
	public static void main(String[] args) throws Exception {  
        // 提取到被注解的方法Method，这里用到了反射的知识  
        Method method = Class.forName("OneClass").getDeclaredMethod("oneMethod");  
        // 从Method方法中通过方法getAnnotation获得我们设置的注解  
        OneAnnotation oneAnnotation = method.getAnnotation(OneAnnotation.class);  
          
        // 得到注解的俩参数  
        System.out.println(oneAnnotation.parameter1());  
        System.out.println(oneAnnotation.parameter2());  
    }  
}

测试中用到了反射的知识，如不太懂的可以参照