圖文詳解java反射機制及常用應用場景

Posted on by

一、什麼是java反射？

在java的面向對象編程過程中，通常我們需要先知道一個Class類，然後new 類名()方式來獲取該類的對象。也就是說我們需要在寫代碼的時候（編譯期或者類加載之前）就知道我們要實例化哪一個類，運行哪一個方法，這種通常被稱為靜態的類加載。

但是在有些場景下，我們事先是不知道我們的代碼的具體行為的。比如，我們定義一個服務任務工作流，每一個服務任務都是對應的一個類的一個方法。

在這裡插入圖片描述

  • 服務任務B執行哪一個類的哪一個方法，是由服務任務A的執行結果決定的
  • 服務任務C執行哪一個類的哪一個方法，是由服務任務A和B的執行結果決定的
  • 並且用戶不希望服務任務的功能在代碼中寫死，希望通過配置的方式根據不同的條件執行不同的程序，條件本身也是變化的

面對這個情況，我們就不能用代碼new 類名()來實現瞭，因為你不知道用戶具體要怎麼做配置，這一秒他希望服務任務A執行Xxxx類的x方法，下一秒他可能希望執行Yyyy類的y方法。當然你也可以說提需求嘛，用戶改一次需求，我改一次代碼。這種方式也能需求，但對於用戶和程序員個人而言都是痛苦，那麼有沒有一種方法在運行期動態的改變程序的調用行為的方法呢？這就是要為大傢介紹的“java反射機制”。

那麼java的反射機制能夠做那些事呢？大概是這樣幾種：

  • 在程序運行期動態的根據package名.類名實例化類對象
  • 在程序運行期動態獲取類對象的信息，包括對象的成本變量和方法
  • 在程序運行期動態使用對象的成員變量屬性
  • 在程序運行期動態調用對象的方法（私有方法也可以調用）

二、Hello World

先入個門，大佬可以略過這一段。我們定義一個類叫做Student

package com.zimug.java.reflection;
public class Student {
    public String nickName;
    private Integer age;   //這裡是private
    public void dinner(){
        System.out.println("吃晚餐！");
    }
    private void sleep(int minutes){   //private修飾符
        System.out.println("睡" + minutes + "分鐘");
    }
}

如果不用反射的方式，我相信隻要學過java的朋友肯定會調用dinner方法

Student student = new Student();
student.dinner();

如果是反射的方式我們該怎麼調用呢？

//獲取Student類信息
Class cls = Class.forName("com.zimug.java.reflection.Student");
//對象實例化
Object obj = cls.getDeclaredConstructor().newInstance();
//根據方法名獲取並執行方法
Method dinnerMethod = cls.getDeclaredMethod("dinner");
dinnerMethod.invoke(obj);  //打印：吃晚餐！

通過上面的代碼我們看到，com.zimug.java.reflection.Student類名和dinner方法名是字符串。既然是字符串我們就可以通過配置文件，或數據庫、或什麼其他的靈活配置方法來執行這段程序瞭。這就是反射最基礎的使用方式。

三、類加載與反射關系

java的類加載機制還是挺復雜的，我們這裡為瞭不混淆重點，隻為大傢介紹和“反射”有關系的一部分內容。

java執行編譯的時候將java文件編譯成字節碼class文件,類加載器在類加載階段將class文件加載到內存，並實例化一個java.lang.Class的對象。比如對於Student類在加載階段會有如下動作：

  • 在內存(方法區或叫代碼區)中實例化一個Class對象，註意是Class對象不是Student對象
  • 一個Class類（字節碼文件）對應一個Class對象，並且隻有一個
  • 該Class對象保存瞭Student類的基礎信息，比如這個Student類有幾個字段（Filed）？有幾個構造方法（Constructor）？有幾個方法（Method）？有哪些註解（Annotation）？等信息

在這裡插入圖片描述

有瞭上面的關於Student類的基本信息對象（java.lang.Class對象）,在運行期就可以根據這些信息來實例化Student類的對象。

  • 在運行期你可以直接new一個Student對象
  • 也可以使用反射的方法構造一個Student對象

在這裡插入圖片描述

但是無論你new多少個Student對象，不論你反射構建多少個Student對象，保存Student類信息的java.lang.Class對象都隻有一個。下面的代碼可以證明。

Class cls = Class.forName("com.zimug.java.reflection.Student");
Class cls2 = new Student().getClass();
System.out.println(cls == cls2); //比較Class對象的地址，輸出結果是true

四、操作反射的java類

瞭解瞭上面的這些基礎信息，我們就可以更深入學習反射類相關的類和方法瞭：

java.lang.Class: 代表一個類

java.lang.reflect.Constructor: 代表類的構造方法

java.lang.reflect.Method: 代表類的普通方法

java.lang.reflect.Field: 代表類的成員變量

Java.lang.reflect.Modifier: 修飾符，方法的修飾符，成員變量的修飾符。

java.lang.annotation.Annotation：在類、成員變量、構造方法、普通方法上都可以加註解

4.1.獲取Class對象的三種方法

Class.forName()方法獲取Class對象

/**
* Class.forName方法獲取Class對象，這也是反射中最常用的獲取對象的方法，因為字符串傳參增強瞭配置實現的靈活性
*/
Class cls = Class.forName("com.zimug.java.reflection.Student");

類名.class獲取Class對象

/**
* `類名.class`的方式獲取Class對象
*/
Class clz = User.class;

類對象.getClass()方式獲取Class對象

/**
* `類對象.getClass()`方式獲取Class對象
*/
User user = new User();
Class clazz = user.getClass();

雖然有三種方法可以獲取某個類的Class對象，但是隻有第一種可以被稱為“反射”。

4.2.獲取Class類對象的基本信息

Class cls = Class.forName("com.zimug.java.reflection.Student");
//獲取類的包名+類名
System.out.println(cls.getName());          //com.zimug.java.reflection.Student
//獲取類的父類
Class cls = Class.forName("com.zimug.java.reflection.Student");
//這個類型是不是一個註解？
System.out.println(cls.isAnnotation());     //false
//這個類型是不是一個枚舉？
System.out.println(cls.isEnum());      //false
//這個類型是不是基礎數據類型？
System.out.println(cls.isPrimitive()); //false

Class類對象信息中幾乎包括瞭所有的你想知道的關於這個類型定義的信息，更多的方法就不一一列舉瞭。還可以通過下面的方法

獲取Class類對象代表的類實現瞭哪些接口： getInterfaces()

獲取Class類對象代表的類使用瞭哪些註解： getAnnotations()

4.3. 獲得Class對象的成員變量

結合上文中的Student類的定義理解下面的代碼

Class cls = Class.forName("com.zimug.java.reflection.Student");
Field[] fields = cls.getFields();
for (Field field : fields) {
System.out.println(field.getName());      //nickName
}
fields = cls.getDeclaredFields();
for (Field field : fields) {
System.out.println(field.getName());      //nickName 換行  age
}

getFields()方法獲取類的非私有的成員變量，數組，包含從父類繼承的成員變量

getDeclaredFields方法獲取所有的成員變量，數組，但是不包含從父類繼承而來的成員變量

4.4.獲取Class對象的方法

getMethods() : 獲取Class對象代表的類的所有的非私有方法，數組，包含從父類繼承而來的方法

getDeclaredMethods() : 獲取Class對象代表的類定義的所有的方法，數組，但是不包含從父類繼承而來的方法

getMethod(methodName): 獲取Class對象代表的類的指定方法名的非私有方法

getDeclaredMethod(methodName): 獲取Class對象代表的類的指定方法名的方法

        Class cls = Class.forName("com.zimug.java.reflection.Student");
        Method[] methods = cls.getMethods();
        System.out.println("Student對象的非私有方法");
        for (Method m : methods) {
            System.out.print(m.getName() + ",");
        }
        System.out.println("  end");
        Method[] allMethods = cls.getDeclaredMethods();
        System.out.println("Student對象的所有方法");
        for (Method m : allMethods) {
            System.out.print(m.getName() + ",");
        }
        System.out.println("  end");
        Method dinnerMethod = cls.getMethod("dinner");
        System.out.println("dinner方法的參數個數" + dinnerMethod.getParameterCount());
        Method sleepMethod = cls.getDeclaredMethod("sleep",int.class);
        System.out.println("sleep方法的參數個數" + sleepMethod.getParameterCount());
        System.out.println("sleep方法的參數對象數組" + Arrays.toString(sleepMethod.getParameters()));
        System.out.println("sleep方法的參數返回值類型" + sleepMethod.getReturnType());

上面代碼的執行結果如下：

Student對象的非私有方法
dinner,wait,wait,wait,equals,toString,hashCode,getClass,notify,notifyAll,  end
Student對象的所有方法
dinner,sleep,  end
dinner方法的參數個數0
sleep方法的參數個數1
sleep方法的參數對象數組[int arg0]
sleep方法的參數返回值類型void

可以看到getMethods獲取的方法中包含Object父類中定義的方法，但是不包含本類中定義的私有方法sleep。另外我們還可以獲取方法的參數及返回值信息：

獲取參數相關的屬性：

  • 獲取方法參數個數：getParameterCount()
  • 獲取方法參數數組對象：getParameters() ，返回值是java.lang.reflect.Parameter數組

獲取返回值相關的屬性

  • 獲取方法返回值的數據類型：getReturnType()

4.5.方法的調用

實際在上文中已經演示瞭方法的調用，如下invoke調用dinner方法

Method dinnerMethod = cls.getDeclaredMethod("dinner");
dinnerMethod.invoke(obj);  //打印：吃晚餐！

dinner方法是無參的，那麼有參數的方法怎麼調用?看看invoke方法定義，第一個參數是Method對象，無論後面Object... args有多少參數就按照方法定義依次傳參就可以瞭。

public Object invoke(Object obj, Object... args)

4.6.創建類的對象(實例化對象)

//獲取Student類信息
Class cls = Class.forName("com.zimug.java.reflection.Student");
//對象實例化
Student student = (Student)cls.getDeclaredConstructor().newInstance();
//下面的這種方法是已經Deprecated瞭，不建議使用。但是在比較舊的JDK版本中仍然是唯一的方式。
//Student student = (Student)cls.newInstance();

五、反射的常用場景

通過配置信息調用類的方法

結合註解實現特殊功能

按需加載jar包或class

5.1. 通過配置信息調用類的方法

將上文的hello world中的代碼封裝一下，你知道類名className和方法名methodName是不是就可以調用方法瞭？至於你將className和 methodName配置到文件，還是nacos，還是數據庫，自己決定吧！

public void invokeClassMethod(String className,String methodName) throws ClassNotFoundException, 
            NoSuchMethodException, 
            InvocationTargetException, 
            InstantiationException, 
            IllegalAccessException {
        //獲取類信息
        Class cls = Class.forName(className);
        //對象實例化
        Object obj = cls.getDeclaredConstructor().newInstance();
        //根據方法名獲取並執行方法
        Method dinnerMethod = cls.getDeclaredMethod(methodName);
        dinnerMethod.invoke(obj);
}

5.2.結合註解實現特殊功能

大傢如果學習過mybatis plus都應該學習過這樣的一個註解TableName，這個註解表示當前的實體類Student對應的數據庫中的哪一張表。如下問代碼所示，Student所示該類對應的是t_student這張表。

@TableName("t_student")
public class Student {
    public String nickName;
    private Integer age;
}

下面我們自定義TableName這個註解

@Target(ElementType.TYPE)  //表示TableName可作用於類、接口或enum Class, 或interface
@Retention(RetentionPolicy.RUNTIME) //表示運行時由JVM加載
public @interface TableName {
       String value() ;   //則使用@TableName註解的時候： @TableName(”t_student”);
}

有瞭這個註解，我們就可以掃描某個路徑下的java文件，至於類註解的掃描我們就不用自己開發瞭，引入下面的maven坐標就可以

<dependency>
    <groupId>org.reflections</groupId>
    <artifactId>reflections</artifactId>
    <version>0.9.10</version>
</dependency>

看下面代碼：先掃描包，從包中獲取標註瞭TableName註解的類，再對該類打印註解value信息

// 要掃描的包
String packageName = "com.zimug.java.reflection";
Reflections f = new Reflections(packageName);
// 獲取掃描到的標記註解的集合
Set<Class<?>> set = f.getTypesAnnotatedWith(TableName.class);
for (Class<?> c : set) {
// 循環獲取標記的註解
TableName annotation = c.getAnnotation(TableName.class);
// 打印註解中的內容
System.out.println(c.getName() + "類，TableName註解value=" + annotation.value());

輸出結果是：

com.zimug.java.reflection.Student類，TableName註解value=t_student

有的朋友會問這有什麼用？這有大用處瞭。有瞭類定義與數據庫表的對應關系，你還能通過反射獲取類的成員變量，之後你是不是就可以根據表明t_student和字段名nickName，age構建增刪改查的SQL瞭？全都構建完畢，是不是就是一個基礎得Mybatis plus瞭？

反射和註解結合使用，可以演化出許許多多的應用場景，特別是在框架代碼實現方面。等待你去發覺啊！

5.3.按需加載jar包或class

在某些場景下，我們可能不希望JVM的加載器一次性的把所有classpath下的jar包裝載到JVM虛擬機中，因為這樣會影響項目的啟動和初始化效率，並且占用較多的內存。我們希望按需加載，需要用到哪些jar，按照程序動態運行的需求取加載這些jar。

把jar包放在classpath外面，指定加載路徑，實現動態加載。

//按路徑加載jar包
File file = new File("D:/com/zimug/commons-lang3.jar");
URL url = file.toURI().toURL();
//創建類加載器
ClassLoader classLoader = new URLClassLoader(new URL[]{url});
Class cls = classLoader.loadClass("org.apache.commons.lang3.StringUtils");

同樣的把.class文件放在一個路徑下，我們也是可以動態加載到的

//java的.class文件所在路徑
File file = new File("D:/com/zimug");
URL url = file.toURI().toURL();
//創建類加載器
ClassLoader classLoader = new URLClassLoader(new URL[]{url});
//加載指定類，package全路徑
Class<?> cls = classLoader.loadClass("com.zimug.java.reflection.Student");

類的動態加載能不能讓你想到些什麼？是不是可以實現代碼修改，不需要重新啟動web容器？對的，就是這個原理，因為一個類的Class對象隻有一個，所以不管你重新加載多少次，都是使用最後一次加載的class對象（上文講過哦）。

六、反射的優缺點

優點：自由，使用靈活，不受類的訪問權限限制。可以根據指定類名、方法名來實現方法調用，非常適合實現業務的靈活配置。在框架開發方面也有非常廣泛的應用，特別是結合註解的使用。

缺點：

  • 也正因為反射不受類的訪問權限限制，其安全性低，很大部分的java安全問題都是反射導致的。
  • 相對於正常的對象的訪問調用，反射因為存在類和方法的實例化過程，性能也相對較低
  • 破壞java類封裝性，類的信息隱藏性和邊界被破壞

言盡於此，限於筆者的知識結構，可能有不嚴謹之處，歡迎大傢討論與指正！期待您的關註，我將持續帶來更哇塞的作品,希望大傢以後多多支持WalkonNet！

推薦閱讀：