注解与反射

注解与反射

什么是注解

• Annotation的作用：
  • 不是程序本身，可以对程序做出解释
  • 可以被其他程序（比如编译器等）读取
• Annotation的格式
  • 注解是以“@注解名”在代码中存在的，还可以添加一些参数值，例如：@Suppress Warnings（value=“unchecked”）
• 注解在那里使用
  • 可以附加在package，class，methid，field等上面，相当于给他们太农家乐额外的辅助信息，我们可以通过反射机制百年城实现对这些元数据的访问

//测试注解，什么是注解
//@SuppressWarnings("all")
public class Test01 extends Object{
    //Override,重写的注解
    @Override
    public String toString() {
        return super.toString();
    }

    //Deprecated,不推荐程序员使用，或者有更好的方法
    @Deprecated
    public static void Test(){
        System.out.println("Deprecated");
    }
    //SuppressWarnings，镇压警告，可以放在方法上，也可以放在类上
    //@SuppressWarnings("all")
    public void Test02(){
        List list = new ArrayList();
    }
    public static void main(String[] args) {
        Test();
    }
}

元注解

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

//定义一个注解
//Target表示我们的注解可以放在哪些地方
@Target(value = {ElementType.METHOD,ElementType.TYPE})
//Retention,表示我们的注解的生命周期
@Retention(value = RetentionPolicy.RUNTIME)
//Inherited表示子类可以继承父类的该注解
@Inherited
//Documented表示是否将我们的注解生成在Javadoc中
@Documented
@interface MyAnnotation {

}

自定义注解

//自定义注解
public class Test03 {
    //注解可以显式赋值
    //参数没有顺序
    @MyAnnotation2(name = "ss",schools = {"西北大学","西工大"})
    public void test(){

    }

    //如果注解只有一个参数，参数名一般定义为value，在写参数时不用写value=""
    @MyAnnotation3("ss")
    public void test2(){

    }
}

@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{
    //注解的参数    参数类型 + 参数名 （）;
    String name() default "";//默认值

    int age() default 0;

    int id() default -1;//如果默认值为-1 表示不存在

    String[] schools() default {"清华","西工大"};
}

@Target({ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3{
    //如果注解只有一个参数，参数名一般定义为value
    String value();
}

反射机制

• Reflection（反射）是Java被设为准动态语言的关键，反射机制允许程序在执行期间借助Reflection API取得任何类的内部信息，并且直接操作任意对象的内部属性及方法
• 加载完类之后，在堆内存的方法区中就产生了一个Class类型的对象（一个类只有一个Class对象），这个对象就包含了完整的类的结构信息。我们可以通过这个对象看到类的结构。这个对象就像一面镜子，透过这个镜子看到类的结构，所以我们形象的称之为：反射

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反射的源头，实际上所谓的反射从程序的运行结果来看也好理解，即：可以通过对象反射求出类的名称

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

哪些类型可以有Class对象

• class：外部类，成员（成员内部类，静态内部类），局部内部类，匿名内部类

• interface：接口

• []：数组

• enum:枚举

• annotation：注解

• primitive type:基本数据类型

• void

• 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对象的方法

  //方式一：通过对象获得
  Class c1 = person.getClass();
  System.out.println(c1.hashCode());
  
  //方式二：forname获得
  Class c2 = Class.forName("com.edu.xaut.reflection.Student");
  System.out.println(c2.hashCode());
  
  //方式三：通过类名.class获得
  Class c3 = Student.class;
  System.out.println(c3.hashCode());
  
  //方式四：基本内置类型的包装类都有一个Type属性
  Class c4 = Integer.TYPE;
  System.out.println(c4);
  
  //获得父类类型
  Class c5 = c1.getSuperclass();
  System.out.println(c5);
  Class<Class> classClass = Class.class;
  System.out.println(classClass);
  

Java内存分析

类的加载与ClassLoader的理解

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

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

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

类加载器的作用

• 类加载的作用：将class文件字节码内容加载到内存中，并将这些静态数据转换成方法区的运行时数据结构，然后在堆中生成一个代表这个类的java.lang.Class对象，作为方法区中类数据的访问入口
• 类缓存：标准的JavaSE类加载器可以按要求查找类，但一旦某个类被加载到类加载器中，它将维持加载（缓存）一段时间。不过JVM垃圾回收机制可以回收这些Class对象。

获取运行时类的完整结构

//获取类的信息
public class Test07{

        public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException, NoSuchMethodException {
            Class c1 = Class.forName("com.edu.xaut.reflection.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(field);
            }

            Field name = c1.getDeclaredField("name");//获得指定名字的属性
            System.out.println(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(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);
            }
            //获得本类的全部构造方法
            Constructor[] declaredConstructors = c1.getDeclaredConstructors();
            for (Constructor declaredConstructor : declaredConstructors) {
                System.out.println(declaredConstructor);
            }
            //获得指定的构造器
            Constructor constructor = c1.getConstructor(String.class, int.class, int.class);
            System.out.println("指定构造器"+constructor);
            

        }
}

小结

• 在实际操作中，取得类的信息的操作代码，并不会经常开发
• 一定要熟悉java.lang.reflect包的作用，反射机制
• 如何取得属性、方法、构造器的名称，修饰符等。

有了Class对象，能做什么？

• 创建类的对象：调用Class对象的newInstance()方法，本质调用了类的无参构造器

  • 类必须有一个无参构造器
  • 类的构造器的访问权限需要足够
  • 思考难道没有无参构造器就不能创建对象了吗？只要在操作的时候明确的调用类中的构造器，并将参数床i进入之后，才可以实例化操作

• 反射获取构造器创建对象步骤如下：

  • Class对象可以直接newInstance()，不过是调用无参构造器

  • 获取Class对象

  • getDeclaredConstructor(String.class…),获得指定的构造器

  • 利用此构造器的newInstance()方法创建一个对象，方法的参数是构造器所需要的参数。

  • //通过指定构造器创建对象
    Constructor constructor = c1.getDeclaredConstructor(String.class, int.class, int.class);
    User user2 = (User) constructor.newInstance("gfq",11,21);
    System.out.println(user2);
    System.out.println(user2.getAge());
    

• 反射调用方法步骤如下

  • 利用反射创建一个对象

  • getDeclaredMethod(name，参数.class)方法获得指定方法

  • method.invoke(对象，参数)，激活方法

  • //通过反射调用普通方法
    User user3 = (User) c1.newInstance();
    //通过反射获取一个方法
    Method setName = c1.getDeclaredMethod("setName", String.class);
    //激活一个函数，（对象，“方法的值”）
    setName.invoke(user3,"ttt");
    System.out.println(user3.getName());
    

• 反射获取属性步骤如下

  • 通过反射获取对象

  • getDeclaredField(属性名)，获取指定属性

  • 调用属性或方法的setAccessible(true),关闭程序安全检查，私有属性权限不够

  • field.set(对象，参数),可以设置属性名

  • //通过反射操作属性
    User user4 = (User) c1.newInstance();
    Field name = c1.getDeclaredField("name");//获取指定属性
    
    name.setAccessible(true);//私有属性权限不够,关闭权限检测
    //不能直接操作私有属性，我们需要关闭程序的安全检测，属性或方法的setAccessible(true)
    name.set(user4,"tjj");//user4对象的name属性
    System.out.println(user4.getName());
    

setAccessible

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

反射操作函数，有无取消安全检查的性能对比（提升2-3倍）

//测试普通方式和反射以及关闭安全检查时的性能
public class Test09 {
    //普通方式
    public static void test01(){
        User user = new User();

        long startTime = currentTimeMillis();
        for (int i = 0; i < 1000000000; i++) {
            user.getName();
        }
        long endTime = currentTimeMillis();
        System.out.println("普通方式执行时间"+(endTime-startTime)+"ms");

    }

    //反射方式
    public static void test02() throws ClassNotFoundException, NoSuchMethodException, InvocationTargetException, IllegalAccessException {
        User user = new User();
        Class c1 = Class.forName("com.edu.xaut.reflection.User");
        Method getName = c1.getDeclaredMethod("getName",null);
        long startTime = currentTimeMillis();
        for (int i = 0; i < 1000000000; i++) {
            getName.invoke(user,null);
        }
        long endTime = currentTimeMillis();
        System.out.println("反射方式执行时间"+(endTime-startTime)+"ms");
    }

    //关闭安全检测的反射方式
    public static void test03() throws ClassNotFoundException, NoSuchMethodException, InvocationTargetException, IllegalAccessException {
        User user = new User();
        Class c1 = Class.forName("com.edu.xaut.reflection.User");
        Method getName = c1.getDeclaredMethod("getName",null);//这个null可写可不写
        getName.setAccessible(true);
        long startTime = currentTimeMillis();
        for (int i = 0; i < 1000000000; i++) {
            getName.invoke(user,null);
        }
        long endTime = currentTimeMillis();
        System.out.println("关闭安全检测的反射方式执行时间"+(endTime-startTime)+"ms");
    }

    public static void main(String[] args) throws ClassNotFoundException, InvocationTargetException, NoSuchMethodException, IllegalAccessException {
        test01();
        test02();
        test03();
    }
}

反射操作范型

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

1. 通过Class对象获得方法
2. 通过这个方法获得它的泛型参数类型或者返回类型
3. 判断这个类型是否为参数化类型，如果是则强制转换为参数化类型（ParameterizedType）
4. 强制转换后调用getActualTypeArguments获得真实类型

//通过反射获取泛型
public class Test10 {
    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 void test03(int i){}//测试非参数化类型是怎样的

    public static void main(String[] args) throws NoSuchMethodException {
        //利用Class对象获取方法
        Method test01 = Test10.class.getDeclaredMethod("test01", Map.class,List.class);
        //利用方法getGenericParameterTypes来获取泛型的参数类型
        Type[] genericParameterTypes = test01.getGenericParameterTypes();
        for (Type genericParameterType : genericParameterTypes) {
            System.out.println("#"+genericParameterType);
            //判断泛型的参数类型是否为参数化类型
            if(genericParameterType instanceof ParameterizedType){
                //如果是，就强制转换为参数化类型，然后通过getActualTypeArguments来获得真实类型
                Type[] actualTypeArguments = ((ParameterizedType)  genericParameterType).getActualTypeArguments();
                for (Type actualTypeArgument : actualTypeArguments) {
                    System.out.println(actualTypeArgument);
                }
            }
        }
        System.out.println("==============");
        //测试返回值为参数化类型
        Method test02 = Test10.class.getDeclaredMethod("test02", null);
        Type genericReturnType = test02.getGenericReturnType();//获得返回值类型
        if(genericReturnType instanceof ParameterizedType){
            //如果是，就强制转换为参数化类型，然后通过getActualTypeArguments来获得真实类型
            Type[] actualTypeArguments = ((ParameterizedType)  genericReturnType).getActualTypeArguments();
            for (Type actualTypeArgument : actualTypeArguments) {
                System.out.println(actualTypeArgument);
            }
        }
    }
}

反射操作注解

1. 获得目标类的Class对象

2. 通过Class对象获得类的注解（getAnnotations）

3. 获得指定注解并进行强制类型转换，从而获得注解具体的值

4. GfqTableAnnotation annotation =(GfqTableAnnotation) c1.getAnnotation(GfqTableAnnotation.class);//参数是想要获取value值的注解的class
   String value = annotation.value();
   System.out.println(value);
   

5. 获得属性上的注解，先获得该属性，然后调用getAnnotation方法，传入具体的注解的类

6. Field id = c1.getDeclaredField("id");
   GfqFieldAnnotation annotation1 = id.getAnnotation(GfqFieldAnnotation.class);//获得指定类的注解
   System.out.println(annotation1.columnName());
   System.out.println(annotation1.type());
   System.out.println(annotation1.length());