Java 注解#

Java 注解用于为 Java 代码提供元数据。作为元数据，注解不直接影响你的代码执行，但也有一些类型的注解实际上可以用于这一目的。Java 注解是从 Java5 开始添加到 Java 的。

注解的概念有点抽象，我们可以把他理解成标签。其实同 classs 和 interface 一样，注解也属于一种类型。它是在 Java SE 5.0 版本中开始引入的概念。

注解的定义#

注解通过 @interface 关键字进行定义。

public @interface TestAnnotation {
}

它的形式跟接口很类似，不过前面多了一个 @ 符号。

上面的代码就创建了一个名字为 TestAnnotaion 的注解。可以简单理解为创建了一张名字为 TestAnnotation 的标签。

注解的使用#

@TestAnnotation
public class TestClass {
}

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

元注解#

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

我们可以把元注解当作一张标签，但它是一张特殊的标签，它的作用和目的就是给其他普通的标签进行解释说明的。

元注解有下列几种：

@Documented#

这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去。注意，只能运用到注解类上面。

@Retention#

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

它的取值如下：（RetentionPolicy 是一个枚举）

比如，我们指定 @TestAnnotation 注解的生命周期一直保留到运行时。

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

@Target#

Target 是目标的意思，@Target 指定了注解运用的地方。可以这样理解，当一个注解被 @Target 注解时，这个注解就被限定了运用场景。

它的取值如下：（ElementType 是一个枚举）

@Inherited#

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

用代码解释：

@Inherited
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {}

@MyAnnotation
public class A {}
public class B extends A {}

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

@Repeatable#

Repeatable 是可重复的意思。@Repeatable 是 Java 1.8 才加进来的。直接看代码：

public @interface Persons {
    Person[]  value();
}

@Repeatable(Persons.class)
public @interface Person{
    String role default "";
}

@Person(role="artist")
@Person(role="coder")
@Person(role="PM")
public class SuperMan{
}

@Repeatable 注解了 Person。而 @Repeatable 后面括号中的类相当于一个容器注解。

容器注解是用来存放其它注解的地方。它本身也是一个注解。按照规定，它里面必须要有一个 value 的属性，属性类型是一个被 @Repeatable 注解过的注解数组，注意它是数组。

注解的属性#

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

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
    int id() default 0;
    String msg() default "";
}

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

赋值的方式是在注解的括号内以 value=”xxx” 形式，多个属性之前用 ,隔开。

@TestAnnotation(id = 123, msg = "myAnnotation")
public class TestClass {
}

• 注解中定义属性时它的类型必须是 8 种基本数据类型外加类、接口、注解及它们的数组。
• 注解中属性可以有默认值，默认值需要用 default 关键值指定
• 有默认值就可以不在 @TestAnnotation 后面的括号里面进行赋值了，这一步可以省略。
• 还有一种情况。如果一个注解内仅仅只有一个名字为 value 的属性时，应用这个注解时可以直接接属性值填写到括号内。

public @interface Check {
    String value();
}

@Check("hi")
int a;

Java 预置的注解#

注解与反射#

• 注解通过反射获取。首先可以通过 Class 对象的 isAnnotationPresent() 方法判断它是否应用了某个注解

public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}

• 然后通过 getAnnotation() 方法来获取 Annotation 对象。

public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}

• 或者是 getAnnotations() 方法。

public Annotation[] getAnnotations() {}

前一种方法返回指定类型的注解，后一种方法返回注解到这个元素上的所有注解。

@TestAnnotation()
public class Test {
    public static void main(String[] args) {
        boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);
        if ( hasAnnotation ) {
            TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class);
            System.out.println("id:"+testAnnotation.id());
            System.out.println("msg:"+testAnnotation.msg());
        }
    }
}

// 运行结果: (这个正是 TestAnnotation 中 id 和 msg 的默认值。)
id:0
msg:

上面的例子中，只是检阅出了注解在类上的注解，其实属性、方法上的注解照样是可以的。同样还是要使用反射。

public class Hero {
    @Deprecated
    public void say(){
        System.out.println("Noting has to say!");
    }
    public void speak(){
        System.out.println("I have a dream!");
    }
}

@TestAnnotation(msg="hello")
public class Test {
    @Check(value="hi")
    int a;
    
    @Perform
    public void testMethod(){}
    
    @SuppressWarnings("deprecation")
    public void test1(){
        Hero hero = new Hero();
        hero.say();
        hero.speak();
    }
    
    public static void main(String[] args) {
        boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);
        if ( hasAnnotation ) {
            TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class);
            // 获取类的注解
            System.out.println("id:"+testAnnotation.id());
            System.out.println("msg:"+testAnnotation.msg());
        }
        try {
            Field a = Test.class.getDeclaredField("a");
            a.setAccessible(true);
            // 获取一个成员变量上的注解
            Check check = a.getAnnotation(Check.class);
            if ( check != null ) {
                System.out.println("check value:"+check.value());
            }
            Method testMethod = Test.class.getDeclaredMethod("testMethod");
            if ( testMethod != null ) {
                // 获取方法中的注解
                Annotation[] ans = testMethod.getAnnotations();
                for( int i = 0;i < ans.length;i++) {
                    System.out.println("method testMethod annotation:"+ans[i].annotationType().getSimpleName());
                }
            }
        } catch (NoSuchFieldException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
            System.out.println(e.getMessage());
        } catch (SecurityException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
            System.out.println(e.getMessage());
        } catch (NoSuchMethodException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
            System.out.println(e.getMessage());
        }
    }
}

// 运行结果
id:-1
msg:hello
check value:hi
method testMethod annotation:Perform

注解的使用场景#

官网文档：

注解是一系列元数据，它提供数据用来解释程序代码，但是注解并非是所解释的代码本身的一部分。注解对于代码的运行效果没有直接影响。

注解有许多用处，主要如下：

• 提供信息给编译器： 编译器可以利用注解来探测错误和警告信息
• 编译阶段时的处理： 软件工具可以用来利用注解信息来生成代码、Html 文档或者做其它相应处理。
• 运行时的处理： 某些注解可以在程序运行的时候接受代码的提取
  值得注意的是，注解不是代码本身的一部分。

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

了解更多#

1. 注解本身是继承于 Annotation 接口的

public @interface Override {
}

等同于

public interface Override extends Annotation{
}

而 Annotation 接口位于 JDK 源码 java.lang.annotation 包内:

public interface Annotation {
    boolean equals(Object obj);

    int hashCode();

    String toString();

    Class<? extends Annotation> annotationType();
}

2. 注解本身可以自我注解的。如果需要注解其他注解类，只需要将 Target 设置为 ANNOTATION_TYPE 即可，注解可称为“元数据”，那么这种可以注解其他注解类的注解，可称为“元注解”。

3. 注解总是需要搭配相应的“业务”才能发挥作用的。“元注解”如 Target、Retention 等，内置注解如 Override 的“业务”都在 Java 的编译器 javac 中，所以源码中是找不到踪影的。许多时候，我们将注解对应的“业务”集合到一个工具中，这个工具就是“注解编译器”，也叫“注解处理器”。许多开源库，也是需要搭配相应的注解编译器方可使用。

4. Class 类是实现了 AnnotatedElement 接口的，这个接口允许反射性地读取注解，因此类总是可以通过反射找到其注解。

应用例子#

对一个类的方法进行测试。在待测试方法上加上 @check 注解

package test;
import test.check;
public class CheckBug {
    @check
    public void arithmetic(){
        System.out.println("1234567890");
    }
    @check
    public void add(){
        System.out.println("1+1="+1+1);
    }
    @check
    public void subtract(){
        System.out.println("1-1="+(1-1));
    }
    @check
    public void multiply(){
        System.out.println("3 x 5="+ 3*5);
    }
    @check
    public void divide(){
        System.out.println("6 / 0="+ 6 / 0);
    }
    public void checkProgram(){
        System.out.println("我写的程序没有 bug!");
    }
}

注解 @check：

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

再编写一个测试类 TestTool 就可以测试 NoBug 相应的方法了

package test;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
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();
        // 用来记录测试产生的 log 信息
        StringBuilder log = new StringBuilder();
        // 记录异常的次数
        int errornum = 0;
        for ( Method m: method ) {
            // 只有被 @check 标注过的方法才进行测试
            if ( m.isAnnotationPresent( check.class )) {
                try {
                    m.setAccessible(true);
                    m.invoke(testobj, null);
                } catch (Exception e) {
                    // TODO Auto-generated catch block
                    //e.printStackTrace();
                    errornum++;
                    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());
    }
}

测试结果：

1234567890
1+1=11
1-1=0
3 x 5=15
divide has error:
  caused by ArithmeticException
/ by zero
NoBug has  1 error.

参考资料#

• java 注解 - 最通俗易懂的讲解

• Java 注解一二三