Java注解（Annotation)

最新推荐文章于 2023-09-12 09:57:57 发布

不能止步

最新推荐文章于 2023-09-12 09:57:57 发布

阅读量626

点赞数

分类专栏： java 文章标签： Java 注解

本文链接：https://blog.csdn.net/l460133921/article/details/85249010

版权

java 专栏收录该内容

13 篇文章 0 订阅

订阅专栏

自从Java 5.0引入注解之后，目前几乎所有的开源框架中都用到了Java注解，其目的一是提高开发效率，二是解偶（因为注解可以避免代码方面的依赖）。但是对于什么是注解，注解是如何工作的，如何自定义的注解，如何在Jar中使能自定义的注解，我们可能并不清楚。这篇文章中我将向大家解释这些。

什么是注解

用一个词就可以描述注解，那就是元数据，即一种描述数据的数据。所以，可以说注解就是源代码的元数据。比如，下面这段代码：

@Override
public String toString() {
    return "This is String Representation of current object.";
}

/**
 *我们想override toString函数，但是并未使用@Override注解，此时编译器认为我们是新定义了一个toStrring函数，
 * 且无法发现toStrring的拼写错误
 * /
public String toStrring() {
    return "This is String Representation of current object.";
}

上面的代码中，我重写了toString()方法并使用了@Override注解。但是，即使我不使用@Override注解标记代码，程序也能够正常执行。那么，该注解表示什么？这么写有什么好处吗？事实上，@Override告诉编译器这个方法是一个重写方法(描述方法的元数据)，如果父类中不存在该方法，编译器便会报错，提示该方法没有重写父类中的方法。如果我不小心拼写错误，例如将toString()写成了toStrring(){double r}，而且我也没有使用@Override注解，那程序依然能编译运行。但运行结果会和我期望的大不相同。现在我们了解了什么是注解，并且使用注解有助于阅读程序。

Annotation是一种应用于类、方法、参数、变量、构造器及包声明中的特殊修饰符。它是一种由JSR-175标准选择用来描述元数据的一种工具。

为什么要引入注解

使用Annotation之前(甚至在使用之后)，XML被广泛的应用于描述元数据。不知何时开始一些应用开发人员和架构师发现XML的维护越来越糟糕了。>他们希望使用一些和代码紧耦合的东西，而不是像XML那样和代码是松耦合的(在某些情况下甚至是完全分离的)代码描述。如果你在Google中搜索“XML vs. annotations”，会看到许多关于这个问题的辩论。最有趣的是XML配置其实就是为了分离代码和配置而引入的。上述两种观点可能会让你很疑惑，两者观点似乎构成了一种循环，但各有利弊。下面我们通过一个例子来理解这两者的区别。

假如你想为应用设置很多的常量或参数，这种情况下，XML是一个很好的选择，因为它不会同特定的代码相连。如果你想把某个方法声明为服务，那么使用Annotation会更好一些，因为这种情况下需要注解和方法紧密耦合起来，开发人员也必须认识到这点。

另一个很重要的因素是Annotation定义了一种标准的描述元数据的方式。在这之前，开发人员通常使用他们自己的方式定义元数据。例如，使用标记interfaces，注释，transient关键字等等。每个程序员按照自己的方式定义元数据，而不像Annotation这种标准的方式。

目前，许多框架将XML和Annotation两种方式结合使用，平衡两者之间的利弊。

如何自定义注解

先来看一个已有的注解定义的例子：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

对于@Override注释你可能有些疑问，它什么都没做，那它是如何检查在父类中有一个同名的函数呢。@Override注解的定义不仅仅只有这么一点代码。这部分内容很重要，我不得不再次重复：Annotations仅仅是元数据，和业务逻辑无关。理解起来有点困难，但就是这样。如果Annotations本身不包含业务逻辑，那么必须有人来实现这些逻辑，这个事情由元数据的用户来做。Annotations仅仅提供它定义的属性(类/方法/包/域)的信息。Annotations的用户(同样是一些代码)来读取这些信息并实现必要的逻辑。

当我们使用Java的标注Annotations(例如@Override)时，JVM就是一个用户，它在字节码层面工作。到这里，应用开发人员还不能控制也不能使用自定义的注解。因此，我们讲解一下如何编写自定义的Annotations。

我们来逐个讲述编写自定义Annotations的要点。上面的例子中，你看到一些注解应用在注解上。

J2SE5.0版本在 java.lang.annotation提供了四种元注解，专门注解其他的注解：

@Documented –注解是否将包含在JavaDoc中
@Retention –什么时候使用该注解
@Target? –注解用于什么地方
@Inherited – 是否允许子类继承该注解

@Documented – 一个简单的Annotations标记注解，表示是否将注解信息添加在java文档中。

@Retention – 定义该注解的生命周期。注解的生命周期有三种，如下：

public enum RetentionPolicy {
    /**
     * Annotations are to be discarded by the compiler.
     * 在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义，所以它们不会写入字节码。
     * @Override, @SuppressWarnings都属于这类注解
     */
    SOURCE,

    /**
     * Annotations are to be recorded in the class file by the compiler
     * but need not be retained by the VM at run time.  This is the default
     * behavior.
     * 在类加载的时候丢弃。在字节码文件的处理中有用。默认使用这种方式
     */
    CLASS,

    /**
     * Annotations are to be recorded in the class file by the compiler and
     * retained by the VM at run time, so they may be read reflectively.
     * 始终不会丢弃，运行期也保留该注解，因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式
     * @see java.lang.reflect.AnnotatedElement
     */
    RUNTIME
}

@Target – 表示该注解用于什么地方。如果不明确指出，该注解可以放在任何地方。以下是一些可用的参数。需要说明的是：属性的注解是兼容的，如果你想给7个属性都添加注解，仅仅排除一个属性，那么你需要在定义target包含所有的属性。

public enum ElementType {
    /** Class, interface (including annotation type), or enum declaration
     * 用于描述类、接口或enum声明
    */
    TYPE,

    /** Field declaration (includes enum constants) */
    FIELD,

    /** Method declaration */
    METHOD,

    /** Formal parameter declaration */
    PARAMETER,

    /** Constructor declaration */
    CONSTRUCTOR,

    /** Local variable declaration */
    LOCAL_VARIABLE,

    /** Annotation type declaration 用于表示定义的注解用于另一个注解*/
    ANNOTATION_TYPE,

    /** Package declaration 用于记录java文件的package信息*/
    PACKAGE,

    /**
     * Type parameter declaration
     *
     * @since 1.8
     */
    TYPE_PARAMETER,

    /**
     * Use of a type
     *
     * @since 1.8
     */
    TYPE_USE
}

@Inherited – 定义该注释和子类的关系

Annotations只支持基本类型、String及枚举类型。注释中所有的属性被定义成方法，并允许提供默认值。如下：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface CreateInfo {
    public enum Type {UI, SERVICE, MODLE, CONTROL, NORMAL}

    String author() default "Unknown";
    Type  type() default Type.NORMAL;
    String date() default "Unspecified";
}

下面的例子演示了如何使用上面的注解:

@CreateInfo(author = "Jimmy", type = CreateInfo.Type.NORMAL,
date = "2018/12/25")
public class AnnotationExample {
}

如果注解中只有一个属性，可以直接命名为“value”，使用时无需再标明属性名，如下：

@Target({ElementType.TYPE, ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
@interface Description {
    String value() default "Unknown";
}

使用方法如下：

@CreateInfo(author = "Jimmy", type = CreateInfo.Type.NORMAL,
date = "2018/12/25")
@Description("AnnotationExample")
public class AnnotationExample {
}

@Description(value = "just used to test description annotation")
class Test {
}

我们定义了自己的注解并将其应用在业务逻辑上。现在我们需要写一个用户程序调用我们的注解。这里我们需要使用反射机制。如果你熟悉反射代码，就会知道反射可以提供类名、方法和实例变量对象。所有这些对象都有getAnnotation()这个方法用来返回注解信息。我们需要把这个对象转换为我们自定义的注释(使用 instanceOf()检查之后)，同时也可以调用自定义注释里面的方法。看看以下的实例代码，使用了上面的注解:

public class Main {

    public static void main(String[] args) {
        Class clazz = AnnotationExample.class;
        CreateInfo createInfo = (CreateInfo) clazz.getAnnotation(CreateInfo.class);
        if (createInfo != null) {
            System.out.println("Print CreateInfo:");
            System.out.println("author:" + createInfo.author());
            System.out.println("type:" + createInfo.type());
            System.out.println("date:" + createInfo.date());
        }

        Description description = (Description) clazz.getAnnotation(Description.class);
        if (description != null) {
            System.out.println("Print Description:");
            System.out.println("value:" + description.value());
        }
    }
}

输出结果如下：

Print CreateInfo:
author:Jimmy
type:NORMAL
date:2018/12/25
Print Description:
value:AnnotationExample

Java编译时注解处理

上面的例子是在运行时处理的注解，因为我们将自定义的注解的@Retention设置为RetentionPolicy.RUNTIME，这意味着这些注解信息直到代码运行时还保留着，因此我们可以在代码运行时处理注解。但实际上我们经常用到大量的注意是只在编译时处理的，如Android的ARouter库中在编译时生成Activity列表。接下来我们说说如何在编译时处理注解。

首先我们先定义一个@Retention为RetentionPolicy.CLASS的注解类，该注解只保留在码中，编译后会丢弃，如下：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.SOURCE)
public @interface Component {
    public enum Type {UI, SERVICE, NORMAL}

    String url() default "null";
    Type type() default Type.NORMAL;
}

接下来我们我们需要继承AbstractProcessor实现一个自己的注解处理类，在AbstractProcessor有几个关键函数：

getSupportedAnnotationTypes 添加我们需要处理的注解
getSupportedSourceVersion 支持的源代码版本，一般返回SourceVersion.latestSupported()即可
process 具体的处理注解的方法

我实现的注解处理类是根据注解生成一些Java集合，集合中保存<url, qualified_class_name>的键值对，代码如下：

@Override
 public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        Map<String, String> uiMaps = new HashMap<>();
        Map<String, String> serviceMaps = new HashMap<>();
        Map<String, String> normalMaps = new HashMap<>();

        Set<? extends Element> elementsAnnotatedWith = roundEnv.getElementsAnnotatedWith(Component.class);
        for (Element element : elementsAnnotatedWith) {
            Annotation annotation = element.getAnnotation(Component.class);
            String url = ((Component) annotation).url();
            Component.Type type = ((Component) annotation).type();
            switch (type) {
                case NORMAL:
                    normalMaps.put(url, element.toString());
                    break;
                case UI:
                    uiMaps.put(url, element.toString());
                    break;
                case SERVICE:
                    serviceMaps.put(url, element.toString());
                    break;
                default:
                    break;

            }
        }

        for(String str : serviceMaps.keySet()) {
            System.out.println(str + ":" + serviceMaps.get(str));
        }
        System.out.println();
        for(String str : uiMaps.keySet()) {
            System.out.println(str + ":" + uiMaps.get(str));
        }
        System.out.println();
        for(String str : normalMaps.keySet()) {
            System.out.println(str + ":" + uiMaps.get(str));
        }
        return false;
}

可以通过如下命令验证注解处理器：

1. javac -d out  src/com/selflearning/annotation/processor/*.java
2. javac -cp out -processor com.selflearning.annotation.processor.AnnotationProcessor -s . -d out src/com/selflearning/annotation/processor/*.java

输出结果如下：
在这里插入图片描述

如何在Java编译过程中注册注解处理器

怎样注册我的注解处理器到 javac 呢？必须通过jar文件进行注册，在jar文件中将已经编译好的注解处理器打包到此文件中，并且在jar文件中必须打包一个特殊的文件javax.annotation.processing.Processor到META-INF/services目录下。如下：
因此.jar 文件目录结构看起来就你这样：
//待补充，自己实验一直未成功