Java中的注解

看到了一篇非常好的博客，简要的记录一些重点吧。
注解类似于标签，给注解的那些类，方法等贴上一些标签，这些信息并不是Java程序的一部分，
注解的信息可以可以通过反射读取，然后由开发提供的工具来处理这些信息实现某些功能。

定义： @interface

public @interface TestAnnotation {
}

应用：

创建一个类 Test,然后在类定义的地方加上 @TestAnnotation 就可以用 TestAnnotation 注解这个类了。

你可以简单理解为将 TestAnnotation 这张标签贴到 Test 这个类上面。

@TestAnnotation
public class Test {
}

元注解
1. 可以注解到注解上的注解。@Retention、@Documented、@Target、@Inherited、@Repeatable
2. @Retention （保留期）
  
  取值：
  - RetentionPolicy.SOURCE 注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。
  - RetentionPolicy.CLASS 注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。
  - RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到它们。
  我们可以这样的方式来加深理解，@Retention 去给一张标签解释的时候，它指定了这张标签张贴的时间。@Retention 相当于给一张标签上面盖了一张时间戳，时间戳指明了标签张贴的时间周期。
```
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
}
```
  上面的代码中，我们指定 TestAnnotation 可以在程序运行周期被获取到，因此它的生命周期非常的长。
3. @Documented
  
  含义：作用是能够将注解中的元素包含到 Javadoc 中去。
4. @Target
  
  作用：指定了注解运用的地方。当一个注解被 @Target 注解时，这个注解就被限定了运用的场景。
  
  因为 @Target 的存在，它张贴的地方就非常具体了，比如只能张贴到方法上、类上、方法参数上等等。@Target 有下面的取值:
  - ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
  - ElementType.CONSTRUCTOR 可以给构造方法进行注解
  - ElementType.FIELD 可以给属性进行注解
  - ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
  - ElementType.METHOD 可以给方法进行注解
  - ElementType.PACKAGE 可以给一个包进行注解
  - ElementType.PARAMETER 可以给一个方法内的参数进行注解
  - ElementType.TYPE 可以给一个类型进行注解，比如类、接口、枚举
5. @Inherited
  
  含义：Inherited 是继承的意思，但是它并不是说注解本身可以继承，而是说如果一个超类被 @Inherited 注解过的注解进行注解的话，那么如果它的子类没有被任何注解应用的话，那么这个子类就继承了超类的注解。例子：https://blog.csdn.net/briblue/article/details/73824058
6. @Repeatable
  
  含义：可重复什么样的注解会多次应用呢？通常是注解的值可以同时取多个。
  
  举个例子，一个人他既是程序员又是产品经理,同时他还是个画家。
注解的属性：注解的属性也叫做成员变量。注解的成员变量在注解的定义中以“无形参的方法”形式来声明，其方法名定义了该成员变量的名字，其返回值定义了该成员变量的类型。

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
    int id();   default -1;
    String msg();   default "Hi"; // 默认值
}

上面代码定义了 TestAnnotation 这个注解中拥有 id 和 msg 两个属性。在使用的时候，我们应该给它们进行赋值。赋值的方式是在注解的括号内以 value=”” 形式，多个属性之前用，隔开。

@TestAnnotation(id=3,msg="hello annotation")
public class Test {
}

// 如果使用默认值
@TestAnnotation()
public class Test {}
// 如果只有一个属性，也可以这么用
@Check("hi")
int a;
// 如果没有任何属性，括号都可以省略
@Perform
public void testMethod(){}

Java预置的注解：

@Deprecated、@Override、@SuppressWarnings

注解的提取（重要）

之前使用标签来比作注解，前面的内容是讲怎么写注解，然后贴到哪个地方去，而现在我们要做的工作就是检阅这些标签内容。形象的比喻就是你把这些注解标签在合适的时候撕下来，然后检阅上面的内容信息。

想要正确检阅，就是使用反射。

需要注意的是，如果一个注解要在运行时被成功提取，那么 @Retention(RetentionPolicy.RUNTIME) 是必须的。

注解的使用场景

注解并不是代码本身的一部分，注解只是某些工具的工具。

回到官方文档的解释上，注解主要针对的是编译器和其它工具软件(SoftWare tool)。

当开发者使用了Annotation 修饰了类、方法、Field 等成员之后，这些 Annotation 不会自己生效，必须由开发者提供相应的代码来提取并处理 Annotation 信息。这些处理提取和处理 Annotation 的代码统称为APT（Annotation Processing Tool)。

注解的应用实例
1. JUnit
JUnit 这个是一个测试框架，典型使用方法如下：
```
public class ExampleUnitTest {
  @Test
  public void addition_isCorrect() throws Exception {
      assertEquals(4, 2 + 2);
  }
}
```
@Test 标记了要进行测试的方法 addition_isCorrect().

参考：https://blog.csdn.net/briblue/article/details/73824058

猜你喜欢