2021-07-23

注解和反射

注解

什么是注解

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

内置注解

public class Demo01 extends Object{
    //@Override  重写的注解
    @Override
    public String toString() {
        return super.toString();
    }
    //@Deprecated 不推荐程序员使用，但是可以使用，或者存在更好的方式
    @Deprecated
    public static void test(){
        System.out.println("Deprecated");
    }

    @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 < RUBTIME）
  • @Document：说明该注解将被包含在javadoc中
  • @Inherited：说明子类可以继承父类中的该注解

//测试元注解
public class Demo02 {
    @MyAnnotation
    public void test(){
    }
}
//定义一个注解
//Target 表示我们的注解可以用在哪些地方
@Target(value = {ElementType.METHOD,ElementType.TYPE})//可以用在方法和类上
//Retention  表示我们的注解什么地方还有效。
// runtime>class>sources(定义了成runtime后，class和sources都有效)
@Retention(value = RetentionPolicy.RUNTIME)

//@Documented 表示是否将我们的注解生成在JAVAdoc中
@Documented
//@Inherited 表示子类可以继承父类的注解
@Inherited
@interface MyAnnotation{
}

自定义注解

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

//自定义注解
public class Demo03 {
    //注解可以显示赋值，如果没有默认值，我们就必须要给注解赋值
    @MyAnnotation2(name = "烽子",schools = {"江湖"})
    public void test(){}

    @MyAnnotation3("")
    public void test2(){}
}

@Target({ElementType.TYPE,ElementType.METHOD})//可以作用在类上或方法上
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{//要知道注解怎么定义，参数类型，默认值
    //注解的参数：参数类型 + 参数名();
    String name() default "";//可以默认为空
    int age() default 0;
    int id() default -1;//如果默认值为-1，代表不存在，indexof,如果找不到就返回-1

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

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation3{
    String value();//注解里只有一个值的时候，默认用value
}

反射机制

静态 VS 动态语言

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

Reflection(反射)

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

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

Class类

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

Class类常用方法

• static ClassforName(String name)：返回指定类名name的Class对象
• Object newInstance()：调用缺省构造函数，返回Class对象的一个实例
• getName()：返回此Class对象所表示的实体（类，接口，数组类或void）的名称
• Class getSuperClass()：返回当前Class对象的父类的Class对象
• Class[] getinterfaces()：获取当前Class对象的接口
• ClassLoader getClassLoader()：返回该类的类加载器
• Constructor[] getConstructors()：返回一个包含某些Constructor对象的数组
• Method getMethod(String name,Class…T)：返回一个Method对象，此对象的形参类型为peramType
• Field[] getDeclareFields()：返回Field对象的一个数组

获取Class类的实例

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

  • Class clazz = Person.calss;
    

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

  • Class clazz = peraon.getClass();
    

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

  • Class clazz = Class.forNmae("demo01.Student");
    

• 内置基本数据类型可以直接用类名.Type

• 还可以利用ClassLoader

//测试Class类的创建方式有哪些
public class Demo05 {
    public static void main(String[] args) throws ClassNotFoundException {
        Person person = new Student();
        System.out.println("这个人是："+person.name);

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

        //方式二： forname获得
        Class<?> c2 = Class.forName("annotation.Student");
        System.out.println(c2.hashCode());//2133927002，两个是同一个对象

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

        //方式四：基本内置类型的包装类都有一个Type属性
        Class c4 = Integer.TYPE;
        System.out.println(c4);//int

        //获得父类类型
        Class c5 = c1.getSuperclass();
        System.out.println(c5);//class annotation.Person
    }
}

class Person{
    public String name;

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

    public Person() {
    }

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

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

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

哪些类型可以有Class对象

//所有类型的Class
public class Demo06 {
    public static void main(String[] args) {
        Class c1 = Object.class;//类
        Class c2 = Comparator.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);//class java.lang.Object
        System.out.println(c2);//interface java.util.Comparator
        System.out.println(c3);//class [Ljava.lang.String;
        System.out.println(c4);//class [[I
        System.out.println(c5);//interface java.lang.Override
        System.out.println(c6);//class java.lang.annotation.ElementType
        System.out.println(c7);//class java.lang.Integer
        System.out.println(c8);//void
        System.out.println(c9);//class java.lang.Class

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

类的加载与ClassLoader的理解

public class Demo07 {
    public static void main(String[] args) {
        A a = new A();
        System.out.println(A.m);
    /* 输出为：A类静态代码块初始化
              A类的静态无参构造初始化
              100
        过程：
          第一步.加载到内存，会产生一个类对应Class对象
          第二步.链接，链接结束后 m = 0；
          第三步.初始化对象时
                <clinit>(){
                    System.out.println("A类静态代码块初始化");
                    m = 300;
                    int m = 100;
                }
                初始化完了 m = 100；
           要知道Class对象是在什么时候产生的。
         */
    }
}
class A{
    static {//最先执行，m = 300
        System.out.println("A类静态代码块初始化");
        m = 300;
    }
    static int m = 100;//它在执行，m 就又为100了
    public A() {
        System.out.println("A类的静态无参构造初始化");
    }
}

什么时候会发生初始化？

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

//测试类什么时候会初始化
public class Demo08 {
    static {
        System.out.println("Main类被加载");
    }
    public static void main(String[] args) throws ClassNotFoundException {
        //1.主动引用
        //Son son = new Son();
        //反射也会产生主动引用
        //Class c1 = Class.forName("annotation.Son");

        //不会产生类的引用的方法(子类调用父类的静态的方法或静态的变量，并不会让子类初始化)
        //System.out.println(Son.b);

        //Son[] array = new Son[5];//Main类被加载，因为当虚拟机启动启动时，会先初始化main方法所在的类
        //System.out.println(Son.M);
    }
}
class Father{
    static int b = 2;
    static {
        System.out.println("父类被加载！");
    }
}
class Son extends Father{
    static {
        System.out.println("子类被加载！");
        m = 300;
    }
    static int m = 100;
    static final int M = 1;
}

类加载器的作用

获取运行时类的完整结构

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

Field，Method，Constructor，Superclass，Interface，Annotion

• 此类实现的接口
• 所继承的父类
• 全部的构造器
• 全部的方法
• 全部的Field
• 注解
• …

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

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

        User user = new User();//这种方式：通过对象也可以直接获得包名加类名
        c1 = user.getClass();

        //获得类的名字
        System.out.println(c1.getName());//获得包名加类名:annotation.User
        System.out.println(c1.getSimpleName());//获得类名:User

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

        fields = c1.getDeclaredFields();//找到全部属性
        for (Field field : fields) {
            System.out.println(field);
            /*
            private java.lang.String annotation.User.name
            private int annotation.User.id
            private int annotation.User.age
             */
        }
        //获得指定属性的值
        Field name = c1.getDeclaredField("name");
        System.out.println(name);//private java.lang.String annotation.User.name

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

        //获得指定方法
        //为什么这个方法需要参数，因为方法的重载，方法名都一样就无法判断了。
        Method getName = c1.getMethod("getName", null);
        Method setName = c1.getMethod("setName", String.class);
        System.out.println(getName);//public java.lang.String annotation.User.getName()
        System.out.println(setName);//public void annotation.User.setName(java.lang.String)

        //获得构造器
        System.out.println("============");
        Constructor[] constructors = c1.getConstructors();//获得public方法
        for (Constructor constructor : constructors) {
            System.out.println(constructor);
//            public annotation.User()
//            public annotation.User(java.lang.String,int,int)
        }
        constructors = c1.getDeclaredConstructors();//获得全部
        for (Constructor constructor : constructors) {
            System.out.println("##"+constructor);
        }

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

小结

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

有了Class对象能做什么？

• 创建类的对象：调用Class对象的newInstance()方法
  • 类必须有一个无参数的构造器。
  • 类的构造器的访问权限需要足够。

思考？难道没有无参构造器就不能创建对象了吗？只要在操作的时候明确的调用类中的构造器，并将参数传递进去之后，才可以实例化操作

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

调用指定的方法

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

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

//动态的创建对象，通过反射
public class Demo11 {
    public static void main(String[] args) throws ClassNotFoundException, InstantiationException, IllegalAccessException, NoSuchMethodException, InvocationTargetException, NoSuchFieldException {
        //获得Class对象
        Class c1 = Class.forName("annotation.User");

        //构造一个对象
        User user = (User) c1.newInstance();//本质是调用了类的无参构造器，user类中如果没有无参就会报错
        System.out.println(user);//User{name='null', id=0, age=0},都是默认的值

        //通过构造器创建对象
        Constructor declaredConstructor = c1.getDeclaredConstructor(String.class,int.class,int.class);
        User user2 = (User) declaredConstructor.newInstance("烽子", 001, 20);
        System.out.println(user2);//User{name='烽子', id=1, age=20}

        //通过反射调用普通方法
        User user3 =(User) c1.newInstance();
        //通过反射获取一个方法
        Method setName = c1.getDeclaredMethod("setName", String.class);
        //invoke ：激活的意思
        //（对象 , "方法的值"）
        //user3对象的setName方法，传入"江湖"，这个值。
        setName.invoke(user3,"江湖");
        System.out.println(user3.getName());//江湖

        //通过反射操作属性
        System.out.println("================");
        User user4 = (User) c1.newInstance();
        //获得name这个属性
        Field name = c1.getDeclaredField("name");
        //不能直接操作私有属性，我们需要关闭程序的安全检测，属性或方法的setAccessible(true)
        name.setAccessible(true);

        name.set(user4,"江湖2");
        System.out.println(user4.getName());
        
    }
}

setAccessible

• Method 和Field ， Construcor对象都有setAccessible()方法。

• setAccessible作用时启动和禁用访问安全检查的开关。

• 参数值为true则指示反射对象在使用时应该取消Java语言访问检查。

  • 提高反射的效率，如果代码中必须使用反射，而该句代码需要频繁的被调用，那么请设置为true。
  • 使得原本无法访问的私有成员也可以访问。

• 参数值为false则指示反射的对象应该实施Java语言访问检查。

//分析性能问题
public class Demo12 {
    //普通方式调用
    public static void test01(){
        User user = new User();
        long l1 = System.currentTimeMillis();
        for (int i = 0; i < 1000000000; i++) {
            user.getName();
        }
        long l2 = System.currentTimeMillis();
        System.out.println("普通方式执行10亿次："+(l2-l1)+"ms");

    }
    
    //反射方式调用
    public static void test02() throws NoSuchMethodException, InvocationTargetException, IllegalAccessException {
        User user = new User();
        Class c1 = user.getClass();
        Method getName = c1.getDeclaredMethod("getName", null);
        long l1 = System.currentTimeMillis();
        for (int i = 0; i < 1000000000; i++) {
            getName.invoke(user,null);
        }
        long l2 = System.currentTimeMillis();
        System.out.println("反射方式执行10亿次："+(l2-l1)+"ms");

    }
    //反射方式调用,关闭检测
    public static void test03() throws NoSuchMethodException, InvocationTargetException, IllegalAccessException {
        User user = new User();
        Class c1 = user.getClass();
        Method getName = c1.getDeclaredMethod("getName", null);
        getName.setAccessible(true);
        long l1 = System.currentTimeMillis();
        for (int i = 0; i < 1000000000; i++) {
            getName.invoke(user,null);
        }
        long l2 = System.currentTimeMillis();
        System.out.println("关闭检测,执行10亿次："+(l2-l1)+"ms");
    }
    public static void main(String[] args) throws InvocationTargetException, NoSuchMethodException, IllegalAccessException {
        test01();//普通方式执行10亿次：3ms
        test02();//反射方式执行10亿次：2705ms
        test03();//关闭检测,执行10亿次：1342ms
    }
}

反射操作泛型

//通过反射获取泛型
public class Demo13 {
    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 test01 = Demo13.class.getMethod("test01", Map.class, List.class);

        Type[] genericParameterTypes = test01.getGenericParameterTypes();//获得泛型的参数类型
        for (Type genericParameterType : genericParameterTypes) {
            System.out.println(genericParameterType);//java.util.Map<java.lang.String, annotation.User>
                                                     //java.util.List<annotation.User>
            if (genericParameterType instanceof ParameterizedType){
                Type[] actualTypeArguments = ((ParameterizedType) genericParameterType).getActualTypeArguments();
                for (Type actualTypeArgument : actualTypeArguments) {
                    System.out.println(actualTypeArgument);
                    /*
                        java.util.Map<java.lang.String, annotation.User>
                        class java.lang.String
                        class annotation.User
                        java.util.List<annotation.User>
                        class annotation.User
                     */
                }
            }
        }
        Method test02 = Demo13.class.getMethod("test02",null);
        Type genericReturnType = test02.getGenericReturnType();
        if (genericReturnType instanceof ParameterizedType){
            Type[] actualTypeArguments = ((ParameterizedType) genericReturnType).getActualTypeArguments();
            for (Type actualTypeArgument : actualTypeArguments) {
                System.out.println(actualTypeArgument);
                    /*
                       class java.lang.String
                       class annotation.User
                     */
            }
        }
    }
}

反射操作注解

//练习反射操作注解
public class Demo14 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
        Class c1 = Class.forName("annotation.Student2");

        //通过反射获得注解
        Annotation[] annotations = c1.getAnnotations();
        for (Annotation annotation : annotations) {
            System.out.println(annotation);//@annotation.Tablefeng(value=db_student)
        }

        //获得注解的value的值
        Tablefeng annotation = (Tablefeng) c1.getAnnotation(Tablefeng.class);
        String value = annotation.value();
        System.out.println(value);//db_student

        //获得类指定的注解
        Field name = c1.getDeclaredField("name");
        Fieldfeng annotation1 = name.getAnnotation(Fieldfeng.class);
        System.out.println(annotation1.columname());//db_name
        System.out.println(annotation1.type());//varchar
        System.out.println(annotation1.length());//3
    }
}
@Tablefeng("db_student")
class Student2{
    @Fieldfeng(columname = "db_id",type = "int",length = 10)
    private int id;
    @Fieldfeng(columname = "db_age",type = "int",length = 10)
    private int age;
    @Fieldfeng(columname = "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;
    }
    @Override
    public String toString() {
        return "Student2{" +
                "id=" + id +
                ", age=" + age +
                ", 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;
    }
}

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

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