Java注解与反射

1. 注解

1.1 什么是注解

注解的作用：

• 不是程序本身，可以对程序作出解释（这一点和注释没什么区别）
• 可以被其他程序（比如编译器等）读取
  Annotation的格式：
• 注解是以"@注释名"在代码中存在的，还可以添加一些参数值，例如@SuppressWarnings(value=“unchecked”)

Annotation在哪里使用？

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

1.2 内置注解

@Override：定义在java.lang.Override中，此注解只适用于修辞方法，表示一个方法声明打算重写超类中的另一个方法声明。
@Deprecated：定义在java.lang.Deprecated中，此注解可以用于修辞方法，属性，类，表示不鼓励程序员使用这样的元素，但也可以使用，通常是因为它很危险或者存在更好的选择。
@SuppressWarnings：定义在java.lang.SuppressWarnings中，用来抑制编译时的警告信息。与前两个不同的是，需要添加一个参数才能正确使用，这些参数都是已经定义好的，选择性使用。

1.3 元注解

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

• @Target：用于描述注解的使用范围（一个方法、一个类、等等）
• @Retention：表示需要在什么级别保存该注解信息，用于描述注解的生命周期
• @Document：说明该注解将被包含在java doc中
• @Inherited：说明子类可以继承父类中的该注解

1.4 自定义注解

使用@interface进行自定义注解

2. 静态语言和动态语言

动态语言：

• 是一类在运行时可以改变其结构的语言：例如新的函数、对象、甚至代码可以被引进，已有的函数可以被删除或是其他结构上的变化。通俗点所就是在运行时代码可以根据某些条件改变自身结构。
• 主要动态语言：Object-C、C#、JavaScript、PHP、Python等

静态语言：

• 与动态语言相对应的，运行时结构不可变的语言就是静态语言。
• 主要静态语言：C、C++、Java

Java不是动态语言，但Java可以称之为“准动态语言”。即Java有一定的动态性，我们可以利用反射机制获得类似动态语言的特性。

3. 反射

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

Class c = Class.forName("java.lang.String");

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

可以看到，反射的方式跟正常的方式就是反着来的！

3.1 反射机制提供的功能

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

3.2 Java反射优缺点

优点：

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

缺点：

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

3.3 反射相关的主要API

• java.lang.Class 代表一个类
• java.lang.reflect.Method 代表类的方法
• java.lang.reflect.Field 代表类的成员变量
• java.lang.reflect.Contructor 代表类的构造器
• …

通过反射获取类的class对象

3.4 Class类

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

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

3.4.1 Class类的常用方法

3.4.2 获取Class类的实例

1.若已知具体的类，通过类的class属性获取，该方法最为安全可靠，程序性能最高。

2.已知某个类的实例对象，调用该实例对象的getClass()方法获取Class对象。

3.已知一个类的全类名，且该类在类路径下，可通过Class类的静态方法forName()获取,可能抛出ClassNotFoundException

测试代码：

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

        //方式一：通过类的实例对象获得
        Class c1 = student.getClass();
        System.out.println(c1.hashCode());

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

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


class Person{
    public String name;

    public Person() {}

    public Person(String name) {this.name = name;}

    @Override
    public String toString() {
        return "Person{" +
                "name='" + name + '\'' +
                '}';
    }
}

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

class Teacher extends Person{
    public Teacher(){
        this.name="老师";
    }
}

测试结果：

基本内置类型的包装类都有一个Type属性

        //方式四
        Class c4 = Integer.TYPE;
        System.out.println(c4);

3.4.3 哪些类型可以有Class对象

//所有类型的Class
public class Test04 {
    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
        System.out.println(c1);
        System.out.println(c2);
        System.out.println(c3);
        System.out.println(c4);
        System.out.println(c5);
        System.out.println(c6);
        System.out.println(c7);
        System.out.println(c8);
        System.out.println(c9);

        //只要元素类型与维度一样，就是同一个Class
        int[] a = new int[10];
        int[] b = new int[100];
        System.out.println(a.getClass().hashCode());
        System.out.println(b.getClass().hashCode());
    }
}

测试结果

3.4.4 Java内存

3.4.5 类的加载与ClassLoader

当程序主动使用某个类时，如果该类还未被加载到内存中，则系统会通过如下三个步骤来对该类进行初始化。

加载：将class文件字节码内容加载到内存中，并将这些静态数据转换成方法区的运行时数据结构，然后生成一个代表这个类的java.lang.Class对象。这也是我们都是获取Class而不是创建的一个原因！

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

• 验证:确保加载的类信息符合JVM规范，没有安全方面的问题
• 准备:正式为类变量(static)分配内存并设置类变量默认初始值的阶段，这些内存都将在方法区中进行分配。
• 解析:虚拟机常量池内的符号引用（常量名）替换为直接引用（地址)的过程。

初始化：

• 执行类构造器< clinit>()方法的过程。类构造器< clinit>()方法是由编译期自动收集类中所有类变量的赋值动作和静态代码块中的语句合并产生的。(类构造器是构造类信息的，不是构造该类对象的构造器)。
• 当初始化一个类的时候，如果发现其父类还没有进行初始化，则需要先触发其父类的初始化。
• 虚拟机会保证一个类的< clinit>()方法在多线程环境中被正确加锁和同步。

测试代码

public class Test05 {
    public static void main(String[] args) {
        A a = new A();
        System.out.println(A.m);
        /*  执行顺序
            1.加载到内存，会产生一个类对应的Class对象，每个类都会对应一个Class对象
            2.链接，连接结束后 m = 0
            3.初始化
                <clinit>(){
                        System.out.println("A类静态代码块初始化");
                        m = 300;
                        m = 100;
                }
                最后m的值为100
        */
    }
}

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

    public A(){
        System.out.println("A类的无参构造初始化");
    }
}

类什么时候会初始化？

1.类的主动引用（一定会发生类的初始化）

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

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

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

类加载器ClassLoader
类加载的作用：将class文件字节码内容加载到内存中，并将这些静态数据转换成方法区的运行时数据结构，然后在堆中生成一个代表这个类的java.lang.Class对象，作为方法区中类数据的访问入口。也就是说，类加载器就是用来把类装载进内存的。

public class Test06 {
    public static void main(String[] args) throws ClassNotFoundException {
        // 获取系统类加载器
        ClassLoader systemClassLoader = ClassLoader.getSystemClassLoader();
        System.out.println(systemClassLoader);

        // 获取系统类加载器的父类加载器-->扩展类加载器
        ClassLoader parent = systemClassLoader.getParent();
        System.out.println(parent);

        // 获取扩展类加载器的父类加载器-->根加载器（C/C++）  这里会显示null,因为根加载器无法直接获取
        ClassLoader parent1 = parent.getParent();
        System.out.println(parent1);

        // 测试当前类是由哪个类加载的，发现是系统类加载器
        ClassLoader now = Class.forName("com.liu.reflection.Test06").getClassLoader();
        System.out.println(now);

        // 测试JDK中的类是由谁加载的，发现是根加载器
        ClassLoader gen = Class.forName("java.lang.Object").getClassLoader();
        System.out.println(gen);

        // 获取系统类加载器的路径
        System.out.println(System.getProperty("java.class.path"));
    }
}

3.4.6 获取类的运行时结构

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

import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Method;

//获得类的信息
public class Test07 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException, NoSuchMethodException {
        Class c1 = Class.forName("com.liu.reflection.User");

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

        //获得类的属性
        System.out.println("==============================");
        Field[] fields = c1.getFields();// 只能找到public属性

        fields = c1.getDeclaredFields();// 找到全部的属性
        for (Field field : fields){
            System.out.println(field);
        }

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

        //获得类的方法
        System.out.println("===================================");
        Method[] methods = c1.getMethods(); //获得本类及其父类的全部public方法
        for (Method method : methods) {
            System.out.println("正常的: "+method);
        }
        methods = c1.getDeclaredMethods(); //获得本类的所有方法
        for (Method method : methods) {
            System.out.println("getDeclaredMethods: "+method);
        }

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


        //获得类的构造器
        System.out.println("===================================");
        Constructor[] constructors = c1.getConstructors();//获得本类及其父类的全部public构造方法
        for (Constructor constructor : constructors) {
            System.out.println("正常的: "+constructor);
        }
        constructors = c1.getDeclaredConstructors(); //获得本类的构造方法
        for (Constructor constructor : constructors) {
            System.out.println("getDeclaredConstructors: "+constructor);
        }

        // 获得指定的构造器
        Constructor declaredConstructor = c1.getDeclaredConstructor(String.class, int.class, int.class);
        System.out.println("指定: "+declaredConstructor);
    }
}

3.4.7 通过反射动态创建对象

1.创建类的对象：调用Class对象的newInstance()方法

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

若没有无参构造器，则采用第二种方式：

• 通过Class类的getDeclaredConstructor取得本类的指定形参类型的构造器
• 向构造器的形参中传递一个对象数组进去，里面包含了构造器所需的各个参数
• 通过Constructor实例化对象

//动态创建对象，通过反射
public class Test08 {
    public static void main(String[] args) throws Exception {
        // 获得Class对象
        Class c1 = Class.forName("com.liu.reflection.User");
        //方式一：构造一个对象
        User user = (User) c1.newInstance(); //本质是调用了类的无参构造器
        System.out.println(user);

        //方式二：通过构造器创建对象
        Constructor constructor = c1.getDeclaredConstructor(String.class, int.class, int.class);
        User user2 = (User) constructor.newInstance("liuliu", 1, 20);
        System.out.println(user2);
    }
}

3.4.8 通过反射调用指定的方法、操作属性

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

		//创建一个User对象
        User user3 = (User)c1.newInstance();
        //通过反射获取一个方法
        Method setName = c1.getDeclaredMethod("setName", String.class);

        //invoke : 激活的意思
        //(对象, "方法的值")
        setName.invoke(user3, "liuliu");
        System.out.println(user3.getName());
        
        //通过反射操作属性
        User user4 = (User) c1.newInstance();
        Field name = c1.getDeclaredField("name");

        //不能直接操作私有属性，我们需要关闭程序的安全检测，让属性或者方法的setAccessible为true！
        name.setAccessible(true);
        name.set(user4,"liuliu");
        System.out.println(user4.getName());

3.4.9 反射操作泛型

ParameterizedType :表示一种参数化类型,比如Collection。
GenericArrayType :表示一种元素类型是参数化类型或者类型变量的数组类型。
TypeVariable :是各种类型变量的公共父接口。
WildcardType :代表一种通配符类型表达式。

import java.lang.reflect.Method;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.List;
import java.util.Map;

public class Test09 {

    public void test01(Map<String,User> map, List<User> list){
        System.out.println("test01");
    }

    public Map<String, User> test02(){
        System.out.println("test02");
        return null;
    }

    public static void main(String[] args) throws NoSuchMethodException {
        Method method = Test09.class.getMethod("test01", Map.class,List.class);
        Type[] genericParameterTypes =  method.getGenericParameterTypes();
        for (Type genericParameterType : genericParameterTypes) {
            System.out.println("#" + genericParameterType);
            if( genericParameterType instanceof ParameterizedType){
                Type[] actualTypeArguments = ((ParameterizedType) genericParameterType).getActualTypeArguments();
                for (Type actualTypeArgument : actualTypeArguments) {
                    System.out.println(actualTypeArgument);
                }
            }
        }
        System.out.println("==========================");
        method = Test09.class.getMethod("test02",null);
        Type genericReturnType =  method.getGenericReturnType();
        if( genericReturnType instanceof ParameterizedType){
            Type[] actualTypeArguments = ((ParameterizedType) genericReturnType).getActualTypeArguments();
            for (Type actualTypeArgument : actualTypeArguments) {
                System.out.println(actualTypeArgument);
            }
        }
    }
}

3.4.10 获得注解信息

import java.lang.annotation.*;
import java.lang.reflect.Field;

// 反射注解练习
public class Test10 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
        Class c1 = Class.forName("com.liu.reflection.Student2");

        // 通过反射获得注解  (类级别 的)  看看该类有哪些注解
        Annotation[] annotations = c1.getAnnotations();
        for (Annotation annotation : annotations) {
            System.out.println(annotation);
        }

        // 获得指定注解的值
        Tableliu tableliu = (Tableliu)c1.getAnnotation(Tableliu.class);
        String value = tableliu.value();
        System.out.println(value);

        System.out.println("=================================");

        // 获得字段指定注解  (字段级别 的)  看看每个字段字段有哪些注解
        Field[] declaredFields = c1.getDeclaredFields();  // 查看有哪些字段
        for (Field declaredField : declaredFields) {
            System.out.println(declaredField);
        }
        // 获取name字段有哪些注解
        Field name = c1.getDeclaredField("name");        
        Annotation[] annotations1 = name.getAnnotations();
        for (Annotation annotation : annotations1) {
            System.out.println(annotation);
        }

        //逐个打印出name字段的注解的值
        name = c1.getDeclaredField("name");
        Fieldliu annotation = (Fieldliu)name.getAnnotation(Fieldliu.class);
        System.out.println(annotation.columnName());
        System.out.println(annotation.type());
        System.out.println(annotation.length());
    }
}

//自定义注解

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

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


//定义一个类
@Tableliu("db_student")
class Student2{
    @Fieldliu(columnName = "db_id",type = "int", length = 10)
    private int id;
    @Fieldliu(columnName = "db_age",type = "int", length = 10)
    private int age;
    @Fieldliu(columnName = "db_name",type = "varchar", length = 3)
    private String name;

    public Student2() {}
    public Student2(int id, int age, String name) {
        this.id = id;
        this.age = age;
        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;}
    public String getName() {return name;}
    public void setName(String name) {this.name = name;}
    @Override
    public String toString() {
        return "Student2{id=" + id + ", age=" + age + ", name='" + name + '\'' +  '}';
    }
}