概述

什么是注解

注解（也被称为元数据）为我们在代码中添加信息提供了一种形式化的方法，使我们可以在稍后某个时刻非常方便地使用这些元数据。也就是说，我们可以为某个类/某个方法/某个字段/某个构造器等通过注解的方式，增加一些额外信息，然后利用Annotations API来处理这些信息。

Java中内置了3个标准注解：

@Override：表示当前的方法定义将覆盖父类中的方法。如果你不小心拼写错误，或者方法签名与父类中的方法不对应，编译器就会发出错误提示。该注解是可选的，并不强制。
@Deprecated：如果在程序中使用该注解标注的类/方法等，那么编译器会发出警告信息。
@SuppressWarnings：用来关闭不当的编译器警告信息。

如果我们要自定义自己的注解，一般有两个步骤：定义注解，然后编写注解处理器。

定义注解

要定义一个注解，有3个要素

注解叫什么名字
注解有哪些特性：可以用在什么地方（类还是方法还是变量）等
注解有哪些属性：可以为元素增加哪些注释

注解叫什么名字，是通过@interface关键字进行定义，如下：

public @interface MyAnnotation {
}

下面介绍注解的特性和属性的定义。

元注解

Java提供了5种元注解，专门负责新注解的创建工作，其中@Repeatable是Java 1.8新增的元注解，如下表所示：

元注解

说明

@Target

表示该注解可以用于什么地方，可选值为： CONSTRUCTOR(构造器) FIELD(成员变量) LOCAL_VARIABLE(局部变量) METHOD(方法) PACKAGE(包) PARAMETER(参数) TYPE(类或接口或enum或其他注解)

@Retention

表示需要在什么级别保存该注解信息，可选值为： SOURCE：注解仅保留在源代码（.java文件）中，将会被编译器丢弃 CLASS：注解在class文件（.class文件）中可用，但会被VM丢弃 RUNTIME：VM将在运行期也保留注解，因此可以通过反射机制读取注解的信息

@Documented

将此注解包含在javadoc中

@Inherited

允许子类继承父类中的注解即假如类A添加了某注解，且该注解为@Inherited的，则类A的子类也会自动添加该注解

@Repeatable

表示该注解在同一元素上，可以重复使用假设某个注解的含义为标识某个类为

注解的属性

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

使用时，采用“@注解名(属性1=value,属性2=value2)”的形式对属性进行赋值，如果某注解只有一个属性，在使用时，可以直接使用“@注解名(value)”的形式，而不必显式指明属性名。

此外，可以使用default关键字来为属性设置默认值。没有默认值的属性，在使用时，必须指定值，有默认值的属性，则可以不设置，使用默认值。

//定义MyAnnotation注解，它包含id和msg两个属性
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    int id() default 0;
    String msg();
}

//使用：“属性=属性值”的形式
@MyAnnotation(id=5,msg="hello")
public class Xxxxx {}

//使用：“属性=属性值”的形式，因为id有默认值，如果不关心，可以省略
@MyAnnotation(msg="hello")
public class Xxxxx {}

编写注解处理器

当我们为类/方法/变量等添加了一个注解后，相当于给它们增加了一个注释。但是增加注释往往不是我们的目的，我们还要根据这个注释来对他们做一些处理，这就是注解处理器。

要编写注解处理器，就必须知道哪些元素（类还是方法还是变量等）上添加了什么注解，这些信息需要使用反射API来获取。获取之后，还要根据注解信息，为元素做一些处理，这个处理过程，也需要使用反射API来完成。

与注解相关的反射API如下，只要注解可以出现的元素（Class/Method/Constructor等），都可以通过对应的下述方法来获取：

//判断元素是否有annotationClass这个注解
public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}

//获取元素上添加的annotationClass这个注解
public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}

//获取元素上所有的注解
public Annotation[] getAnnotations() {}

获取到某注解后，可以通过“注解.属性”这种形式来获取注解的某个属性的值。

示例1

假如有如下自定义注解：

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Log {

    String type() default "";
}

然后将注解添加到Operation类的方法上：

public class Operation {

    @Log(type = "添加")
    public void add(Book book) {
        System.out.println("add book:" + book.getName());
    }

    @Log(type = "删除")
    public void delete(Book book) {
        System.out.println("delete book:" + book.getName());
    }

    static class Book {
        private String name;

        public String getName() {
            return name;
        }

        public void setName(String name) {
            this.name = name;
        }
    }
}

下面，来编写Log注解的处理器，它要做的事情是：在Operation每个操作之前，将操作的类型打印出来：

public class AnnotationsExample {

    public static void main(String[] args) throws InvocationTargetException, IllegalAccessException {

        Operation.Book book  = new Operation.Book();
        book.setName("way-to-architect");

        Operation operation = new Operation();
        Class<? extends Operation> operationClass = operation.getClass();
        Method[] methods = operationClass.getMethods();
        for (Method method : methods){
            if(method.isAnnotationPresent(Log.class)){
                Log logAnnotation = method.getAnnotation(Log.class);
                String type = logAnnotation.type();
                System.out.println("操作的类型：" + type);
                method.invoke(operation,book);
            }
        }
    }
}
//输出如下
操作的类型：添加
add book:way-to-architect
操作的类型：删除
delete book:way-to-architect

示例2 假如有以下注解，用于给类的成员变量添加一个标签，然后根据这个标签，将类的成员变量进行格式化输出：

//注解@Label
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Label {
    String value() default "";
}
//注解处理器
public class Formatter {

    public static String format(Object object) throws IllegalAccessException {
        StringBuilder res = new StringBuilder();
        Class<?> clazz = object.getClass();
        Field[] fields = clazz.getDeclaredFields();
        for (Field field : fields) {
            field.setAccessible(true);
            if (field.isAnnotationPresent(Label.class)) {
                Label label = field.getAnnotation(Label.class);
                res.append(label.value()).append(":").append(field.get(object)).append(System.getProperty("line.separator"));
            }
        }
        if (res.length() > 0) {
            int separatorLength = System.getProperty("line.separator").length();
            res.delete(res.length() - separatorLength, res.length());
        }
        return res.toString();
    }
}
//使用
static class User {

    @Label("名字")
    private String name;

    @Label("年龄")
    private int age;

    public User(String name, int age) {
        this.name = name;
        this.age = age;
    }
    //省略getter和setter方法
}
//测试
@Test
public void testFormatter() throws IllegalAccessException {
    User user = new User("xiaoming", 18);
    String format = Formatter.format(user);
    System.out.println(format);
}
//输出如下
名字:xiaoming
年龄:18

参考

《Java编程思想》

秒懂，Java 注解（Annotation）你可以这样学

深入理解Java：注解

《Java编程的逻辑》

Previous注解 NextSpring中的组合注解的条件注解

Last updated 5 years ago