Java注解

注解在日常开发中经常用到，比如@Controller、@Mapper,都是自定义的注解，在开发中我也使用过自定义注解，做权限认证功能，把权限硬编码到注解上，优点是实现比较简单，缺点是代码臃肿，维护比较困难，并且通过反射会比较耗时间。通过这次的实践也对注解有了深刻的影响，在这里加深学习

注解如同标签

那么什么是注解呢？我的理解是注解如同标签，是我们对事物的评价和解释，通过标签我们就可以进一步去使用它的功能。

注解的格式

最简单的格式：

@Entity

简单理解就是前面有@符号的就是注解

注解的定义

注解通过 @interface 关键字进行定义，它的形式跟接口很类似，不过前面多了一个 @ 符号。

public @interface MyAnnotation {
}

注解的使用

在使用之前，还需要知道新的概念那就是元注解
元注解是啥？
元注解是最基本的一种注解，需要注解在我们自定义的注解上，如果把注解理解为标签，那么云注解就是打在标签上的标签。
举个栗子：

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

我们自定义了一个注解MyAnnotation，并通过元注解指定了存活时间。

元注解有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 种。

@Retention

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

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

元注解@Retention的功能，你可以简单理解为指定注解的生命周期。

@Target

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

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

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

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

@Documented

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

@Inherited

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

@Inherited
@Retention(RetentionPolicy.RUNTIME)
@interface Test {}

@Test
public class Animal{}

public class Cat extends Animal{}

注解Test被@Inherited修饰，Animal被Test注解，Cat继承Animal，Cat又没有其它注解，所以Cat继承了Test注解；

通俗点理解就是一个人很有钱的标签，他儿子虽然还没有被打上标签，但会继承他的有钱这个标签。

@Repeatable

Repeatable 自然是可重复的意思。@Repeatable 是 Java 1.8 才加进来的，所以算是一个新的特性。

通过一个栗子来了解它：

@interface MyAnnotations {
    MyAnnotation[] value();
}

@Repeatable(MyAnnotations.class)
@interface MyAnnotation {
    String value();
}

@MyAnnotation("one")
@MyAnnotation("two")
class Test{

}

通过@Repeatable我们可以多次使用@MyAnnotation，将@Repeatable去掉编辑器就会报错（idea哟）

在自定义注解中我们只使用@Retention，@Target也是可以的哟~

注解的属性

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

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation {
    int id();
    String name();
}

@MyAnnotation(id = 10,name = "蟑螂恶霸")
class Test{

}

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

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

注解中属性可以有默认值，默认值需要用 default 关键值指定。比如：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation {
    int id();
    String name() default "test";
}

拥有默认值的属性在使用时可以不赋值。

若该注解的成员变量只有一个时，可以命名为value这样我们使用时就可以不加上变量名了，比如：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation {
    int value(); //只有一个成员变量
}

@MyAnnotation(10)
class Test{
}
//效果相同
@MyAnnotation(value = 10)
class Test2{
}

Java 预置的注解

其实 Java 语言本身已经提供了几个现成的注解。

@Deprecated：
这个元素是用来标记过时的元素，想必大家在日常开发中经常碰到。编译器在编译阶段遇到这个注解时会发出提醒警告，告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量。
@Override：
这个大家应该很熟悉了，提示子类要复写父类中被 @Override 修饰的方法
@SuppressWarnings：
阻止警告的意思。之前说过调用被 @Deprecated 注解的方法后，编译器会警告提醒，而有时候开发者会忽略这种警告，他们可以在调用的地方通过@SuppressWarnings 达到目的。
@SafeVarargs：
参数安全类型注解。它的目的是提醒开发者不要用参数做一些不安全的操作,它的存在会阻止编译器产生 unchecked 这样的警告。它是在 Java 1.7 的版本中加入的。
@FunctionalInterface：
函数式接口注解，这个是 Java 1.8 版本引入的新特性。函数式编程很火，所以 Java 8 也及时添加了这个特性。
函数式接口 (Functional Interface) 就是一个具有一个方法的普通接口。

注解的提取

我们通过用标签来比作注解，我们已经知道如果自定义注解，然后贴到哪个地方去，而现在我们要获取注解的内容。形象的比喻就是你把这些注解标签在合适的时候撕下来，然后检阅上面的内容信息。

要想正确检阅注解，离不开一个手段，那就是反射，注解加上反射才是最强大的地方。

代码演示：

@MyAnnotation("demo类")
public class demo {

    @MyAnnotation("年龄属性")
    private int age;

    @MyAnnotation("测试方法")
    public void test(){}

    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException, NoSuchMethodException {

        Class<?> clazz = Class.forName("demo");
        //判断类上是否有MyAnnotation注解
        boolean bool = clazz.isAnnotationPresent(MyAnnotation.class);
        System.out.println("bool = " + bool);

        //获取demo类上的MyAnnotation注解
        MyAnnotation annotation = clazz.getAnnotation(MyAnnotation.class);
        System.out.println("MyAnnotation在类上的值 = " + annotation.value());

        //获得成员变量
        Field age = clazz.getDeclaredField("age");
        MyAnnotation field = age.getAnnotation(MyAnnotation.class);
        System.out.println("MyAnnotation在变量上的值 = " + field.value());

        //获得方法
        Method test = clazz.getMethod("test");
        MyAnnotation testAnnotation = test.getAnnotation(MyAnnotation.class);
        System.out.println("MyAnnotation在方法上的值 = " + testAnnotation.value());

    }
}

反射的方法详解可以看：Java基础之反射

Q.E.D.

Hi,Friend

TangRen