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中及是否允许子类继承父类中的注解, 具体如下:

[email protected] 表示该注解目标,可能的 ElemenetType 参数包括:

ElemenetType.CONSTRUCTOR构造器声明

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

ElemenetType.LOCAL_VARIABLE 局部变量声明

ElemenetType.METHOD 方法声明

ElemenetType.PACKAGE 包声明

ElemenetType.PARAMETER 参数声明

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

[email protected] 表示该注解的生命周期,可选的 RetentionPolicy 参数包括

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

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

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

[email protected] 指示将此注解包含在javadoc 中

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

源代码

1 MyAnnotationClass.java

[java] view plain copy

1. package com.java.annotation;
2. import java.lang.annotation.ElementType;
3. import java.lang.annotation.Retention;
4. import java.lang.annotation.RetentionPolicy;
5. import java.lang.annotation.Target;
6. /**
7. * 类注解
8. * */
9. @Retention(RetentionPolicy.RUNTIME)
10. @Target(ElementType.TYPE)
11. public @interface MyAnnotationClass {
12. public String msg();
13. }

2 MyAnnotationMethod.java

[java] view plain copy

1. package com.java.annotation;
2. import java.lang.annotation.ElementType;
3. import java.lang.annotation.Retention;
4. import java.lang.annotation.RetentionPolicy;
5. import java.lang.annotation.Target;
6. /**
7. * 方法注解
8. **/
9. @Retention(RetentionPolicy.RUNTIME)
10. @Target(ElementType.METHOD)
11. public @interface MyAnnotationMethod {
12. public String common();
13. }

3 MyAnnotationField.java

[java] view plain copy

1. package com.java.annotation;
2. import java.lang.annotation.ElementType;
3. import java.lang.annotation.Retention;
4. import java.lang.annotation.RetentionPolicy;
5. import java.lang.annotation.Target;
6. @Retention(RetentionPolicy.RUNTIME)
7. @Target(ElementType.FIELD)
8. public @interface MyAnnotationField {
9. boolean request();
10. }

4 MyAnnotationDemo.java

[java] view plain copy

1. package com.java.annotation;
2. @MyAnnotationClass(msg = "这是一个类注解")
3. public class MyAnnotationDemo {
4. public MyAnnotationDemo() {
5. }
6. public MyAnnotationDemo(String text) {
7. this.text = text;
8. }
9. @MyAnnotationMethod(common = "这是一个方法注解")
10. public void method() {
11. }
12. @MyAnnotationField(request = true)
13. private String text;
14. }

5 MyAnnotationTest.java

[java] view plain copy

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

运行结果

下载地址：

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

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