注解和反射

DEDEZHANG
318 阅读15分钟

注解

什么是注解

  • Annotation 是从 JDK 5 开始引入的技术

  • Annotation 的作用

    • 不是程序本身，可以对程序作出解释（这一点和注释( comment )没什么区别）
    • 可以被其他程序（如编译器等）读取

  • Annotation 的格式

    • 注解是以“@注释名”在代码中存在的，还可以添加一些参数值，例如：@SuppressWarnings(value = "unchecked")
    • 例如：
    class MyThread implements Runnable{
    /**
     * @Override 重写的注解
     */
    @Override
    public void run() {
        System.out.println(Thread.currentThread().getName());
    }
}

  • Annotation 在哪里使用

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

内置注解

  • @Override ：定义在 java.lang.Override 中，此注解只适用于修辞方法，表示一个方法声明打算重写超类中的另一个方法声明

  • Deprecated ：定义在 java.lang.Deprecated 中，此注解可以用于修辞方法、属性、类，表示不鼓励程序员使用这样的元素，通常是因为它很危险或者存在更好的选择

     @Deprecated
    public static void test(){
        System.out.println("Deprecated");
    }

    public static void main(String[] args) {
        test();
    }

  • SuppressWarnings：定义在 java.lang.SrppressWarnings 中，用来抑制编译时的警号信息，与前两个注释有所不同，你需要添加一个参数才能正确使用，这些参数都是已经定义好了的，我们选择性使用就好了

    • @SprressWarnings("all")
    • @SprressWarnings("unchecked")
    • @SprressWarnings(value={"unchecked","deprecation"})
    • 等等......
    /**
 *@SuppressWarnings 可以镇压警告
 */
@SuppressWarnings("all")
public void test02(){
    List list = new ArrayList();
}

元注解

  • 元注解的作用就是负责注解其他注解，Java 定义了 4 个标准的 meta-annotation 类型，它们提供对其他 annotation 类型做说明

  • 这些类型和它们所支持的类在 java.lang.annotation 包中可以找到

    • @Target ：用于描述注解的使用范围（即被描述的注解可以用在什么地方）

    • @Retention ：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（SOURCE < CLASS < RUNTIME)

    • @Document ：说明该注解将被包含在 javadoc 中

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

    //测试元注解
public class TestMeta {

    @MyAnnotation
    public void test(){}
}

/**
 * 定义一个注解
 * @Target 描述注解的作用范围
 * @Retention 表示我们的注解在什么地方还有效
 * @Documented 表示是否将我们的注解生成在 javadoc 中
 * @Inherited 表示字类可以继承父类的注解
 */
@Target(value = {ElementType.METHOD,ElementType.TYPE})
@Retention(value = RetentionPolicy.RUNTIME)
@Documented
@Inherited
@interface MyAnnotation{
}

自定义注解

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

    /**
     * 注解可以显示赋值
     */
    @MyAnnotation(name = "",school = "北京大学")
    public void test(){}

    /**
     * 如果注解只有一个参数，命名为 value()
     * 则可以省略参数名
     */
    @MyAnnotation2("ddd")
    public void test2(){}

}

@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation{
    /**
     * 注解的参数：参数类型  参数名();
     * 如果有参数，使用时需要带参数，如：@MyAnnotation(name = "")
     * 使用默认 default 后，也可以不带参数
     * 如果默认值为 -1，就代表不存在
     * @return
     */
    String name() default "";
    int age() default 0;
    int id() default -1;
    String[] school();
}

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

反射

Java 反射机制概述

静态 VS 动态语言

  1. 动态语言

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

    主要动态语言：Object-C、C#、JavaScript、PHP、Python 等。

  2. 静态语言

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

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

Java Reflection

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

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

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

Java 反射机制研究及应用

Java 反射机制提供的功能

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

Java 反射的优点和缺点

优点

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

缺点

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

反射相关的主要 API

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

Class 类

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

  • Class 本身也是一个类
  • Class 对象只能由系统建立对象
  • 一个加载的类在 JVM 中只会有一个 Class 实例
  • 一个 Class 对象对应的是一个加载到 JVM 中的一个 .class 文件
  • 每个类的实例都会记得自己是由哪个 Class 实例所生成
  • 通过 Class 可以完整地得到一个类中的所有被加载的结构
  • Class 类是 Reflection 的根源，针对任何你想动态加载、运行的类，唯有先获得相应的 Class 对象
  • 在 Object 类中定义了以下方法，此方法将被所有子类继承
public final native Class<?> getClass();
  • 以上的方法返回值是一个 Class 类，此类是 Java 反射的源头，实际上所谓的反射从程序的运行结果来看也很好理解，即：可以通过对象反射求出类的名称。

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[] getDeclareFields() 返回 Field 对象的一个数组

获取 Class 类的实例

  • 若已知具体的类，通过类的 class 属性获取，该方法最为安全可靠，程序性能最高 : Class calzz = Person.class;
  • 已知某个类的实例，调用该实例的 getClass() 方法获取 Class 对象 : Class calzz = person.getClass();
  • 已知一个类的全类名，且该类在类路径下，可通过 Class 类的静态方法 forName() 获取，可能抛出 ClassNotFoundException : Class calzz = Class.forName("demo.Student");
  • 内置基本数据类型可以直接用 类名.Type
  • 还可以利用 ClassLoader
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("main.java.com.dedezhang.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);
    }
    
    #输出结果
    #这个人是：student
    #460141958
    #460141958
    #460141958
    #int
    #class main.java.com.dedezhang.reflection.Person

哪些类型可以有 Class 对象

  • class：外部类，成员（成员内部类，静态内部类），局部内部类，匿名内部类
  • interface：接口
  • []：数组
  • enum：枚举
  • annotation：注解 @interface
  • primitive type：基本数据类型
  • void
//所有类型的 class
//只要元素类型和维度一样，就是同一个 Class
public class Test2 {
    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 java.lang.Object
interface java.lang.Comparable
class [Ljava.lang.String;
class [[I
interface java.lang.Override
class java.lang.annotation.ElementType
class java.lang.Integer
void
class java.lang.Class

Java 内存分析

了解：类加载的过程

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

类的加载与 ClassLoader 的理解

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

    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类的无参构造初始化");
    }
}

#输出
A类静态代码块初始化
A类的无参构造初始化
100

什么时候会发生类初始化

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

类加载器

类加载器的作用

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

类加载器作用是用来把类（Class）装载进内存的。JVM 规范定义了如下类型的类的加载器

//获取类加载器
public class Test5 {

    public static void main(String[] args) {

        //获取系统类的类加载器
        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("main.java.com.dedezhang.reflection.Test5").getClassLoader();
        System.out.println(classLoader);

        //测试 JDK 内部类是谁加载的
        ClassLoader classLoader1 = Class.forName("java.lang.Object").getClassLoader();
        System.out.println(classLoader1);
    }
}

#输出结果
sun.misc.Launcher$AppClassLoader@18b4aac2
sun.misc.Launcher$ExtClassLoader@1b6d3586
null
sun.misc.Launcher$AppClassLoader@18b4aac2
null

创建运行时类的对象

获取运行时类的完整结构

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

Field、Method、Constructor、Superclass、Interface、Annotation

  • 实现的全部接口
  • 所继承的父类
  • 全部的构造器
  • 全部的方法
  • 全部的 Field
  • 注解
  • ......
/**
 * @program: demo->Test8
 * @description: 获得类的信息
 * @author: dedezhang
 * @create: 2020-04-03 00:16
 **/
public class Test8 {
    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException, NoSuchMethodException {
        Class c1 = Class.forName("com.dedezhang.reflection.User");

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

        //获得类的属性
        Field[] fields = c1.getDeclaredFields();
        for(Field field : fields){
            System.out.println(field);
        }

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

        //获得类的方法
        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);

        //获得构造器
        Constructor[] constructors = c1.getConstructors();  //获得 public 构造器
        Constructor[] Constructors = c1.getDeclaredConstructors(); //获得全部构造器

        Constructor constructosrs = c1.getDeclaredConstructor(String.class, int.class, int.class);//获得指定构造器

    }
}

小结

  • 在实际的操作中，取得类的信息的操作代码，并不会经常开发
  • 一定要熟悉 java.lang.reflect 包的作用
  • 如何取得属性、方法、构造器的名称，修饰符等
  • 有了 Class 对象能做什么
    • 创建类的对象：调用 Class 对象的 newInstance() 方法
      • 类必须有一个无参的构造器
      • 类的构造器的访问权限需要足够
     //获得 Class 对象
    Class c1 = Class.forName("com.dedezhang.reflection.User");

    //构造一个对象
    User user = (User)c1.newInstance(); //本质上是调用了类的无参构造器
    System.out.println(user);
    • 没有无参构造器得方法步骤如下
      • 通过 Class 类 getDeclaredConstructor(Class ... parameterTypes)取得本类的指定形参类型的构造器
      • 向构造器的形参中传递一个对象数组进去，里面包含了构造器中所需的各个参数
      • 通过 Constructor 实例化对象
    //通过构造器创建对象
    Constructor constructor = c1.getDeclaredConstructor(String.class, int.class, int.class);
    User user2 = (User)constructor.newInstance("dedezhang", 001, 24);
    System.out.println(user2);
    
    #输出结果
    User={'dedezhang',id=1,age=24}
    • 通过反射操作方法
      • 通过 Class 类的 getMethod(String name,Class...parameteraTypes)方法获得一个 Method 对象，并设置此方法操作时所需要的参数类型
      • 之后使用 Object invoke(Object obj,Object[] args) 进行调用，并向方法中传递要设置的 obj 对象的参数

 ```java
 //通过反射调用普通方法
User user3 = (User)c1.newInstance();
//通过反射获取一个方法
Method setName = c1.getDeclaredMethod("setName", String.class);
//invoike : 激活的意思
//（对象，“方法的值”）
setName.invoke(user3,"dedezhang");
System.out.println(user3.getName());
```
* 通过反射操作属性
```java
//通过反射调用普通方法
User user3 = (User)c1.newInstance();
//通过反射获取一个方法
Method setName = c1.getDeclaredMethod("setName", String.class);
//invoike : 激活的意思
//（对象，“方法的值”）
setName.invoke(user3,"dedezhang");
System.out.println(user3.getName());

//通过反射操作属性
User user4 = (User)c1.newInstance();
Field name = c1.getDeclaredField("name");
//不能直接操作私有属性，我们需要关闭安全检测
name.setAccessible(true);  
name.set(user4,"dedezhang");
System.out.println(user4.getName());
```

反射操作泛型

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

反射操作注解

  • getAnnotations
  • getAnnotation
/**
 * @program: demo->Test12
 * @description: 反射操作注解
 * @author: dedezhang
 * @create: 2020-04-04 18:14
 **/
public class Test12 {


    public static void main(String[] args) throws ClassNotFoundException, NoSuchFieldException {
        Class c1 = Class.forName("com.dedezhang.reflection.Student");

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

        //获得注解的 value 的值
        TableZhang tableZhang = (TableZhang)c1.getAnnotation(TableZhang.class);
        System.out.println(tableZhang.value());

        //获得类指定的注解
        Field f = c1.getDeclaredField("id");
        FieldZhang annotation = f.getAnnotation(FieldZhang.class);
        System.out.println(annotation.columnName());
        System.out.println(annotation.type());
        System.out.println(annotation.length());
    }

}

@TableZhang("db_student")
class Student{
    @FieldZhang(columnName = "db_id",type = "int",length = 10)
    private int id;
    @FieldZhang(columnName = "db_age",type = "int",length = 10)
    private int age;
    @FieldZhang(columnName = "db_name",type = "varchar",length = 3)
    private String name;

    public Student() {
    }

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

//创建一个注解，类名的注解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface TableZhang{
    String value();
}

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

#输出结果
@com.dedezhang.reflection.TableZhang(value=db_student)
db_student
db_id
int
10
avatar
文章
阅读
粉丝