Java的注解与反射（基础）

注解（Annotation）

1、什么是注解？

Annotation是从JDK5.0开始引入的新技术。它也被称为元数据，为我们在代码中添加信息提供了一种形式化的方式，注解在一定程度上把元数据和源代码文件结合在了一起。

Annotation的作用：

• 不是程序本身，可以对程序作出解释。（这一点和注释（comment）没什么区别）
• 可以被其它程序（如编译器等）读取。
• 有助于减轻编写“样板”代码的负担

Annotation的格式：

• 注解是以"@注释名"在代码中存在的，还可以添加一些参数值，例如：@SuppressWarnings(value=“unchecked”)。

Annotation的使用范围？

• 可以附加在package、class、method、field等上面，相当于给他们添加了额外的辅助信息，我们可以通过反射机制编程实现对这些元数据的访问。

注解的应用场景

注解在框架中的使用非常广泛，你随便打开一个框架都可以看见里面使用注解的情况。Annotation 是一个辅助类，它在 Junit、Struts、Spring 等工具框架中被广泛使用。

2、内置注解

• @Override：定义在java.lang.Override中，此注解只适用于修辞方法，表示一个方法生命打算重写超类（父类）中的另一个方法声明。

• @SuppressWarnings：定义在java.lang.SuppressWarnings中，用来抑制编译时的警告信息，它需要添加一个参数才能正常使用，这些参数都是已经定义好了的，我们选择性使用就可以了。

@SuppressWarnings("all")        
@SuppressWarnings("unchecked")       
@SuppressWarnings(value={"unchecked","deprecation"}) 
....

• @Desperated（已过时，不建议使用）
  用于告知编辑器，某以程序元素（方法、成员变量）不建议使用（过时了），如果程序员使用了注解为它的元素，编译器会发出警告

3、元注解

• 元注解的作用就是负责注解其它注解，Java定义了4个标准的meta-annotation类型，它们被用来提供对其它annotation类型作说明。
• 这些类型和它们所支持的类在java.lang.annotation包中可以找到（@Target、@Retention、@Documented、@Inherited）

以上四个元注解当中重点掌握 @Target、@Retention的用法。

元注解的功能介绍

（1）@Target：用于描述注解的使用范围（即：被描述的注解可以用在什么地方，比如说在类、方法、构造器、属性等等），ElementType有以下参数类型：

参数类型	范围说明
TYPE	类、接口（包括注释类型）或枚举声明
FIELD	字段声明（包括枚举常量）
METHOD	使用在方法上声明
PARAMETER	参数声明
CONSTRUCTOR	使用在构造器上声明
LOCAL_VARIABLE	使用在局部变量上声明
ANNOTATION_TYPE	使用在注解上声明
PACKAGE	包声明
TYPE_PARAMETER	注解可以用于类型参数声明（JDK1.8）
TYPE_USE	类型使用声明（JDK1.8)

（2）@Retention：表示在什么级别保存该注释信息，用于描述注解的生命周期。（SOURCE<CLASS<RUNTIME）

参数类型	说明
SOURCE	Annotation信息仅存在于编译器处理期间，编译器处理完之后就没有该Annotation信息了
CLASS	编译器将Annotation存储于类对应的.class文件中。默认行为
RUNTIME	编译器将Annotation存储于class文件中，并且可由JVM读入

（3）@Document：说明该注解被包含在javadoc中，是否生成文档注释。类和方法的 Annotation 在缺省情况下是不出现在 javadoc 中的。如果使用 @Documented 修饰该 Annotation，则表示它可以出现在 javadoc 中。

定义 Annotation 时，@Documented 可有可无；若没有定义，则 Annotation 不会出现在 javadoc 中。

（4）@Inherited：说明子类可以继承父类中的该注解。使用 @interface 定义注解时，意味着它实现了 java.lang.annotation.Annotation 接口，即该注解就是一个Annotation。

定义 Annotation 时，@interface 是必须的。
注意：它和我们通常的 implemented 实现接口的方法不同。Annotation 接口的实现细节都由编译器完成。通过 @interface 定义注解后，该注解不能继承其他的注解或接口。

测试代码：

 //Target表示我们的注解可以用在哪些地方，相当于设置一个使用范围
//TYPE:可以设置在类上   METHOD：可以设置在方法上
@Target(value = {ElementType.METHOD,ElementType.TYPE})

//Retention表示我们的注解在什么地方有效
//runtime(默认，范围最大)>class>sources
@Retention(value = RetentionPolicy.RUNTIME)

//Documented表示是否将我们的注解生成在Javadoc中
@Documented

//Inherited 子类可以继承父类的注解
@Inherited

@interface MyAnnotation{
    //自定义注解
}

4、自定义注解

使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口。

分析：

• 使用@interface来声明一个注解，格式为：@interface + 注解名{ 定义内容 }。
• 其中的每一个方法实际上是声明了一个配置参数。
• 方法的名称就是参数的名称。
• 返回值类型就是参数的类型（返回值只能是基本类型，Class，String，enum）。
• 可以通过default来声明参数的默认值。
• 如果只有一个参数成员，一般参数名为value。
• 注解元素必须要有值，我们定义注解元素时，经常使用空字符串，0作为默认值。

 /**
 * 自定义注解
 */
public class AnnotationBySelf {
    //注解可以显示赋值，如果没有默认值，我们就必须给注解赋值
    @MyAnnotation1(name="你好",age = 18)
    void Tets(){}

    @MyAnnotation3("hello")
    void Tst(){};
}

//以下两个一定要标注
@Target(value={ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation1{
    //注解的参数：参数类型+参数名();
    String name() default "";
    int age() ;
    int id() default -1;//如果默认值为-1，代表不存在

    String[] school() default {"西部开发","..."};
}


@Target(value = ElementType.METHOD)
@Retention(value = RetentionPolicy.RUNTIME)
@interface MyAnnotation3{
    String value();//如果只有一个值，建议将写成value()
}

反射（Reflection）

1、反射概括

• Reflection（反射）是Java视为动态语言的关键，反射机制允许程序在指向期间借助于Reflection API取得任何类的内部信息，并能直接操作任意对象的内部属性以及方法。

• 加载完类之后，在堆内存的方法区中就产生了一个Class类型的对象（一个类只有一个Class对象），这个对象就包含了完整的类的结构信息。我们可以通过这个对象看到类的结构。这个对象就像一面镜子，通过这个镜子看到类的结构，所以，我们形象的称之为“反射”。

2、反射机制提供的功能

• 在运行时判断任意一个对象所属的类
• 在运行时构造任意一个类的对象
• 在运行时判断任意一个类所具有的成员变量和方法
• 在运行时获取泛型信息
• 在运行时调用任意一个对象的成员变量和方法
• 在运行时处理注解
• 生成动态代理
• …

3、Java反射优点和缺点

（1）优点

可以实现动态创建对象和编译，体现了很大的灵活性。

（2）缺点

对性能有影响，使用反射基本上是一种解释性操作，我们可以告诉JVM我们需要做什么并且让它满足我们的要求，这类操作总是慢于直接执行的操作。

反射相关的主要API

测试

实体类User：

//实体类
class User{
    private String name;
    private int id;
    private int age;

    public User() {
    }

    public User(String name, int id, int age) {
        this.name = name;
        this.id = id;
        this.age = age;
    }

    public String getName() {
        return name;
    }

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

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public int getAge() {
        return age;
    }

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

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", id=" + id +
                ", age=" + age +
                '}';
    }
}

 public static void main(String[] args) throws ClassNotFoundException {
    //通过反射获取User类的Class对象，里面是包名+类名
    Class c1 = Class.forName("com.oldou.reflection.User");
    System.out.println(c1);

    Class c2 = Class.forName("com.oldou.reflection.User");
    Class c3 = Class.forName("com.oldou.reflection.User");
    Class c4 = Class.forName("com.oldou.reflection.User");

       //一个类在内存中只有一个Class对象
       //一个类被加载后，类的整个结构都会被封装到Class对象中
       System.out.println(c2.hashCode());
       System.out.println(c3.hashCode());
       System.out.println(c4.hashCode());
}

输出：

以上可以得知：

• 一个类被加载后，类的整个结构都会被封装到Class对象中，通过Class对象使用反射可以获取到该对象。
• 一个类在内存中只有一个Class对象，因此它们的哈希码是相同的。

Class类的简介

在Object类中定义了以下方法，此方法被所有子类继承。
public final Class getClass();
以上方法的返回值类型是一个Class类，此类是Java反射的源头，实际上所谓的反射从程序的运行结果来看很好理解。
即：可以通过对象反射求出类的名称。

Class类的叙述

对象照镜子后可以得到的信息:某个类的属性、方法和构造器、某个类到底实现了哪些接口。对于每个类而言，JRE都为其保留一个不变的Class类型的对象。一个Class对象包含了特定某个结构(class/interface/enum/annotation/primitive type/void/[])的有关信息。

• Class 本身也是一个类
• Class 对象只能由系统建立对象
• 一个加载的类在JVM中只会有一个Class实例
• 一个Class对象对应的是一 个加载到JVM中的一个.class文件
• 每个类的实例都会记得自己是由哪个Class实例所生成
• 通过Class可以完整地得到一个类中的所有被加载的结构
• Class类 是Reflection的根源，针对任何你想动态加载、运行的类，唯有先获得相应的Class对象

Class类的常用方法

获取Class类的几种方式

（1）若已知具体的类，通过类的class属性获取, 该方法最为安全可靠，程序性能最高。
Class clazz = Person.class;

（2）已知某 个类的实例，调用该实例的getClass()方法获取Class对象
Class clazz = person.getClass();

（3）已知一个类的全类名，且该类在类路径下，可通过Class类的静态方法forName()获取，可能抛出ClassNotFoundException
Class clazz = Class.forName("demo01 .Student");

（4）内置基本数据类型可以直接用类名.Type
（5）还可以利用Classl oader我们之后讲解

测试代码：

class Person{
    public String name;

    public Person() {
    }
    public Person(String name) {
        this.name = name;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                '}';
    }
}

class Student extends Person{
    public Student() {
        this.name = "学生";
    }
}

 public static void main(String[] args) throws ClassNotFoundException {
    Person person = new Student();
    System.out.println("这个人是："+person);

    //方式一：通过对象获得class对象
    Class c1 = person.getClass();
    System.out.println(c1.hashCode());

    //方式二：通过forname获得
    Class c2 = Class.forName("com.oldou.reflection.Student");
    System.out.println(c2.hashCode());

    //方式三：通过类名.class获得
    Class c3 = Student.class;
    System.out.println(c3.hashCode());

    //方式四：基本内置类型的包装类都有一个TYPE属性
    Class<Integer> type = Integer.TYPE;

    //方式五：获得父类类型
    Class c5 = c1.getSuperclass();
    System.out.println(c5);
}

有哪些类型可以有Class对象？

• class: 外部类,成员(成员内部类,静态内部类)，局部内部类,匿名内部类。
• interface: 接口
• []:数组
• enum:枚举.
• annotation: 注解@interface
• primitive type:基本数据类型
• void

测试代码：

 public static void main(String[] args) {
    Class c1 = Object.class;//对象
    Class c2 = Comparable.class;//接口
    Class c3 = String[].class;//一维数组
    Class c4 = int[][].class;//二维数组
    Class c5 = Override.class;//注解
    Class c6 = ElementType.class;//枚举
    Class c7 = Integer.class;//基本数据类型的包装类
    Class c8 = void.class;//void
    Class c9 = Class.class;//Class
    //主要元素类型和维度一致，那么就是同一个Class
    int[] a = new int[10];
    int[] b = new int[100];
    System.out.println(a.getClass().hashCode());
    System.out.println(b.getClass().hashCode());
}

输出：

以上两个数组说明了元素类型和维度一致，那么他们的Class是同一个。

类加载内存分析

（1）加载：将class文件字节码内容加载到内存中，并将这些静态数据转换成方法区的运行时数据结构，然后生成一个代表这个类的java.lang.Class对象.

（2）链接：将Java类的二进制代码合并到JVM的运行状态之中的过程。

• 验证：确保加载的类信息符合JVM规范，没有安全方面的问题
• 准备：正式为类变量(static) 分配内存并设置类变量默认初始值的阶段，这些内存都将在方法区中进行分配。
• 解析：虚拟机常量池内的符号引用(常量名)替换为直接引用(地址)的过程。
  （3）初始化:
• 执行类构造器< clinit> ()方法的过程。类构造器< clinit> ()方法是由编译期自动收集类中所有类变量的赋值动作和静态代码块中的语句合并产生的。(类构造器是构造类信息的，不是构造该类对象的构造器)。
• 当初始化一个类的时候，如果发现其父类还没有进行初始化，则需要先触发其父类的初始化。
• 虑拟机会保证一-个类的< clinit> ()方法在多线程环境中被正确加锁和同步。

测试代码：

 public class Test04 {
    public static void main(String[] args) {
        A a = new A();
        System.out.println(a.m);
    }
}
class A{
    static{
        System.out.println("A类静态代码块初始化");
        m = 300;
    }
    static int m = 100;
    public A(){
        System.out.println("A类的无参构造器初始化");
    }
}

输出：

以上代码执行过程分析

当程序启动的时候，会进行类的加载，将类中的信息（静态变量、静态方法、常量池、代码等等）加载到方法区当中，加载完成之后就会立马在堆中生成对应的Class对象，Class对象中包含了类的所有信息，之后就开始执行main方法，然后变量m显示默认为0，这是因为在链接阶段的准备期间会为static变量分配内存并设置变量默认的初始值，也就是说m在链接阶段的值为0，当准备工作都做完了之后就执行main方法中的A a = new A();这个new A()是在堆中产生一个新的对象，这个对象会指向A类的Class，然后Class中是有类的所有数据的，通过这些数据就可以对A类显示赋值，开始初始化操作，这个时候就开始执行一个方法方法，把静态代码块的初始值都合并了，先是从上往下执行静态代码块的输出，然后给m赋值为300，然后再执行m=100，然后再去执行类的构造器，最后new A()操作完成了，就进行m的输出。以上静态代码的执行顺序为：
初始化：

  <clinit>(){
       System.out.println("A类静态代码块初始化");
       m = 300;
       m = 100
  }

分析初始化：

1、什么时候会发生类初始化？

（1）类的主动引用(- -定会发生类的初始化)

• 当虚拟机启动，先初始化main方法所在的类
• new一个类的对象
• 调用类的静态成员(除了final常量)和静态方法.
• 使用java.lang.reflect包的方法对类进行反射调用
• 当初始化-个类，如果其父类没有被初始化，则先会初始化它的父类

（2）类的被动引用(不会发生类的初始化)

• 当访问一个静态域时，只有真正声明这个域的类才会被初始化。如:当通过子类引用父类的静态变量,不会导致子类初始化
• 通过数组定义类引用，不会触发此类的初始化
• 引用常量不会触发此类的初始化(常量在链接阶段就存入调用类的常量池中了)

测试主动引用：

 public class Test05 {
    static{
        System.out.println("Main类被调用");
    }
    public static void main(String[] args) throws ClassNotFoundException {
        //主动调用
        //Son son = new Son();
        //反射也会产生主动引用
        Class.forName("com.oldou.reflection.Son");
    }
}

class Father{
    static int i = 2;
    static{
        System.out.println("父类被加载");
    }

}

class Son extends Father{
    static{
        System.out.println("子类被加载");
        m=300;
    }
    static int m = 10;
    static final int M = 520;
}

输出：

测试被动引用：

 //不会发生类的初始化
// System.out.println(Son.i);
 System.out.println(Son.M);

输出：

通过获取类的运行时结构

（1） 通过反射获取运行时类的完整结构
Field（字段）、Method（方法）、 Constructor（构造器）、 Superclass（父类）、 Interface（接口）、 Annotation（注解）。

测试代码：

 Class<?> c1 = Class.forName("com.oldou.reflection.User");

//获得类的名字
System.out.println(c1.getName());//获得 包名+类名
System.out.println(c1.getSimpleName()); // 获得类名

System.out.println("=================================");
//获得类的属性
Field[] fields = c1.getFields();//只能获取类的public属性
Field[] fields1 = c1.getDeclaredFields();//获取全部的属性（包括私有属性）

//获得指定属性的值
Field name = c1.getDeclaredField("name");
System.out.println(name);

System.out.println("==========================================");
//获得类的方法
Method[] methods = c1.getMethods();//获得本类以及父类的全部public方法
Method[] methods1 = c1.getDeclaredMethods();//获得本类的所有方法（包括私有属性）

//获得指定方法
Method getName = c1.getMethod("getName", null);
Method setName = c1.getMethod("setName", String.class);

//获得public类型的构造器
Constructor[] constructors = c1.getConstructors();
//获取所有的构造器（包括私有的）
Constructor[] constructor = c1.getDeclaredConstructors();

//获取指定的构造器
Constructor declaredConstructor = c1.getDeclaredConstructor(String.class, int.class, int.class);

有了Class对象，能够做什么？

1、创建类的对象:调用Class对象的newInstance()方法

• （1）类必须有一个无参数的构造器。
• （2）类的构造器的访问权限需要足够

思考?难道没有无参的构造器就不能创建对象了吗?

只要在操作的时候明确的调用类中的构造器,并将参数传递进去之后，才可以实例化操作。

步骤如下:

（1）通过Class类的getDeclaredConstructor(Class … parameterTypes)取得本类的指定形参类型的构造器
（2）向构造器的形参中传递一个对象数组进去， 里面包含了构造器中所需的各个参数。
（3）通过Constructor实例化对象

2、调用指定的方法：

通过反射，调用类中的方法，通过Method类完成。

• （1）通过Class类的getMethod(String name,Class…parameterTypes)方法取得一个Method对象，并设置此方法操作时所需要的参数类型。
• （2）之后使用Object invoke(Object obj, Object[] args)进行调用，并向方法中传递要设置的obj对象的参数信息。
  

Object invoke(Object obj, Object .... args)

• Object 对应原方法的返回值，若原方法无返回值，此时返回null
• 若原方法若为静态方法，此时形参Object obj可为null
• 若原方法形参列表为空,则Object[] args为null
• 若原方法声明为private,则需要在调用此invoke()方法前，显式调用方法对象的setAccessible(true)方法，将可访问private的方法。

setAccessible(boolean)

• Method和Field、Constructor对象都有setAccessible()方法。
• setAccessible作用是启动和禁用访问安全检查的开关，为true时表示关闭安全检测，默认是false。
• 参数值为true则指示反射的对象在使用时应该取消Java语言访问检查。
• 提高反射的效率。如果代码中必须用反射，而该句代码需要频繁的被调用，那么请设置为true。
• 使得原本无法访问的私有成员也可以访问
• 参数值为false则指示反射的对象应该实施Java语言访问检查
  注意：如果平时使用反射较多的话，可以关闭安全检测，这样性能会更加好。

性能测试

public class Test08 {
    public static void main(String[] args) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException {
        Test();
        Test1();
        Test2();
    }
    public static void Test(){
        User user = new User();
        long startTime = System.currentTimeMillis();
        for (int i = 0;i<1000000000;i++){
            user.getName();
        }
        long endTime = System.currentTimeMillis();
        System.out.println("普通方法调用执行10亿次耗时："+(endTime-startTime)+"ms");
    }
    public static void Test1() throws NoSuchMethodException, InvocationTargetException, IllegalAccessException {
        User user = new User();
        Class c1 = user.getClass();
        Method getName = c1.getDeclaredMethod("getName",null);
        long startTime = System.currentTimeMillis();
        for (int i = 0;i<1000000000;i++){
            getName.invoke(user,null);
        }
        long endTime = System.currentTimeMillis();
        System.out.println("反射方法调用执行10亿次耗时："+(endTime-startTime)+"ms");
    }
    public static void Test2() throws NoSuchMethodException, InvocationTargetException, IllegalAccessException {
        User user = new User();
        Class c1 = user.getClass();
        Method getName = c1.getDeclaredMethod("getName",null);
        getName.setAccessible(true);
        long startTime = System.currentTimeMillis();
        for (int i = 0;i<1000000000;i++){
            getName.invoke(user,null);
        }
        long endTime = System.currentTimeMillis();
        System.out.println("反射方法调用执行10亿次耗时："+(endTime-startTime)+"ms");
    }
}

输出：

由此可见，反射耗时是普通方法调用的多少倍，如果在平时中使用反射较多，可以的话就将安全检测关闭，有助于提高性能。

反射操作注解

 public class Test10 {
    public static void main(String[] args) throws Exception {
        Class c1 = Class.forName("com.oldou.reflection.Student2");
        //通过反射获取注解
        Annotation[] annotations = c1.getAnnotations();
        for (Annotation annotation : annotations) {
            System.out.println(annotation);
        }

        //获取注解的value值
        TableAnnotation tableAnnotation = (TableAnnotation)c1.getAnnotation(TableAnnotation.class);
        System.out.println(tableAnnotation.value());

        //获取类注定的注解
        Field name = c1.getDeclaredField("name");
        FieldAnnotation annotation = name.getAnnotation(FieldAnnotation.class);
        System.out.println(annotation.columnAnnotation());
        System.out.println(annotation.type());
        System.out.println(annotation.length());
    }
}
@TableAnnotation("db_student")
class Student2{
    @FieldAnnotation(columnAnnotation = "db_id",type = "int",length = 10)
    private int id;
    @FieldAnnotation(columnAnnotation = "db_id",type = "String",length = 3)
    private String name;
    @FieldAnnotation(columnAnnotation = "db_id",type = "int",length = 10)
    private int age;

    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
    public Student2(int id, String name, int age) {
        this.id = id;
        this.name = name;
        this.age = age;
    }
    @Override
    public String toString() {
        return "Student2{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", age=" + age +
                '}';
    }
    public Student2() {
    }
}

//类名的注解
@Target(value = ElementType.TYPE)
@Retention(value = RetentionPolicy.RUNTIME)
@interface TableAnnotation{
    String value();
}

//属性的注解
@Target(value = ElementType.FIELD)
@Retention(value = RetentionPolicy.RUNTIME)
@interface FieldAnnotation{
    String columnAnnotation();
    String type();
    int length();
}