注解与反射

202 阅读11分钟

持续创作,加速成长!这是我参与「掘金日新计划 · 6 月更文挑战」的第6天,点击查看活动详情

1.1、什么是注解

  • Annotation是从JDK5.0开始引入的新技术

  • Annotation的作用:

    • 不是程序本身,可以对程序作出解释(这一点和注释(conmment)没什么区别)
    • 可以被其他程序(比如:编译器等)读取
  • Annotation的格式:

    • 注解是以"@注释名"在代码中存在的,还可以添加一些参数值,例如:@SuppressWarnings(value = "unchecked")
  • Annotation在哪里使用?

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

1.2、内置注解

三个内置注解:Override, Deprecated,SuppressWarnings

 //什么是注解
 public class Test01 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) {
         //new Test01().test();
         test(); //test()方法加上static就可以直接调用
     }
 }

1.3、元注解

  • 元注解的作用就是负责注解其他的注解,java定义了4个标准的meta-annotation类型,他们被用来提供对其他annotation类型作说明。

  • 这些类型和它们所支持的类在java.lang.annotation包中可以找到。(@Target,@Retention,@Document,@Inherited)

    • @Target:用于描述注解的使用范围(即被描述的注解可以用在什么地方)

    • @Retention:表示需要在什么级别保存该注释信息,用于描述注解的生命周期

      • (SOURCE<CLASS<RUNTIME
    • @Document:说明该注释将被包含在javadoc中

    • @Inherited:说明子类可以继承父类中的该注释

 //测试 元注解
 @MyAnnotation
 public class Test02 {
 ​
     public void test(){
 ​
     }
 }
 ​
 //定义一个注解
 //Target    表示我们的注解可以用在什么地方
 @Target(value = {ElementType.METHOD,ElementType.TYPE})
 ​
 //Retention 表示我们的注解在什么地方还有效
 //RUNTIME>CLASS>SOURCE
 @Retention(value = RetentionPolicy.SOURCE)
 ​
 //Documented  表示是否将我们的注解生成在javadoc中
 @Documented
 //Inherited 子类可以继承父类的注解
 @Inherited
 @interface MyAnnotation{
 ​
 }

1.4、自定义注解

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

  • 分析:

    • @interface用来声明一个注解,格式public @ interface 注释名 {定义内容}
    • 其中的每一个方法实际上是声明了一个配置函数
    • 方法的名称就是就是参数的名称
    • 返回值类型就是参数的类型(返回值只能是基本类型:Class,String,enum)
    • 可以通过default来声明参数的默认值
    • 如果只有一个参数成员,一般参数名为value
    • 注解元素必须要有值,我们定义注解元素时,经常使用空字符串,0作为默认值
 //自定义注解
 public class Test03 {
     //如果有default,就可以不用赋值
     @MyAnnotation2(age = 23)
     public void test(){
 ​
     }
     @MyAnnotation3("rop") //只有参数是value时,才可以不写参数名
     public void test2(){
 ​
     }
 }
 ​
 @Target(value = {ElementType.ANNOTATION_TYPE,ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)
 @interface MyAnnotation2{
     //注解的参数:参数类型 + 参数名()
     String name() default "";
     int age();
     int id() default -1; //默认值为-1,代表不存在
     String[] school() default {"清华大学","西部开源"};
 }
 ​
 @Target(value = {ElementType.ANNOTATION_TYPE,ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)
 @interface MyAnnotation3{
     String value();
 }

1.5、反射

 //什么是反射
 public class Test01 {
     public static void main(String[] args) throws ClassNotFoundException {
         //通过反射来获取类的Class对象
         Class c1 = Class.forName("com.rop.reflection.User");
         System.out.println(c1);
 ​
         Class c2 = Class.forName("com.rop.reflection.User");
         Class c3 = Class.forName("com.rop.reflection.User");
         Class c4 = Class.forName("com.rop.reflection.User");
 ​
         //一个类在内存中只有一个Class对象
         //一个类被加载后,整个类的结构都被封装在Class对象中
         System.out.println(c2.hashCode());
         System.out.println(c3.hashCode());
         System.out.println(c4.hashCode());
     }
 }
 ​
 //实体类:pojo  entity
 class User{
     private int id;
     private String name;
     private int age;
 ​
     public User() {
     }
 ​
     public User(int id, String name, int age) {
         this.id = id;
         this.name = name;
         this.age = 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;
     }
 ​
     @Override
     public String toString() {
         return "User{" +
                 "id=" + id +
                 ", name='" + name + ''' +
                 ", age=" + age +
                 '}';
     }
 }

1.6、Class类

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

  • Class本身也是一个类
  • Class对象只能由系统建立对象
  • 一个加载的类在JVM中只会有一个Class实例
  • 一个Class对象对应的是一个加载到JVM中的一个.class文件
  • 每个类的实例都会记得自己是由哪个Class实例所生成
  • 通过Class可以完整地得到一个类中的所有被加载的结构
  • CLass类是Reflection的根源,针对任何你想动态加载,运行的类,唯有先获得相应的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 getMothed(String name,Class.. T)返回一个Method对象,此对象的形参类型为paramType
Field[] getDeclaredFields()返回Field对象的一个数组

获取Class类的实例

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

     Class cla = Person.class;
    
  2. 已知某个类的实例,调用该实例的getClass()方法获取Class对象

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

     Class cla = Class.forName("demo01.Student");
    
  4. 内置基本数据类型可以直接用类名.Type

  5. 还可以利用ClassLoader

 public class Test02 {
     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());
 ​
         //方式二:forName获得
         Class c2 = Class.forName("com.rop.reflection.Student");
         System.out.println(c2.hashCode());
 ​
         //方式三:类名获取
         Class c3 = Student.class;
         System.out.println(c3.hashCode());
 ​
         //方式四:基本内置类型的包装类都有一个Type属性
         Class c4 = Integer.TYPE;
         System.out.println(c4); //得到c4的类型
 ​
         //获得父类类型
         Class c5 = c1.getSuperclass();
         System.out.println(c5);
     }
 }
 ​
 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 = "老师";
     }
 }

哪些类型可以有Class对象?

  • class:外部类,成员(成员内部类,静态内部类),局部内部类,匿名内部类
  • interface:接口
  • []:数组
  • enum:枚举
  • annotation:注解@interface
  • primitive type:基本数据类型
  • void
//所有类型的class
public class Test03 {
    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());
    }
}

1.7、类加载内存分析

image-20220404113028420.png

public class Test04 {
    public static void main(String[] args) {
        A a = new A();
        System.out.println(A.m);
        /*
        * 1.加载到内存,会产生一个类对应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.8、什么时候会发生类初始化

  • 类的主动引用(一定会发生类的初始化)

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

    • 当访问一个静态域时,只有真正声明这个域的类才会被初始化。如:当通过子类引用父类的静态变量,不会导致子类初始化
    • 通过数组定义类引用,不会触发此类的初始化
    • 引用常量不会触发此类的初始化(常量在链接阶段就存入调用类的常量池中)
//测试类什么时候会初始化
public class Test05 {
    static {
        System.out.println("main类被加载");
    }

    public static void main(String[] args) throws ClassNotFoundException {
        //1.主动引用
        //Son son = new Son();

        //2.反射也可以产生主动引用
        //Class.forName("com.rop.reflection.Son");

        //3.不会产生类的引用的方法
        //System.out.println(Son.b);
        //Son[] array = new Son[5];
        System.out.println(Son.M); //父类子类都不会被初始化
    }
}

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

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

    static int m = 100;
    static final int M = 1;
}

1.9、类加载器的作用

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

image-20220404154922088.png

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++)
        ClassLoader parent1 = parent.getParent();
        System.out.println(parent1);

        //测试分别是什么类加载器加载的
        ClassLoader classLoader = Class.forName("com.rop.reflection.Test06").getClassLoader();
        System.out.println(classLoader);
        //测试Object类是由什么类加载器加载的
        classLoader = Class.forName("java.lang.Object").getClassLoader();
        System.out.println(classLoader);
    }
}

1.10、获取运行时类的完整结构

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

Field、Method、Constructor、Superclass、Interface、Annotation

  • 实现的全部接口
  • 所继承的父类
  • 全部的构造器
  • 全部的方法
  • 全部的Field
  • 注解
  • ……
//获得类的信息
public class Test07 {
    public static void main(String[] args) throws Exception {
        Class c1 = Class.forName("com.rop.reflection.User");

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

        System.out.println("===========================");
        //获得类的属性
        Field[] fields = c1.getFields(); //getFields()只能获得public的属性
        fields = c1.getDeclaredFields(); //getDeclaredFields()能获得全部的属性
        for (Field field : fields) {
            System.out.println(field);
        }
        //获得指定属性的值
        Field names = c1.getDeclaredField("name");
        System.out.println(names);
        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);
        }
        System.out.println("===========================");
        //获得指定方法
        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();
        for (Constructor constructor : constructors) {
            System.out.println(constructor);
        }
        constructors = c1.getDeclaredConstructors();
        for (Constructor constructor : constructors) {
            System.out.println(constructor);
        }

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

1.11、动态创建对象执行方法

//通过反射来创建对象
public class Test08 {
    public static void main(String[] args) throws ClassNotFoundException, IllegalAccessException, InstantiationException, NoSuchMethodException, InvocationTargetException, NoSuchFieldException {
        //获得class对象
        Class c1 = Class.forName("com.rop.reflection.User");

        //构造一个对象
//        User user = (User)c1.newInstance(); //只能通过无参构造,不能使用有参构造
//        System.out.println(user);

        //通过构造器构造对象
//        Constructor constructor = c1.getDeclaredConstructor(int.class, String.class, int.class);
//        User user2 = (User) constructor.newInstance(001, "rop", 18);
//        System.out.println(user2);

        //通过反射调用普通方法
        User user3 = (User)c1.newInstance();
        //通过反射获取一个方法
        Method setName = c1.getDeclaredMethod("setName", String.class);
        //invoke:激活的意思
        //invoke(对象,方法的值)
        setName.invoke(user3,"rop");
        System.out.println(user3.getName());

        System.out.println("==================");
        //通过反射操作属性
        User user4 = (User)c1.newInstance();
        Field name = c1.getDeclaredField("name");

        //不能直接操作私有属性,必须关闭程序的安全检测
        name.setAccessible(true);
        name.set(user4,"rop2");
        System.out.println(user4.getName());
    }
}

setAccessible

image-20220404182634836.png

1.12、性能测试

//性能测试
public class Test09 {

    //普通方式调用
    public static void test01(){
        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 test02() 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 test03() 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 static void main(String[] args) throws NoSuchMethodException, IllegalAccessException, InvocationTargetException {
        //普通方法
        test01();
        //反射方法
        test02();
        //反射方法,关闭检测
        test03();
    }
}

结果

普通方法执行10亿次:4ms
反射方法执行10亿次:2585ms
反射方法执行10亿次:1285ms

1.13、反射操作泛型

  • Java采用泛型擦除机制来引入泛型,Java中的泛型仅仅是给编译器javac使用的,确保数据的安全性和免去强制类型转换问题,但是,一旦编译完成,所有和泛型有关的类型全部擦除。
  • 为了通过反射操作这些类型,Java新增了ParameterizedType,GenericArrayType,TypeVariable和WildcardType几种类型来代表不能被归一到Class类中的类型但是又和原始类型齐名的类型。
  • ParameterizedType:表示一种参数化类型,比如Collection
  • GenericArrayType:表示一种元素类型是参数化类型或者类型变量的数组类型
  • TypeVariable:是各种类型变量的公共父接口
  • WildcardType:代表一种通配符类型表达式
//通过反射获取泛型
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 static void main(String[] args) throws NoSuchMethodException {
        Method method = Test10.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 = Test10.class.getMethod("test02",null);
        Type genericReturnType = method.getGenericReturnType();
        System.out.println("#" + genericReturnType);
        if (genericReturnType instanceof ParameterizedType){
            Type[] actualTypeArguments = ( (ParameterizedType) genericReturnType ).getActualTypeArguments();
            for (Type actualTypeArgument : actualTypeArguments) {
                System.out.println(actualTypeArgument);
            }
        }
    }
}

1.14、反射操作注解

  • getAnnotations
  • getAnnotation
public class Test11 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
        Class c1 = Class.forName("com.rop.reflection.Student2");
        //通过反射获得注解
        Annotation[] annotations = c1.getAnnotations();
        for (Annotation annotation : annotations) {
            System.out.println(annotation);
        }
        //获得注解的value值
        TableRop tableRop = (TableRop)c1.getAnnotation(TableRop.class);
        System.out.println(tableRop.value());
        //获得指定注解的值
        Field field = c1.getDeclaredField("id");
        FieldRop annotation = field.getAnnotation(FieldRop.class);
        System.out.println(annotation.columnName());
        System.out.println(annotation.type());
        System.out.println(annotation.length());
    }
}

@TableRop("db_student")
class Student2{
    @FieldRop(columnName = "db_id",type = "int",length = 10)
    private int id;
    @FieldRop(columnName = "db_age",type = "int",length = 10)
    private int age;
    @FieldRop(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 + ''' +
                '}';
    }
}

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface TableRop{
    String value();
}

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@interface FieldRop{
    String columnName();
    String type();
    int length();
}