《Java核心技术卷I》笔记——（3）Java注解

七海健人

已于 2022-03-20 15:42:50 修改

阅读量236

点赞数

分类专栏： # 《Java核心技术》文章标签： java

于 2022-03-20 14:38:49 首次发布

本文链接：https://blog.csdn.net/minghao0508/article/details/123612843

版权

《Java核心技术》专栏收录该内容

12 篇文章 2 订阅

订阅专栏

JAVA 注解

Annotation中文译过来就是注解、标释的意思，在Java中注解是一个很重要的知识点，但经常还是有点让新手不容易理解。

比如，大多数的文档对“注解”的解释——“Java 注解用于为 Java 代码提供元数据。作为元数据，注解不直接影响你的代码执行，但也有一些类型的注解实际上可以用于这一目的。Java 注解是从 Java5 开始添加到 Java 的。”
我个人认为，比较糟糕的技术文档主要特征之一就是：用专业名词来介绍专业名词。

注解？——标签！

标签是一张便利纸，标签上的内容可以自由定义。常见的如货架上的商品价格标签、图书馆中的书本编码标签、实验室中化学材料的名称类别标签等等。并且，往抽象地说，标签并不一定是一张纸，它可以是对人和事物的属性评价。也就是说，标签具备对于抽象事物的解释。注解如同标签。我们可以抽象概括一下，标签是对事物行为的某些角度的评价与解释。
初学者可以这样理解注解：想像代码具有生命，注解就是对于代码中某些鲜活个体的贴上去的一张标签。简化来讲，注解如同一张标签。

注解的语法？怎么用？

public @interface TestAnnotation {

}

解释：它的形式跟接口很类似，不过前面多了一个@符号；上面的代码就创建了一个名字为@TestAnnotaion的注解；可以简单理解为创建了一张名字为@TestAnnotation的标签；

@TestAnnotation
public class Test { //修饰类
}

@TestAnnotation
public void func_t(){ //修饰方法
}

@TestAnnotation public int a=1; //修饰变量

public void func_ta(@TestAnnotation int a, String s){ } //修饰方法参数

解释：创建一个类Test,然后在类定义的地方加上@TestAnnotation就可以用@TestAnnotation注解这个类了；可以简单理解为将@TestAnnotation这张标签贴到Test这个类上面；

元注解？

元注解是可以注解到注解上的注解，或者说元注解是一种基本注解，但是它能够应用到其它的注解上面。

如果难于理解的话，你可以这样理解。元注解也是一张标签，但是它是一张特殊的标签，它的作用和目的就是给其他普通的标签进行解释说明的。

元标签有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5种。

1. @Retention-保留时间

Retention的英文意为保留期的意思；当 @Retention 应用到一个注解上的时候，它解释说明了这个注解的的存活时间；

它的取值如下：

RetentionPolicy.SOURCE 注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。
RetentionPolicy.CLASS 注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。
RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到它们。

我们可以这样的方式来加深理解，@Retention 去给一张标签解释的时候，它指定了这张标签张贴的时间。@Retention 相当于给一张标签上面盖了一张时间戳，时间戳指明了标签张贴的时间周期。

@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
}

上面的代码中，我们指定 TestAnnotation 可以在程序运行周期被获取到，因此它的生命周期非常的长；

2. @Documented-文档Javadoc

顾名思义，这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去；

3. @Target-作用对象（包、接口、类、属性、方法、注解...）

Target 是目标的意思，@Target 指定了注解运用的地方。

可以这样理解，当一个注解被 @Target 注解时，这个注解就被限定了运用的场景。

类比到标签，原本标签是你想张贴到哪个地方就到哪个地方，但是因为 @Target 的存在，它张贴的地方就非常具体了，比如只能张贴到方法上、类上、方法参数上等等。@Target 有下面的取值：

ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
ElementType.CONSTRUCTOR 可以给构造方法进行注解
ElementType.FIELD 可以给属性进行注解
ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
ElementType.METHOD 可以给方法进行注解
ElementType.PACKAGE 可以给一个包进行注解
ElementType.PARAMETER 可以给一个方法内的参数进行注解
ElementType.TYPE 可以给一个类型进行注解，比如类、接口、枚举

4. @Inherited-该注解可被继承

Inherited 是继承的意思，但是它并不是说注解本身可以继承，而是说如果一个超类被 @Inherited 注解过的注解进行注解的话，那么如果它的子类没有被任何注解应用的话，那么这个子类就继承了超类的注解。

说的比较抽象。代码来解释。

// 定义@Test注解
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@interface Test { }

// 给类加上注解
@Test
public class A {}
public class B extends A {}</pre>

解释：注解Test被@Inherited修饰，之后类A被Test注解，类B继承A,类B也拥有Test这个注解。

5. @Repeatable

Repeatable是可重复的意思；@Repeatable是Java1.8才加进来的，所以算是一个新的特性。

什么样的注解会多次应用呢？通常是注解的值可以同时取多个。

举个例子，一个人他既是程序员又是产品经理，同时他还是个画家。

eg：

// 定义注解@Persons为可重复注解
@interface Persons {
    Person[] value(); 
}

@Repeatable(Persons.class)//"容器注解"
@interface Person{
    String role default ""; 
}

// 重复注解，即具备多个注解属性
@Person(role="artist")
@Person(role="coder")
@Person(role="PM")
public class SuperMan{

解释：注意上面的代码，@Repeatable注解了Person。而@Repeatable后面括号中的类相当于一个"容器注解"。
}

什么是容器注解呢？——就是用来存放其它注解的地方。它本身也是一个注解。

可以这样理解，Persons是一张总的标签，上面贴满了Person这种同类型但内容不一样的标签。把Persons给一个SuperMan贴上，相当于同时给他贴了程序员、产品经理、画家的标签;

@Person(role=”PM”)其实就是给Person这个注解的role属性赋值为PM ;

注解的属性？

注解可以看做成一个类，注解的属性也叫做成员变量；注解只有成员变量，没有方法；注解的成员变量在注解的定义中以“无形参的方法”形式来声明，其方法名定义了该成员变量的名字，其返回值定义了该成员变量的类型。

eg：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
    int id();
    String msg();
    public String msg_02() default "Hi"; //注解中属性可以有默认值，默认值需要用 default 关键值指定; 
}

解释：上面代码定义了TestAnnotation这个注解中拥有id和msg两个属性。在使用的时候，我们应该给它们进行赋值；

赋值的方式是在注解的括号内以value=””形式，多个属性之前用 "," 隔开；default关键值不指定就是默认值；

eg：

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

注意: 在注解中定义属性时它的类型必须是8种基本数据类型外加类、接口、注解及它们的数组;

如果一个注解内仅仅只有一个名字为 value 的属性时，应用这个注解时可以直接接属性值填写到括号内;

当一个注解没有任何属性,那么在应用这个注解的时候,括号都可以省略;

Java自带的注解?

除了可以自定义和使用注解，Java本身已经提供了几个现成的注解。

@Deprecated

这个元素是用来标记过时的元素，调用一个过时的元素比如过时的方法、过时的类、过时的成员变量，会有一条横线提醒；

eg：

static class Hero {
    public void say() {
    }
    @Deprecated
    public void speak() {
    }
}

使用的时候：

image.png

@Override

提示子类要复写父类接口中被 @Override 修饰的方法；

@SuppressWarnings

阻止警告的意思，比如集合类编译器提醒要加泛型，或者有未使用的变量等情况（编译器有黄色的波浪线）；

@SafeVarargs

参数安全类型注解，它的目的是提醒开发者不要用参数做一些不安全的操作,它的存在会阻止编译器产生 unchecked 这样的警告。在 Java 1.7 的版本中加入。

5. @FunctionalInterface

函数式接口注解，这个是 Java 1.8 版本引入的新特性。函数式编程很火，所以 Java 8 也及时添加了这个特性。eg：

@FunctionalInterface public interface Runnable { }

注解的提取?(用到反射，从对象/类获取其属性)

判断某个"元素"（类、方法、属性）是否加了注解，取出这个注解，获取Annotation对象，查看它的属性（因为注解也是个特殊的类）；

eg：

boolean hasAnnotation = Test.class.isAnnotationPresent(Test_ZhuJie_02.TestAnnotation.class);  
if (hasAnnotation) {
    TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class);
    //获取类的注解
    System.out.println("id:" + testAnnotation.id());
    System.out.println("msg:" + testAnnotation.msg()); 
}

注解是干什么用的？应用场景？

注解无法改变代码本身，注解只是某些工具的的工具；

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

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

现在，我们可以给自己答案了，注解有什么用？给谁用？给编译器或者APT用的；

自定义一个APT;

亲手自定义注解完成某个目的;

我要写一个测试框架，测试程序员的代码有无明显的异常。
—— 程序员 A : 我写了一个类，它的名字叫做 NoBug，因为它所有的方法都没有错误。
—— 我：自信是好事，不过为了防止意外，让我测试一下如何？
—— 程序员 A: 怎么测试？
—— 我：把你写的代码的方法都加上 @Jiecha 这个注解就好了。
—— 程序员 A: 好的。
eg：

public class NoBug {
  @Jiecha
  public void suanShu(){
        System.out.println("1234567890");
  }
  @Jiecha
  public void jiafa(){
        System.out.println("1+1="+(1+1));
  }
  @Jiecha
  public void jiefa(){
        System.out.println("1-1="+(1-1));
  }
  @Jiecha
  public void chengfa(){
        System.out.println("3 x 5="+ 3*5);
  }
  @Jiecha
  public void chufa(){
        System.out.println("6 / 0="+ 6 / 0);//除数为零，这里有错误
  }

  public void ziwojieshao(){
        System.out.println("我写的程序没有 bug!");
  }
}

上面的代码，有些方法上面运用了 @Jiecha 注解;

import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy;   
@Retention(RetentionPolicy.RUNTIME)
public @interface Jiecha {
}

上面是自定义的注解；

public class TestTool {
    public static void main(String[] args) { // TODO Auto-generated method stub
      NoBug testobj = new NoBug();   
      Class clazz = testobj.getClass();//反射   
      Method[] method = clazz.getDeclaredMethods();
      StringBuilder log = new StringBuilder(); //用来记录测试产生的 log 信息
      int errornum = 0;  // 记录异常的次数
      for (Method m : method) {
            // 只有被 @Jiecha 标注过的方法才进行测试
            if (m.isAnnotationPresent(Jiecha.class)) {
                try {
                    m.setAccessible(true);
                    m.invoke(testobj, null);    
                } catch (Exception e) {
                    // TODO Auto-generated catch block
                    //e.printStackTrace();
                    errornum++;
                    log.append("Method [NoBug.");
                    log.append(m.getName());
                    log.append("] ");
                    log.append("has error:");
                    log.append("\n\r caused by ");
                    //记录测试过程中，发生的异常的名称
                    log.append(e.getCause().getClass().getSimpleName());
                    log.append("\n\r");
                    //记录测试过程中，发生的异常的具体信息
                    log.append(e.getCause().getMessage());
                    log.append("\n\r");
                }
            }
        }
      // 输出统计
      log.append(clazz.getSimpleName());
      log.append(" has ");
      log.append(errornum);
      log.append(" error.");   // 生成测试报告
      System.out.println(log.toString());   }
}

以上是测试工具类；

实际中的注解实例?

**JUnit下的@Test；
ButterKnife下的@BindView(R.id.tv_test)；
Retrofit下的@GET**；

总结：

1.如果注解难于理解，你就把它类同于标签，标签为了解释事物，注解为了解释代码;
2.注解的基本语法，创建如同接口，但是多了个"@"符号;
3.注解的元注解;
4.注解的属性;
5.注解主要给编译器及工具类型的软件用的;
6.注解的提取需要借助于Java的反射技术，反射比较慢，所以注解使用时也需要谨慎计较时间成本;

七海健人

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
《Java核心技术卷I》笔记——（3）Java注解

JAVA 注解Annotation中文译过来就是注解、标释的意思，在Java中注解是一个很重要的知识点，但经常还是有点让新手不容易理解。比如，大多数的文档对“注解”的解释——“Java 注解用于为 Java 代码提供元数据。作为元数据，注解不直接影响你的代码执行，但也有一些类型的注解实际上可以用于这一目的。Java 注解是从 Java5 开始添加到 Java 的。”我个人认为，比较糟糕的技术文档主要特征之一就是：用专业名词来介绍专业名词。注解？——标签！标签是一张便利纸，标签上的内容可以自
复制链接

扫一扫