美文网首页
Java annotation,注解

Java annotation,注解

作者: 朝花夕拾不起来 | 来源:发表于2017-01-11 17:13 被阅读77次

注解

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

Test.java:一个标记注解类

  • 注解的定义和接口的定义非常相似,事实上,与其他任何Java接口一样
  • 注解也会编译成class文件。注解和接口最明显的区别是在@符号上,即注解定义时为@interface,接口为interface
  • 定义注解时,需要一些元注解的修饰。如@Target、@Retention
  • 一般注解都会包含某些元素以表示某些值,注解的元素看起来就像接口的方法。唯一的区别就是可以为其制定默认值。
  • 没有元素的注解叫做标记注解,就像本例中的Test注解
  • @Target用来定义你将注解用在什么地方,可以在类、方法、变量、参数、包中使用
  • @Rectetion用来定义该注解在哪一个级别可用(源代码SOURCE、类文件CLASS、或者运行时RUNTIME)
@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目前内置的四种元注解。元注解专门负责注解其他的注解

  • Target:表示该注解能用在什么地方。可能的ElementType参数包括:
  • CONSTRUCTOR:构造器声明
  • FIELD:域声明
  • LOCAL_VARIABLE:局部变量声明
  • METHOD:方法声明
  • PACKAGE:包声明
  • PARAMETER:参数声明
  • TYPE:类、接口或enum声明
  • Retention:表示在什么级别保存该信息。可选的RetentionPolicy包括
  • SOURCE:注解将被编译器丢弃
  • CLASS:注解在class文件中可用,但会被VM丢弃。
  • RUNTIME:VM将在运行期间也保留注解,因此可以通过反射机制读取注解的信息。
  • Documented:将此注解保存在javadoc中
  • Inherited:允许子类继承父类中的注解。

编写注解处理器

注解处理器就是用来读取注解的工具。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,在通过注解类定义的元素方法得到相应的元素值。

注解元素

注解元素可用的类型

  • 所有基本类型(int、float、boolean等)
  • String
  • Class
  • enum
  • Annotation
  • 以上所有类型的数组

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

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);
    }
}
  • init(ProcessingEnvironment processingEnv):所有的注解处理器类都必须有一个无参构造函数。然而,有一个特殊的方法init(),它会被注解处理工具调用,以ProcessingEnvironment作为参数。ProcessingEnvironment 提供了一些实用的工具类Elements, Types和Filer我们在后面将会使用到它们。

  • process(Set<? extends TypeElement> annoations, RoundEnvironment env):这类似于每个处理器的main()方法。你可以在这个方法里面编码实现扫描,处理注解,生成 java 文件。使用RoundEnvironment参数,你可以查询被特定注解标注的元素(原文:you can query for elements annotated with a certain annotation )。后面我们将会看到详细内容。

  • getSupportedAnnotationTypes():在这个方法里面你必须指定哪些注解应该被注解处理器注册。注意,它的返回值是一个String集合,包含了你的注解处理器想要处理的注解类型的全称。换句话说,你在这里定义你的注解处理器要处理哪些注解。

  • getSupportedSourceVersion(): 用来指定你使用的 java 版本。通常你应该返回SourceVersion.latestSupported()不过,如果你有足够的理由坚持用 java 6 的话,你也可以返回SourceVersion.RELEASE_6 我建议使用SourceVersion.latestSupported()在 Java 7 中,你也可以使用注解的方式来替代重写

相关文章

网友评论

      本文标题:Java annotation,注解

      本文链接:https://www.haomeiwen.com/subject/aynlbttx.html