Java自定义注解

一、认识注解

不过正是开始之前，还是谈一下学习注解的主要意义吧。

1、首先我们能够读懂别人写的代码，特别是框架相关的代码。

2、本来可能需要很多配置文件，需要很多逻辑才能实现的内容，就可以使用一个或者多个注解来替代，这样就使得编程更加简洁，代码更加清晰。

OK，理解了注解的思想，我们就可以正式的学习一下注解了。

二、注解

我们介绍完注解之后在介绍元注解，在上面已经介绍过了，其实注解就是一张便利贴，我们可以随便写点东西，贴在我们想贴的地方。下面我们来正式的去介绍一下什么是注解以及如何定义注解。用法超级简单。

声明一个注解，其实和创建一个类差不多，只不过声明一个类是用class，声明一个接口是interface。声明一个注解很简单，使用@interface。下面我们举个例子：

public @interface MyAn{
    int a() default 1;
    String b() default "时代Java";
}

简单吧，但是里面有一点需要和类、接口的声明有点不同。注解是没有方法的，只有成员变量。而且我们可以自己定义默认值。但是形式上和方法一样.我们使用的时候，就像我们在开发Spring的时候一样就好了。

@TestAnnotation(id=3,msg="时代Java")
public class MyTest {
}

三、元注解

元注解是指什么呢？从名字就可以看出来，元注解就是注解的根，也就是注解的注解。就好对比我们有一堆便利贴，这些便利贴干什么的都有，但是我们在定义一个特殊的便利贴，这个特殊的便利贴指的是这些普通的便利贴是干嘛的。

元注解就是注解的注解。明白了吧。对元注解的基本概念了解清楚之后，我们就可以正式的介绍元注解的语法了。

元注解有五种分别是：@Retention、@Documented、@Target、@Inherited、@Repeatable 。

下面我们一一的去介绍一下：

1、@Retention

当 @Retention 应用到一个注解上的时候，它解释说明了这个注解的的存活时间。
它的取值如下：

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

在代码中我们如何去使用呢？

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

2、@Documented

它的作用是能够将注解中的元素包含到 Javadoc 中去。

3、@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
@Retention(RetentionPolicy.CLASS )
@interface MyTest {}

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

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

5、@Repeatable

@Repeatable是java1.8加进来的，表示的是可重复，就好比一个人有好几个身份。

下面举个例子来验证

//首先我们定义一个注解类 -- nowjava.com
@interface Person {
    Person[]  card();
}
//给这个注解添加上很多属性，其中一个就表示可重复
@Repeatable(Persons.class)
@interface Person{
    String role default "";
}

@Person(role="A")
@Person(role="B")
public class ChengXuYuan{

}

四、预置注解

java预置的注解其实还是比较多的，但是我们只要调出几个比较重要的就好了。

@Deprecated

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})
public @interface Deprecated {
}

这个注解是用来标记过时的元素，编译器在编译阶段遇到这个注解时会发出提醒警告，告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量。

比如：

   private static final class Test {  
        @Deprecated
        void sayHello() {
            System.out.println("say hello");
        }
    }
    public static void main(String[] args) {
        Test test = new Test();
        test.sayHello();
    }

这时sayHello()方法上面被一条直线划了一条，这其实就是编译器识别后的提醒效果：

@Override

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}

这个注解再熟悉不过了，提示该方法是接口方法的实现或者是子类重写的父类的方法。

@SuppressWarnings

@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {
    String[] value();
}

阻止警告的意思，上面说过调用被@Deprecated注解的方法后，编译器会警告提醒，而有时候开发者会忽略这种警告，他们可以在调用的地方通过@SuppressWarnings达到目的。

如：

    @SuppressWarnings("deprecation")
    public static void main(String[] args) {
        Test test = new Test();
        test.sayHello();
    }

这个时候sayHello()就不会被编译器处以下划线的警告了。

@SafeVarargs

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.CONSTRUCTOR, ElementType.METHOD})
public @interface SafeVarargs {}

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

如：

    @SafeVarargs
    static void collects(List... stringLists) {
        Object[] array = stringLists;
        List tmpList = Arrays.asList(42);
        // Semantically invalid, but compiles without warnings
        array[0] = tmpList;
        // Oh no, ClassCastException at runtime!
        String s = stringLists[0].get(0);
    }

上面的代码中，编译阶段不会报错，但是运行时会抛出ClassCastException这个异常，所以它虽然告诉开发者要妥善处理，但是开发者自己还是搞砸了。

五、获取注解

也就是我们通过反射获取类 、函数或成员上的运行时注解信息，从而实现动态控制程序运行的逻辑。举个例子，看看我们如何通过反射来控制程序运行的逻辑。

不过为了防止你没有反射的基础，我们还是先简单的介绍一下反射的原理。

反射可以让我们在运行时获取类的属性，方法，构造方法、父类、接口等信息，通过反射还可以让我们在运行期实例化对象、调用方法、即使方法或属性是私有的的也可以通过反射的形式调用。

下面我们使用代码来演示：

第一步：定义注解

第一个是类的注解

//这个注解是类注解
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(value=ElementType.FIELD)
public @interface Fields {
    int sort() default 0 ;
    String value() ;
}

第二个事类中成员变量的注解

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface ConsAnnotation {
    String[] request();//表明可以声明多个string
}

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface ConsAnnotation {
    String[] request();//表明可以声明多个string
}

第二步：声明一个用户类