自定义注解

Java自定义注解

Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能。

注解不会也不能影响代码的实际逻辑，仅仅起到辅助性的作用。包含在 java.lang.annotation 包中。

1、元注解

元注解是指注解的注解。包括 @Retention @Target @Document @Inherited四种。

1.1、@Retention: 定义注解的保留策略

Java代码

1. @Retention(RetentionPolicy.SOURCE) //注解仅存在于源码中，在class字节码文件中不包含
2. @Retention(RetentionPolicy.CLASS) // 默认的保留策略，注解会在class字节码文件中存在，但运行时无法获得，
3. @Retention(RetentionPolicy.RUNTIME) // 注解会在class字节码文件中存在，在运行时可以通过反射获取到

@Retention(RetentionPolicy.SOURCE)   //注解仅存在于源码中，在class字节码文件中不包含@Retention(RetentionPolicy.CLASS)     // 默认的保留策略，注解会在class字节码文件中存在，但运行时无法获得，@Retention(RetentionPolicy.RUNTIME)  // 注解会在class字节码文件中存在，在运行时可以通过反射获取到

1.2、@Target：定义注解的作用目标

Java代码

1. @Documented
2. @Retention(RetentionPolicy.RUNTIME)
3. @Target(ElementType.ANNOTATION_TYPE)
4. public @interface Target {
5. ElementType[] value();
6. }
7. @Target(ElementType.TYPE) //接口、类、枚举、注解
8. @Target(ElementType.FIELD) //字段、枚举的常量
9. @Target(ElementType.METHOD) //方法
10. @Target(ElementType.PARAMETER) //方法参数
11. @Target(ElementType.CONSTRUCTOR) //构造函数
12. @Target(ElementType.LOCAL_VARIABLE)//局部变量
13. @Target(ElementType.ANNOTATION_TYPE)//注解
14. @Target(ElementType.PACKAGE) ///包

 @Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.ANNOTATION_TYPE) public @interface Target {     ElementType[] value(); }@Target(ElementType.TYPE)   //接口、类、枚举、注解@Target(ElementType.FIELD) //字段、枚举的常量@Target(ElementType.METHOD) //方法@Target(ElementType.PARAMETER) //方法参数@Target(ElementType.CONSTRUCTOR)  //构造函数@Target(ElementType.LOCAL_VARIABLE)//局部变量@Target(ElementType.ANNOTATION_TYPE)//注解@Target(ElementType.PACKAGE) ///包 

由以上的源码可以知道，他的elementType 可以有多个，一个注解可以为类的，方法的，字段的等等

1.3、@Document：说明该注解将被包含在javadoc中

1.4、@Inherited：说明子类可以继承父类中的该注解

@Retention(RetentionPolicy.RUNTIME)

定义的这个注解是注解会在class字节码文件中存在，在运行时可以通过反射获取到。

@Target({ElementType.TYPE,ElementType.METHOD})

因此这个注解可以是类注解，也可以是方法的注解

这样一个注解就自定义好了，当然注解里面的成员可以为基本的数据类型，也可以为数据，Object等等

3 解析注解

Java代码

1. public class UseCaseTracker {
2. public static void trackUseCases(List<Integer> list, Class<?>cl) {
3. for (Method m : cl.getDeclaredMethods()) {
4. UseCase us = m.getAnnotation(UseCase.class);
5. if (us != null) {
6. System.out.println("Found UseCase:" + us.id() + " "
7. + us.description());
8. }
9. }
10. }
11. }  

public class UseCaseTracker {    public static void trackUseCases(List<Integer> list, Class<?>cl) {       for (Method m : cl.getDeclaredMethods()) {           UseCase us = m.getAnnotation(UseCase.class);           if (us != null) {              System.out.println("Found UseCase:" + us.id() + " "                     + us.description());           }       }    }}