注解与反射

注解与反射

注解

• Annotation是从JDK5.0开始引入的新技术.
• Annotation的作用︰
  • 不是程序本身，可以对程序作出解释.(这一点和注释(comment)没什么区别)
  • 可以被其他程序（比如：编译器）读取
• Annotation的格式：
  • 注解是以"@注释名"在代码中存在的，还可以添加一些参数值﹐例如:@SuppressWarnings(value=“unchecked”).
• Annotation使用：
  • 可以附加在package , class , method , field等上面﹐相当于给他们添加了额外的辅助信息,我们可以通过反射机制编程实现对这些元数据的访问

内置注解

• @Override:定义在java.lang.Override 中,此注释只适用于修辞方法，表示一个方法声明打算重写超类中的另一个方法声明.
• @Deprecated:定义在java.lang.Deprecated中,此注释可以用于修辞方法﹐属性﹐类，表示不鼓励程序员使用这样的元素﹐通常是因为它很危险或者存在更好的选择.
• SuppressWarnings:定义在java.lang.SuppressWarnings中,用来抑制编译时的警告信息.
  • 与前两个注释有所不同,你需要添加一个参数才能正确使用,这些参数都是已经定义好了的，我们选择性的使用就好了﹒
  • @SuppressVarnings(“all”)
  • @SuppressWarnings(“unchecked”)
  • @SuppressWarnings(value={“unchecked”,“deprecation”})
  • 等等…

元注解

• 元注解的作用就是负责注解其他注解，Java定义了4个标准的meta-annotation类型,他们被用来提供对其他annotation类型作说明．
• 这些类型和它们所支持的类在java.lang.annotation包中可以找到.( @Target , @Retention ,@Documented , @Inherited )
  • @Target：用于描述注解的使用范围(即:被描述的注解可以用在什么地方)
  • @Retention：表示需要在什么级别保存该注释信息﹐用于描述注解的生命周期
    • (SOURCE< CLASS < RUNTIME)
  • @Document：说明该注解将被包含在javadoc中
  • @lnherited：说明子类可以继承父类中的该注解

package com.zy.demo01;

import java.lang.annotation.*;

public class TestIF {

    public void Test01(){}

}
//被描述的注解可以用在什么地方，ElementType.METHOD在方法上，ElementType.TYPE，可以放在类上使用
@Target(value = {ElementType.METHOD,ElementType.TYPE})

//表示注解在什么时候还有效
@Retention(value = RetentionPolicy.RUNTIME)

//说明该注解被包含在javadoc中
@Deprecated

//说明子类可以继承父类中的该注解
@Inherited
@interface MyAnnotation{

}

自定义注解

• 使用@interface自定义注解时﹐自动继承了java.lang.annotation.Annotation接
• 分析∶
  • interface用来声明一个注解，格式: public @interface注解名{定义内容}。
  • 其中的每一个方法实际上是声明了一个配置参数。
  • 方法的名称就是参数的名称。
  • 返回值类型就是参数的类型(返回值只能是基本类型,Class , String , enum )。
  • 可以通过default来声明参数的默认值。
  • 如果只有一个参数成员，一般参数名为value。
  • 注解元素必须要有值，我们定义注解元素时，经常使用空字符串,0作为默认值。

package com.zy.demo01;

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

//自定义注解
public class Test2 {
    //注解可以赋值，如果没有默认值，必须自己赋值、
    @MyAnnotation01(age = 18,name = "左右")
    public void Test01(){

    }
    //注解只有一个值时，用value命名，可以省略
    @MyAnnotation02("左右")
    public void Test02(){

    }
}

@Target(value = {ElementType.METHOD,ElementType.TYPE})
@Retention(value = RetentionPolicy.RUNTIME)
@interface MyAnnotation01{
    //注解参数格式: 参数类型 + 参数名（）;
    //default是设置参数默认值
    String name() default "";
    int age() ;
    int id() default -1;//如果默认值为-1，代表不存在

    String[] schools() default {"清华大学","北京大学"};
}

@Target(value = {ElementType.METHOD,ElementType.TYPE})
@Retention(value = RetentionPolicy.RUNTIME)
@interface MyAnnotation02{
    //如果注解只有一个值，可以用value命名，同时使用时可以省略value值
    String value();
}

反射

Java Reflection

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

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

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

静态 VS 动态语言

• 动态语言
  • 是一类在运行时可以改变其结构的语言:例如新的函数、对象、甚至代码可以被引进，已有的函数可以被删除或是其他结构上的变化。通俗点说就是在运行时代码可以根据某些条件改变自身结构。
  • 主要动态语言:Object-C、C#、JavaScript、PHP、Python等。
• 静态语言
  • 与动态语言相对应的，运行时结构不可变的语言就是静态语言。如Java、C、C++。
  • Java不是动态语言，但Java可以称之为“准动态语言”。即Java有一定的动态性，我们可以利用反射机制获得类似动态语言的特性。Java的动态性让编程的时候更加灵活!

反射的优缺点

• 优点：可以实现动态创建对象和编译，体现出很大的灵活性。
• 缺点：对性能有影响。使用反射基本上是一种解释操作，我们可以告诉JVM，我们希望做什么并且它满足我们的要求。这类操作总是慢于直接执行相同的操作。

反射相关的主要API

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

Class类

• 在Object类中定义了以下方法，此方法将被所有子类继承

public final Class getClass()

以上的方法返回值的类型是一个Class类，此类是Java反射的源头，实际上所谓反射从程序的运行结果来看也很好理解，即:可以通过对象反射求出类的名称。

• 对象照镜子后可以得到的信息:某个类的属性、方法和构造器、某个类到底实现了哪些接口。对于每个类而言，JRE都为其保留一个不变的Class类型的对象。一个Class对象包含了特定某个结构(class/interface/enum/annotation/primitive type/void/)的有关信息。
  • Class本身也是一个类
  • Class 对象只能由系统建立对象
  • 一个加载的类在JVM中只会有一个Class实例
  • 一个Class对象对应的是一个加载到JVM中的一个.class文件
  • 每个类的实例都会记得自己是由哪个Class 实例所生成
  • 通过Class可以完整地得到一个类中的所有被加载的结构
  • Class类是Reflection的根源，针对任何你想动态加载、运行的类，唯有先获得相应的Class对象

Class类的常用方法

获取Class类的实例

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

Class clazz = Person.class;

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

Class clas = Person.getClass();

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

Class clas = Class.forName("demo01.Student");

• 内置基本数据类型可以直接用类名.type
• 还可以利用ClassLoader，后面讲解

package com.zy.demoReflection;

//class类获取实例方法
public class Test01 {
    public static void main(String[] args) throws ClassNotFoundException {
        Person person = new Student();
        System.out.println("对象是："+person.name);

        //方法1：通过class属性获取
        Class c1 = Student.class;
        System.out.println("c1:"+c1.hashCode());

        //方法2：通过getClass()方法
        Class c2 = person.getClass();
        System.out.println("c2:"+c2.hashCode());

        //方法3：用forName(),需要目录
        Class c3 = Class.forName("com.zy.demoReflection.Student");
        System.out.println("c3:"+c3.hashCode());

        //方法4：内置基本数据类型都有一个type属性
        Class c4 = Integer.TYPE;
        System.out.println("c4的类:"+c4);
    }
}

class Person{
    String name;

    public Person() {
    }

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

class Student extends Person{

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

有Class对象的类型

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

package com.zy.demoReflection;

import java.lang.annotation.ElementType;

public class Test02 {
    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());
    }
}

结果图：

类的加载与ClassLoader的理解

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

什么时候发生类初始化

• 类的主动引用（一定会发生类的初始化）
  • 当虚拟机启动，先初始化main方法所在类。
  • new一个类的对象。
  • 调用类的静态成员（除了final常量）和静态方法。
  • 使用java.lang.reflect包的方法对类进行反射调用
  • 当初始化一个类，如果其父类没有被初始化，则先会初始化它的父类。
• 类的被动引用（不会发生类的初始化）
  • 当访问一个静态域时，只有真正声明这个域的类才会被初始化。如：当通过子类引用父类的静态变量，不会导致子类初始化。
  • 通过数组定义类引用，不会触发此类的初始化。
  • 引用常量不会触发此类的初始化（常量在链接阶段就存入调用类的常量池中了）。

类加载器的作用

• 类加载的作用:将class文件字节码内容加载到内存中，并将这些静态数据转换成方法区的运行时数据结构，然后在堆中生成一个代表这个类的java.lang.Class对象，作为方法区中类数据的访问入口。
• 类缓存:标准的JavaSE类加载器可以按要求查找类，但一旦某个类被加载到类加载器中，它将维持加载（缓存)一段时间。不过JVM垃圾回收机制可以回收这些Class对象。
• 类加载器作用是用来把类(class)装载进内存的。JVM规范定义了如下类型的类的加载器。
  • 引导类加载器：用C++编写的，是JVM自带的类加载器，负责Java平台核心库，用来装载核心类库。该加载器无法直接获取。
  • 扩展类加载器：负责jre/lib/ext目录下的jar包或-D java.ext.dirs指定目录下的jar包装入工作库。
  • 系统类加载器:负责java -classpath或-D java.class.path所指的目录下的类与jar包装入工作，是最常用的加载器

package com.zy.demoReflection;

public class TestLoader {

    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 classLoader = Class.forName("com.zy.demoReflection.Test02").getClassLoader();
        System.out.println(classLoader);

        //测试jdk内置类是哪个加载器加载的(根加载器)
        ClassLoader classLoader1 = Class.forName("java.lang.Object").getClassLoader();
        System.out.println(classLoader1);

        //获取系统类加载器可以加载的路径
        System.out.println(System.getProperty("java.class.path"));
        
        //双亲委派机制，如果在上面查出的路径中已有的，再定义相同名字的类，会先取已有的路径class
    }
}

获得类的运行结构

• 通过反射获取运行时类的完整结构

package com.zy.demoReflection;

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

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

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

        //获得类的属性
        System.out.println("============================");
        Field[] fields = c1.getFields();//只能打印public的属性
        for (Field field : fields) {
            System.out.println(field);
        }

        fields = c1.getDeclaredFields();//所有都能打印
        for (Field field : fields) {
            System.out.println("df:"+field);
        }

        //获得指定属性
        System.out.println("============================");
        Field id = c1.getField("id");//只能获得public
        System.out.println(id);

        Field name = c1.getDeclaredField("name");//随便什么类型
        System.out.println("df:"+name);

        //获得类的方法
        System.out.println("============================");
        Method[] methods = c1.getMethods();//获得所有public的方法,已经父类的public方法
        for (Method method : methods) {
            System.out.println(method);
        }
        methods = c1.getDeclaredMethods();//获得所有的方法
        for (Method method : methods) {
            System.out.println("dm:"+method);
        }

        //获取指定方法
        System.out.println("============================");
        Method method = c1.getMethod("getName");
        System.out.println(method);

        Method method2 = c1.getMethod("setName", String.class);
        System.out.println(method2);

        //获得构造器
        System.out.println("============================");
        Constructor[] constructors = c1.getConstructors();
        for (Constructor constructor : constructors) {
            System.out.println(constructor);
        }

        constructors = c1.getDeclaredConstructors();
        for (Constructor constructor : constructors) {
            System.out.println("dc:"+constructor);
        }
    }
}

有Class对象后

• 创建类的对象：调用Class对象的newInstance()方法
  1. 类必须有一个无参数的构造器
  2. 类的构造器的访问权限需要足够
• 没有无参构造器，步骤
  1. 通过Class类的getDeclaredConstructor(Class … parameterTypes)取得本类的指定形参类型的构造器
  2. 向构造器的形参中传递一个对象数组进去，里面包含了构造器中所需要的各个参数
  3. 通过Constructor实例化对象。

package com.zy.demoReflection;

import java.lang.reflect.Constructor;
import java.lang.reflect.InvocationTargetException;

public class Test04 {
    public static void main(String[] args) throws ClassNotFoundException, IllegalAccessException, InstantiationException, NoSuchMethodException, InvocationTargetException {
        //获取Class对象
        Class c1 = Class.forName("com.zy.demoReflection.User");
        //构造一个对象
        User user =(User)c1.newInstance();//本质是调用无参
        System.out.println(user);

        //用构造器创建对象
        Constructor constructor = c1.getDeclaredConstructor(String.class, int.class, int.class);
        User user1 = (User) constructor.newInstance("左右", 23, 31);
        System.out.println(user1);
        
        //通过反射调用普通方法
        User user3 =(User)c1.newInstance();
        //通过反射获取一个方法
        Method setName = c1.getDeclaredMethod("setName", String.class);
        setName.invoke(user3, "左右");
        System.out.println(user3.getName());
         //invoke(对象，“方法的值”) 激活方法
        
        //通过反射操作属性
        User user4 = (User) c1.newInstance();
        Field name = c1.getDeclaredField("name");
        //不能直接操作私有属性，需要先关闭程序的安全检测，属性或者方法的
        name.setAccessible(true);//关闭程序的安全检测
        name.set(user4,"左右1");
        System.out.println(user4.getName());
    }
}

setAccessible

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

反射操作泛型

• Java采用泛型擦除的机制来引入泛型，Java中的泛型仅仅是给编译器javac使用的,确保数据的安全性和免去强制类型转换问题，但是，一旦编译完成,所有和泛型有关的类型全部擦除。
• 为了通过反射操作这些类型，Java新增了ParameterizedType , GenericArrayType ，TypeVariable和WildcardType几种类型来代表不能被归一到Class类中的类型但是又和原始类型齐名的类型.
  • ParameterizedType:表示一种参数化类型,比如Collection
  • GenericArrayType :表示一种元素类型是参数化类型或者类型变量的数组类型
  • TypeVariable:是各种类型变量的公共父接口
  • WildcardType:代表一种通配符类型表达式

package com.zy.demoReflection;

import java.lang.reflect.Method;
import java.lang.reflect.ParameterizedType;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.Map;
//反射操作泛型
public class Test05 {

    public void Test001(Map<String,User> map, ArrayList<User> arrayList){
        System.out.println("Test001");
    }

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

    public static void main(String[] args) throws NoSuchMethodException {
        Method method = Test05.class.getMethod("Test001", Map.class, ArrayList.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 = Test05.class.getMethod("Test002");
        Type genericParameterType = method.getGenericReturnType();//获取返回类型
            if(genericParameterType instanceof ParameterizedType) {//判断参数具体类型
                Type[] actualTypeArguments = ((ParameterizedType) genericParameterType).getActualTypeArguments();
                for (Type actualTypeArgument : actualTypeArguments) {
                    System.out.println("##:" + actualTypeArgument);
                }
            }
    }
}

反射操作注解

package com.zy.demoReflection;

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

//反射操作注解
public class Test99 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
        Class c1 = Class.forName("com.zy.demoReflection.Student01");
        //通过反射获得注解
        Annotation[] annotations = c1.getAnnotations();//只获得了类的注解
        for (Annotation annotation : annotations) {
            System.out.println(annotation);
        }

        //直接得到注解里的值
        TableValue tableValue =(TableValue) c1.getAnnotation(TableValue.class);
        String value = tableValue.value();
        System.out.println(value);

        //获取属性的注解
        Field name = c1.getDeclaredField("name");
        FieldValue annotation = name.getAnnotation(FieldValue.class);
        System.out.println(annotation.columnName());
        System.out.println(annotation.type());
        System.out.println(annotation.length());
    }
}
@TableValue("db_student01")
class Student01{
    @FieldValue(columnName = "db_name",type = "varchar",length = 4)
    private String name;
    @FieldValue(columnName = "db_id",type = "int",length = 10)
    private int id;
    @FieldValue(columnName = "db_age",type = "int",length = 3)
    private int age;

    public Student01() {
    }

    public Student01(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 "Student01{" +
                "name='" + name + '\'' +
                ", id=" + id +
                ", age=" + age +
                '}';
    }
}

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

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