Java 注解(Annotation)

引言

Java 注解(Annotation)是一种在 Java 代码中使用元数据的方式。注解可以用于标记代码中的元素，比如类、方法、字段等，以提供额外的信息。

Java 注解的出现，使得代码的可读性、可维护性和可扩展性大大提高。

注解的定义

注解的定义，使用 @interface 关键字。例如，下面是一个简单的注解定义：


    // 定义一个注解
    @interface MyAnnotation {
        String value() default "";
    }

上面的代码定义了一个名为 MyAnnotation 的注解，它有一个 value 属性。

注解的属性可以是任何基本类型、String 类型、Class 类型、枚举类型、注解类型或以上类型的数组。

如果注解的属性没有默认值，那么使用注解时必须指定该属性的值。

如果注解的属性有默认值，那么使用注解时可以不指定该属性的值。

注解的使用

使用注解的格式为 @注解名(属性名=属性值)，或者 @注解名(属性名1=属性值1, 属性名2=属性值2, ...)。

下面是一个使用 MyAnnotation 注解的示例：


    // 使用 MyAnnotation 注解
    @MyAnnotation("hello")
    public class MyClass {
        // ...
    }

上面的代码使用 MyAnnotation 注解标记了 MyClass 类，且指定了 value 属性的值为 "hello"。

内置注解

Java SE 5.0 引入了一些内置注解，它们可以用于标记代码中的元素，以提供额外的信息。

@Override

@Override 注解可以用于标记方法，表示该方法重写了父类中的方法。


    public class MyClass {
        @Override
        public String toString() {
            return "MyClass";
        }
    }

上面的代码中，toString 方法使用了 @Override 注解，表示该方法重写了父类中的 toString 方法。

@Deprecated

@Deprecated 注解可以用于标记代码中已经过时的元素，以提醒用户不要再使用该元素。


    public class MyClass {
        /**
         * @deprecated
         */
        public void doSomething() {
            // ...
        }
    }

上面的代码中，doSomething 方法使用了 @Deprecated 注解，表示该方法已经过时。同时，该方法的注释中也标记了该方法已经过时。

@SuppressWarnings

@SuppressWarnings 注解可以用于标记代码中的某些警告信息，以提示编译器不要产生警告。


    public class MyClass {
        @SuppressWarnings("unchecked")
        public void doSomething() {
            List myList = new ArrayList();
        }
    }

上面的代码中，doSomething 方法使用了 @SuppressWarnings 注解，表示该方法中使用的 List 类型是未经检查的。使用该注解可以让编译器不产生警告。

自定义注解

除了使用内置注解，我们还可以自定义注解。

下面是一个自定义注解的示例：


    // 自定义一个注解
    @interface MyAnnotation {
        String name();
        int age();
        String[] hobbies();
    }

    // 使用自定义注解
    @MyAnnotation(name="Tom", age=18, hobbies={"reading", "swimming"})
    public class MyClass {
        // ...
    }

上面的代码定义了一个 MyAnnotation 注解，它有三个属性：name、age 和 hobbies。同时，还使用了该注解标记了 MyClass 类。

注解的解析

在 Java 中，注解的解析可以使用反射机制来实现。

下面是一个解析 MyAnnotation 注解的示例：


    public class MyClass {
        @MyAnnotation(name="Tom", age=18, hobbies={"reading", "swimming"})
        public void doSomething() {
            // ...
        }

        public static void main(String[] args) throws NoSuchMethodException {
            Method method = MyClass.class.getMethod("doSomething");
            MyAnnotation myAnnotation = method.getAnnotation(MyAnnotation.class);
            System.out.println(myAnnotation.name());
            System.out.println(myAnnotation.age());
            System.out.println(Arrays.toString(myAnnotation.hobbies()));
        }
    }

上面的代码中，首先通过反射获取到 doSomething 方法，然后使用 getAnnotation 方法获取到该方法上的 MyAnnotation 注解，最后打印出注解的属性值。