Java 注解

1. 什么是注解

注释：给人看的便于阅读代码 3

注解：类似商品的条形码，描述商品，方便后期商品结算

Annontation是JDK5开始引入的新特征，中文名称叫注解(也被称为元数据)。

它提供了一种安全的类似注释的机制，用来将任何的信息或元数据（metadata）与程序元素（类、方法、成员变量等）进行关联。为程序的元素（类、方法、成员变量）加上更直观更明了的说明，这些说明信息是与程序的业务逻辑无关，并且供指定的工具或框架使用。

Annontation像一种修饰符一样，应用于包、类型、构造方法、方法、成员变量、参数及本地变量的声明语句中。

Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能。注解不会也不能影响代码的实际逻辑，仅仅起到辅助性的作用。包含在 java.lang.annotation 包中

2. 注解的作用

1、生成文档。这是最常见的，也是java 最早提供的注解。常用的有@param @return 等

2、跟踪代码依赖性，实现替代配置文件功能。比如Spring的注入，未来java开发，将大量注解配置，具有很大用处;

3、在编译时进行格式检查。如@override 放在方法前，如果你这个方法并不是覆盖了超类方法，则编译时就能检查出

4.在反射的 Class, Method, Field 等函数中，有许多于 Annotation 相关的接口,可以在反射中解析并使用 Annotation。

3. 注解的原理

注解本质是一个继承了Annotation的特殊接口，其具体实现类是Java运行时生成的动态代理类。而我们通过反射获取注解时，返回的是Java运行时生成的动态代理对象$Proxy1。通过代理对象调用自定义注解（接口）的方法，会最终调用AnnotationInvocationHandler的invoke方法。该方法会从memberValues这个Map中索引出对应的值。而memberValues的来源是Java常量池

@param

注解的本质：特殊的接口

声明注解：创建一个特殊接口

使用注解：@+注解名(创建注解的一个对象)

4. 注解的分类

4.1 内置注解

Java中有三种内置注解，这些注解用来为编译器提供指令,它们是:

@Deprecated(depreact)

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

可以用来标记类，方法，属性;

@Override

用来修饰对父类进行重写的方法。如果一个并非重写父类的方法使用这个注解，编译器将提示错误。

实际上在子类中重写父类或接口的方法，@Overide并不是必须的。但是还是建议使用这个注解，在某些情况下，假设你修改了父类的方法的名字，那么之前重写的子类方法将不再属于重写，如果没有@Overide，你将不会察觉到这个子类的方法。有了这个注解修饰，编译器则会提示你这些信息

@SuppressWarnings

用来抑制编译器生成警告信息

可以修饰的元素为类，方法，方法参数，属性，局部变量

当我们一个方法调用了弃用的方法或者进行不安全的类型转换，编译器会生成警告。我们可以为这个方法增加@SuppressWarnings注解，来抑制编译器生成警告。

注意：使用@SuppressWarnings注解，采用就近原则，比如一个方法出现警告，我们尽量使用@SuppressWarnings注解这个方法，而不是注解方法所在的类。虽然两个都能抑制编译器生成警告，但是范围越小越好，因为范围大了，不利于我们发现该类下其他方法的警告信息

//告诉编译器忽略 unchecked 警告信息，如使用List，ArrayList等未进行参数化产生的警告信息。
@SuppressWarnings(“unchecked”)

//如果编译器出现这样的警告信息：The serializable class WmailCalendar does not declare a     //static final serialVersionUID field of type long，使用这个注释将警告信息去掉。
@SuppressWarnings(“serial”)

//如果使用了使用@Deprecated注释的方法，编译器将出现警告信息。使用这个注释将警告信息去掉。
@SuppressWarnings(“deprecation”)

//rawtypes是说传参时也要传递带泛型的参数 
@SuppressWarnings(“rawtypes”) 

//抑制所有类型的警告：
@SuppressWarnings(“all”)

4.2 元注解

元注解是java API提供的，是用于修饰注解的注解，通常用在注解的定义上

java.lang.annotation提供了四种元注解，专门注解其他的注解（在自定义注解的时候，需要使用到元注解）.

1.@Documented-

注解是否将包含在JavaDoc中

一个简单的Annotations标记注解，表示是否将注解信息添加在javadoc文档中

2.@Retention –

什么时候使用该注解

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

它的取值如下：

• RetentionPolicy.SOURCE （ 注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。）

• RetentionPolicy.CLASS （注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。）

• RetentionPolicy.RUNTIME （注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到它们。）

3.@Target–

注解用于什么地方

默认值为任何元素，表示该注解用于什么地方。

​ ● ElementType.CONSTRUCTOR:用于描述构造器 ​

● ElementType.FIELD:成员变量、对象、属性（包括enum实例） ​

● ElementType.LOCAL_VARIABLE:用于描述局部变量 ​

● ElementType.METHOD:用于描述方法 ​

● ElementType.PACKAGE:用于描述包 ​

● ElementType.PARAMETER:用于描述参数 ​

● ElementType.TYPE:用于描述类、接口(包括注解类型) 或enum声明

@Target(value = {ElementType.METHOD,ElementType.FIELD,ElementType.TYPE,ElementType.TYPE_USE})
//表示该注解在哪些地方使用，若不写则表示在任意可使用

4.@Inherited –

定义该注释和子类的关系

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

实例：

package Annotation.study;

import java.lang.annotation.*;

/**
 * 定义一个注解接口
 * 使用元注解对自定义注解进行一些声明
 */
@Documented
//给注解的参数赋值，如果是数组类型，
//赋一个值:参数名=值或者：参数名={值}
@Target(value = {ElementType.METHOD,ElementType.FIELD,ElementType.TYPE,ElementType.TYPE_USE})
//表示该注解在哪些地方使用，若不写则表示在任意可使用
@Retention(RetentionPolicy.RUNTIME)
//什么时候该注释（CLASS,//源码阶段
// SOURCE,//编译期间
// RUNTIME）运行期间
@Inherited
//表示子类会继承父类的注解
public @interface Demo1 {

}

package Annotation.study;
@Demo1//创建了了一个该注解的对象
public class Student {
    private String name;
    private int age;

    public Student() {
    }
@Demo1
    public Student(@Demo1 String name, int age) {
        this.name = name;
        this.age = age;
    }

    public String getName() {
        return name;
    }
@Demo1
    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

4.3 自定义注解

声明注解的关键字：@interface

public @interface 注解名{
 //成员
}

注意规则：

1. Annotation型定义为@interface, 所有的Annotation会自动继承java.lang.Annotation这一接口,并且不能再去继承别的类或是接口.
2. 参数成员只能用public或默认(default)这两个访问权修饰
3. 参数成员只能用基本类型byte,short,char,int,long,float,double,boolean八种基本数据类型和String、Enum、Class、annotations等数据类型,以及这一些类型的数组.
4. 要获取类方法和字段的注解信息，必须通过Java的反射技术来获取 Annotation对象,因为你除此之外没有别的获取注解对象的方法
5. 注解也可以没有定义成员, 不过这样注解就没啥用了

具体实例：

1.先创建一个注解：

package Annotation.duty;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 角色注解
 */
//如果这个参数名为Value ，单独给value 赋值，可以省略 value=
    //若是多个不可省略
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Role {
     String value() ;
}

2. 创建一个工具类来应用自定义的注解：

package Annotation.duty;

/**
 * 商品
 */
public class Shop {
    @Role("管理员")
    public void Up(){
        System.out.println("出品货物！");
    }
    @Role("管理员")
    public void Down(){
        System.out.println("下架货物！");
    }
    @Role("顾客")
    public void Buy(){
        System.out.println("购买商品！");
    }
    @Role("顾客")
    public void View(){
        System.out.println("浏览商品！");
    }
}

3. 测试类进行测试：

package Annotation.duty;

import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
import java.util.Scanner;

public class Test {
    public static void main(String[] args) throws NoSuchMethodException,
            InvocationTargetException,
            IllegalAccessException {
        Scanner input = new Scanner(System.in);
        System.out.println("请输入你的角色：");
        String role = input.next();
        System.out.println("请输入你调用的方法：");
        String methodname = input.next();
        //调用方法
        Shop shop = new Shop();
        //调用之前，
        //通过反射
        //1.获取该类的的class对象
        Class<Shop> clazz = Shop.class;
        //获取指定方法名称的对象
         //Method method = clazz.getMethod("Up");
        Method method = clazz.getDeclaredMethod(methodname);
         //判断是否有该注解对象
        //获取该方法上的需要角色：使用注解
        if (method.isAnnotationPresent(Role.class)){
            //判断角色是否匹配
            //获取这个方法上@Role的value参数
            //获取方法上的注解对象
            Role obj = method.getAnnotation(Role.class);
            //获取它的参数值
            String value = obj.value();
            if (role.equals(value)){
                System.out.println("你有权限访问！");
                method.invoke(shop);
            }else {
                System.out.println("你暂时没有权限访问！");
            }
            //调用方法
        }
    }
}