Java annotation，注解

2017-01-11  本文已影响77人  朝花夕拾不起来

注解

Java编程思想中这样定义注解：注解被称为元数据，为我们在代码中添加信息提供了一种形式化的方法。使我们在稍后某个时刻非常方便的使用这些数据。
但元数据是啥意思目前还不是很理解。。。。元数据？？？
注解仅仅是一种元数据，和业务逻辑没有任何关系，所以注解定义中没有任何逻辑处理。
Java中有四种注解专门负责新注解的创建，稍后会学习。

Test.java：一个标记注解类

  • 注解的定义和接口的定义非常相似，事实上，与其他任何Java接口一样
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {
}

UseCase.java：一个简单的注解用例。

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface UseCase {
    public int id();
    public String description() default "no description";
}

上例中id和description类似方法定义，称为注解元素。编译器会对id进行类型检查，如果在注解中某个方法没有给出description的值，则该注解会使用默认值。
用例：PassWordUtils.java

public class PassWordUtils {
    @UseCase(id = 47,description = "Passwords must contain number")
    public boolean validatePassword(String password){
        return (password.matches("\\w*\\d\\w*"));
    }
    
    @UseCase(id = 48)
    public String encryptPassword(String password){
        return new StringBuilder(password).reverse().toString();
    }
    
    @UseCase(id = 49,description = "New password can not equal previoisly")
    public boolean checkForNewPassword(List<String> prePassword,String password){
        return prePassword.contains(password);
    }
}

可以看到注解中的id和description会出现在方法中注解声明后的括号里，编译时会检查。
如未在注解中定义默认值，则在使用注解时必须显示给出值，否则会报错

元注解

Java目前内置的四种元注解。元注解专门负责注解其他的注解

编写注解处理器

注解处理器就是用来读取注解的工具。Java使用反射机制来构造注解处理器。
注解处理器：UseCaseTracker.java

public class UseCaseTracker {
    public static void tracUsecases(List<Integer> useCases,Class<?> cl){
                //通过反射，得到相应类所声明的方法
        for(Method m: cl.getDeclaredMethods()){
            UseCase uc = m.getAnnotation(UseCase.class);
            if(uc != null){
                System.out.println("Found Use Case " + uc.id()
                      + "" + uc.description());
                useCases.remove(new Integer(uc.id()));
            }
        }
        for(int i : useCases){
            System.out.println("Waring: Missing use case-" + i);
        }
    }
    public static void main(String[] args) {
        List<Integer> useCases = new ArrayList<>();
        Collections.addAll(useCases, 47,48,49,50);
        tracUsecases(useCases, PassWordUtils.class);
    }
}

输出：

Found Use Case 49 New password can not equal previoisly
Found Use Case 47 Passwords must contain number
Found Use Case 48 no description
Waring: Missing use case-50

该注解处理器用到了两个反射方法getDeclaredMethod()和getAnnotation()。他们都属于AnnotatedElement接口（Class、Method、Field）都实现了该接口。getAnnotation()方法返回是定类的注解对象，在这里就是UseCase，在通过注解类定义的元素方法得到相应的元素值。

注解元素

注解元素可用的类型

注解元素必须有确认的值，或者提供默认值，或者在使用时赋值，总之不允许不赋值。
注解不能被继承

Annotation-Processing：注解处理器

注解处理器不是在运行时通过反射机制运行处理的注解，而是在编译时处理的注解。
一个特定注解的处理器以** java 源代码（或者已编译的字节码）作为输入，然后以一些文件（通常是.java文件）作为输出。那意味着什么呢？你可以生成 java 代码！这些 java 代码在生成的.java文件中。因此你不能改变已经存在的java类，例如添加一个方法**。这些生成的 java 文件跟其他手动编写的 java 源代码一样，将会被 javac 编译。

AbstractProcessor

让我们来看一下处理器的 API，所有的处理器都继承了AbstractProcessor。如下：

public class MyPocessor extends AbstractProcessor{
    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        return false;
    }
    @Override
    public Set<String> getSupportedAnnotationTypes() {
        return super.getSupportedAnnotationTypes();
    }
    @Override
    public SourceVersion getSupportedSourceVersion() {
        return super.getSupportedSourceVersion();
    }
    @Override
    public synchronized void init(ProcessingEnvironment processingEnv) {
        super.init(processingEnv);
    }
}
上一篇 下一篇

猜你喜欢

热点阅读