首页 > 代码库 > Java自定义注解

Java自定义注解

自定义注解类编写的一些规则:

1. Annotation型定义为@interface, 所有的Annotation会自动继承Java.lang.Annotation这一接口,并且不能再去继承别的类或是接口.

2. 参数成员只能用public或默认(default)这两个访问权修饰

3. 参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和String、Enum、Class、annotations等数据类型,以及这一些类型的数组.

4. 要获取类方法和字段的注解信息,必须通过Java的反射技术来获取 Annotation对象,因为你除此之外没有别的获取注解对象的方法

5. 注解也可以没有定义成员, 不过这样注解就没啥用了

 

自定义注解类时, 可以指定目标 (类、方法、字段, 构造函数等) , 注解的生命周期(运行时,class文件或者源码中有效), 是否将注解包含在javadoc中及是否允许子类继承父类中的注解, 具体如下:

1.@Target 表示该注解目标,可能的 ElemenetType 参数包括: 

ElemenetType.CONSTRUCTOR构造器声明

 ElemenetType.FIELD 域声明(包括 enum 实例)

 ElemenetType.LOCAL_VARIABLE 局部变量声明

 ElemenetType.METHOD 方法声明

 ElemenetType.PACKAGE 包声明

 ElemenetType.PARAMETER 参数声明

 ElemenetType.TYPE 类,接口(包括注解类型)或enum声明 

2.@Retention 表示该注解的生命周期,可选的 RetentionPolicy 参数包括

RetentionPolicy.SOURCE注解将被编译器丢弃

 RetentionPolicy.CLASS 注解在class文件中可用,但会被VM丢弃

 RetentionPolicy.RUNTIME VM将在运行期也保留注释,因此可以通过反射机制读取注解的信息

3.@Documented 指示将此注解包含在javadoc 中

4. @Inherited指示允许子类继承父类中的注解

 

源代码

技术分享

1 MyAnnotationClass.java

 

[java] view plain copy
 
 技术分享技术分享
  1. package com.java.annotation;  
  2.   
  3. import java.lang.annotation.ElementType;  
  4. import java.lang.annotation.Retention;  
  5. import java.lang.annotation.RetentionPolicy;  
  6. import java.lang.annotation.Target;  
  7.   
  8. /** 
  9.  * 类注解 
  10.  * */  
  11. @Retention(RetentionPolicy.RUNTIME)  
  12. @Target(ElementType.TYPE)  
  13.   
  14. public @interface MyAnnotationClass {  
  15.     public String msg();  
  16. }  

 

 

2 MyAnnotationMethod.java

 

[java] view plain copy
 
 技术分享技术分享
  1. package com.java.annotation;  
  2.   
  3. import java.lang.annotation.ElementType;  
  4. import java.lang.annotation.Retention;  
  5. import java.lang.annotation.RetentionPolicy;  
  6. import java.lang.annotation.Target;  
  7.   
  8. /** 
  9.  * 方法注解 
  10.  **/  
  11. @Retention(RetentionPolicy.RUNTIME)  
  12. @Target(ElementType.METHOD)  
  13.   
  14. public @interface MyAnnotationMethod {  
  15.     public String common();  
  16. }   

 

 

3 MyAnnotationField.java

 

[java] view plain copy
 
 技术分享技术分享
  1. package com.java.annotation;  
  2.   
  3. import java.lang.annotation.ElementType;  
  4. import java.lang.annotation.Retention;  
  5. import java.lang.annotation.RetentionPolicy;  
  6. import java.lang.annotation.Target;  
  7.   
  8. @Retention(RetentionPolicy.RUNTIME)  
  9. @Target(ElementType.FIELD)  
  10.   
  11. public @interface MyAnnotationField {  
  12.     boolean request();  
  13. }  

 

 

4 MyAnnotationDemo.java

 

[java] view plain copy
 
 技术分享技术分享
  1. package com.java.annotation;  
  2.   
  3. @MyAnnotationClass(msg = "这是一个类注解")  
  4.   
  5. public class MyAnnotationDemo {  
  6.     public MyAnnotationDemo() {  
  7.     }  
  8.   
  9.     public MyAnnotationDemo(String text) {  
  10.         this.text = text;  
  11.     }  
  12.   
  13.     @MyAnnotationMethod(common = "这是一个方法注解")  
  14.   
  15.     public void method() {  
  16.     }  
  17.   
  18.     @MyAnnotationField(request = true)  
  19.   
  20.     private String text;  
  21. }  

 

 

5 MyAnnotationTest.java

 

[java] view plain copy
 
 技术分享技术分享
  1. package com.java.annotation;  
  2.   
  3. import java.lang.reflect.Field;  
  4. import java.lang.reflect.Method;  
  5.   
  6. public class MyAnnotationTest {  
  7.     public static void main(String[] args) {  
  8.         MyAnnotationDemo demo = new MyAnnotationDemo("hello rollen");  
  9.         MyAnnotationClass annotationClass = demo.getClass().getAnnotation(MyAnnotationClass.class);  
  10.         System.out.println(annotationClass.msg());  
  11.           
  12.         Method method = null;  
  13.         try {  
  14.             method = demo.getClass().getMethod("method",new Class[0]);  
  15.         } catch (SecurityException e) {  
  16.             e.printStackTrace();  
  17.         } catch (NoSuchMethodException e) {  
  18.             e.printStackTrace();  
  19.         }  
  20.         MyAnnotationMethod annotationMethod = method.getAnnotation(MyAnnotationMethod.class);  
  21.         System.out.println(annotationMethod.common());  
  22.           
  23.         Field field = null;  
  24.         try {  
  25.             field = demo.getClass().getDeclaredField("text");  
  26.         } catch (SecurityException e) {  
  27.             e.printStackTrace();  
  28.         } catch (NoSuchFieldException e) {  
  29.             e.printStackTrace();  
  30.         }  
  31.         MyAnnotationField annotationField = field.getAnnotation(MyAnnotationField.class);  
  32.         System.out.println(annotationField.request());  
  33.     }  
  34. }  

 

 

运行结果

技术分享

 

下载地址:

CSDN:http://download.csdn.net/detail/haishu_zheng/9569169

Github:https://github.com/zhenghaishu/AnnotationDemo

Java自定义注解