長篇圖解java反射機制及其應(yīng)用場景

一、什么是java反射?

在java的面向?qū)ο缶幊踢^程中,通常我們需要先知道一個Class類,然后new 類名()方式來獲取該類的對象。也就是說我們需要在寫代碼的時候(編譯期或者編譯期之前)就知道我們要實例化哪一個類,運行哪一個方法,這種通常被稱為「靜態(tài)的類加載」

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

  • 服務(wù)任務(wù)B執(zhí)行哪一個類的哪一個方法,是由服務(wù)任務(wù)A的執(zhí)行結(jié)果決定的
  • 服務(wù)任務(wù)C執(zhí)行哪一個類的哪一個方法,是由服務(wù)任務(wù)A和B的執(zhí)行結(jié)果決定的
  • 并且用戶不希望服務(wù)任務(wù)的功能在代碼中寫死,希望通過配置的方式執(zhí)行不同的程序

面對這個情況,我們就不能用代碼new 類名()來實現(xiàn)了,因為你不知道用戶具體要怎么做配置,這一秒他希望服務(wù)任務(wù)A執(zhí)行Xxxx類的x方法,下一秒他可能希望執(zhí)行Yyyy類的y方法。當(dāng)然你也可以說提需求嘛,用戶改一次需求,我改一次代碼。這種方式也能需求,但對于用戶和程序員個人而言都是痛苦,那么有沒有一種方法「在運行期動態(tài)的改變程序的調(diào)用行為的方法」呢?這就是要為大家介紹的“「java反射機制」”。

那么java的反射機制能夠做那些事呢?大概是這樣幾種:

  • 在程序運行期動態(tài)的根據(jù)package名.類名實例化類對象

  • 在程序運行期動態(tài)獲取類對象的信息,包括對象的成本變量和方法

  • 在程序運行期動態(tài)使用對象的成員變量屬性

  • 在程序運行期動態(tài)調(diào)用對象的方法(私有方法也可以調(diào)用)

二、Hello World

我們定義一個類叫做Student

package?com.zimug.java.reflection;

public?class?Student?{
????public?String?nickName;
????private?Integer?age;

????public?void?dinner(){
????????System.out.println("吃晚餐!");
????}

????private?void?sleep(int?minutes){
????????System.out.println("睡"?+?minutes?+?"分鐘");
????}
}

如果不用反射的方式,我相信只要學(xué)過java的朋友肯定會調(diào)用dinner方法

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

如果是反射的方式我們該怎么調(diào)用呢?

//獲取Student類信息
Class?cls?=?Class.forName("com.zimug.java.reflection.Student");
//對象實例化
Object?obj?=?cls.getDeclaredConstructor().newInstance();
//根據(jù)方法名獲取并執(zhí)行方法
Method?dinnerMethod?=?cls.getDeclaredMethod("dinner");
dinnerMethod.invoke(obj);??//打?。撼酝聿?!

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

三、類加載與反射關(guān)系

java的類加載機制還是挺復(fù)雜的,我們這里為了不混淆重點,只為大家介紹和“反射”有關(guān)系的一部分內(nèi)容。

java執(zhí)行編譯的時候?qū)ava文件編譯成字節(jié)碼class文件,類加載器在類加載階段將class文件加載到內(nèi)存,并實例化一個java.lang.Class的對象。比如:對于Student類在加載階段

  • 在內(nèi)存(方法區(qū)或叫代碼區(qū))中實例化一個Class對象,注意是Class對象不是Student對象
  • 一個Class類(字節(jié)碼文件)對應(yīng)一個Class對象
  • 該Class對象保存了Student類的基礎(chǔ)信息,比如這個Student類有幾個字段(Filed)?有幾個構(gòu)造方法(Constructor)?有幾個方法(Method)?有哪些注解(Annotation)?等信息。

有了上面的關(guān)于Student類的基本信息對象(java.lang.Class對象),在運行期就可以根據(jù)這些信息來實例化Student類的對象。

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

但是無論你new多少個Student對象,不論你反射構(gòu)建多少個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對象的地址,輸出結(jié)果是true

四、操作反射的java類

了解了上面的這些基礎(chǔ)信息,我們就可以更深入學(xué)習(xí)反射類相關(guān)的類和方法了:

  • java.lang.Class: ?代表一個類
  • java.lang.reflect.Constructor: 代表類的構(gòu)造方法
  • java.lang.reflect.Method: 代表類的普通方法
  • java.lang.reflect.Field: 代表類的成員變量
  • Java.lang.reflect.Modifier: ?修飾符,方法的修飾符,成員變量的修飾符。
  • java.lang.annotation.Annotation:在類、成員變量、構(gòu)造方法、普通方法上都可以加注解

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

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

/**
*?Class.forName方法獲取Class對象,這也是反射中最常用的獲取對象的方法,因為字符串傳參增強了配置實現(xiàn)的靈活性*/

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
//這個類型是不是基礎(chǔ)數(shù)據(jù)類型?
System.out.println(cls.isPrimitive());?//false

Class類對象信息中幾乎包括了所有的你想知道的關(guān)于這個類型定義的信息,更多的方法就不一一列舉了。還可以通過下面的方法

  • 獲取Class類對象代表的類實現(xiàn)了哪些接口:getInterfaces()
  • 獲取Class類對象代表的類使用了哪些注解:getAnnotations()

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

結(jié)合上文中的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()方法獲取類的非私有的成員變量,數(shù)組,包含從父類繼承的成員變量
  • getDeclaredFields方法獲取所有的成員變量,數(shù)組,但是不包含從父類繼承而來的成員變量

4.4.獲取Class對象的方法

  • getMethods() : ?獲取Class對象代表的類的所有的非私有方法,數(shù)組,「包含從父類繼承而來的方法」
  • getDeclaredMethods() : ?獲取Class對象代表的類定義的所有的方法,數(shù)組,「但是不包含從父類繼承而來的方法」
  • 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方法的參數(shù)個數(shù)"?+?dinnerMethod.getParameterCount());

????????Method?sleepMethod?=?cls.getDeclaredMethod("sleep",int.class);
????????System.out.println("sleep方法的參數(shù)個數(shù)"?+?sleepMethod.getParameterCount());
????????System.out.println("sleep方法的參數(shù)對象數(shù)組"?+?Arrays.toString(sleepMethod.getParameters()));
????????System.out.println("sleep方法的參數(shù)返回值類型"?+?sleepMethod.getReturnType());

上面代碼的執(zhí)行結(jié)果如下:

Student對象的非私有方法
dinner,wait,wait,wait,equals,toString,hashCode,getClass,notify,notifyAll,??end

Student對象的所有方法
dinner,sleep,??end

dinner方法的參數(shù)個數(shù)0
sleep方法的參數(shù)個數(shù)1
sleep方法的參數(shù)對象數(shù)組[int?arg0]
sleep方法的參數(shù)返回值類型void

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

  • 獲取參數(shù)相關(guān)的屬性:
    • 獲取方法參數(shù)個數(shù):getParameterCount()
    • 獲取方法參數(shù)數(shù)組對象:getParameters() ,返回值是java.lang.reflect.Parameter數(shù)組
  • 獲取返回值相關(guān)的屬性
    • 獲取方法返回值的數(shù)據(jù)類型:getReturnType()

4.5.方法的調(diào)用

實際在上文中已經(jīng)演示了方法的調(diào)用,如下invoke調(diào)用dinner方法

Method?dinnerMethod?=?cls.getDeclaredMethod("dinner");
dinnerMethod.invoke(obj);??//打?。撼酝聿停?/span>

dinner方法是無參的那么有參數(shù)的方法怎么調(diào)用?看看invoke方法定義,第一個參數(shù)是Method對象,無論后面 Object... args有多少參數(shù)就按照方法定義依次傳參就可以了。

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

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

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

五、反射的常用場景

  • 通過配置信息調(diào)用類的方法
  • 結(jié)合注解實現(xiàn)特殊功能
  • 按需加載jar包或class

5.1. 通過配置信息調(diào)用類的方法

將上文的hello world中的代碼封裝一下,你知道類名className和方法名methodName是不是就可以調(diào)用方法了?至于你將className和 methodName配置到文件,還是nacos,還是數(shù)據(jù)庫,自己決定吧!

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

5.2.結(jié)合注解實現(xiàn)特殊功能

大家如果學(xué)習(xí)過mybatis plus都應(yīng)該學(xué)習(xí)過這樣的一個注解TableName,這個注解表示當(dāng)前的實例類Student對應(yīng)的數(shù)據(jù)庫中的哪一張表。如下問代碼所示,Student所示該類對應(yīng)的是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文件,至于類注解的掃描我們就不用自己開發(fā)了,引入下面的maven坐標(biāo)就可以

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

看下面代碼:先掃描包,從包中獲取標(biāo)注了TableName注解的類,再對該類打印注解value信息

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

輸出結(jié)果是:

com.zimug.java.reflection.Student類,TableName注解value=t_student

有的朋友會問這有什么用?這有大用處了。有了類定義與數(shù)據(jù)庫表的對應(yīng)關(guān)系,你還能通過反射獲取類的成員變量,之后你是不是就可以根據(jù)表明t_student和字段名nickName,age構(gòu)建增刪改查的SQL了?全都構(gòu)建完畢,是不是就是一個基礎(chǔ)得Mybatis plus了?

反射和注解結(jié)合使用,可以演化出許許多多的應(yīng)用場景,特別是在架構(gòu)優(yōu)化方面,等待你去發(fā)覺啊!

5.3.按需加載jar包或class

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

//按路徑加載jar包
File?file?=?new?File("D:/com/zimug/commons-lang3.jar");
URL?url?=?file.toURI().toURL();
//創(chuàng)建類加載器
ClassLoader?classLoader?=?new?URLClassLoader(new?URL[]{url});

Class?cls?=?classLoader.loadClass("org.apache.commons.lang3.StringUtils");

同樣的把.class文件放在一個路徑下,我們也是可以動態(tài)加載到的

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

類的動態(tài)加載能不能讓你想到些什么?是不是可以實現(xiàn)代碼修改,不需要重新啟動容器?對的,就是這個原理,因為一個類的Class對象只有一個,所以不管你重新加載多少次,都是使用最后一次加載的class對象(上文講過哦)。

六、反射的優(yōu)缺點

  • 優(yōu)點:自由,使用靈活,不受類的訪問權(quán)限限制??梢愿鶕?jù)指定類名、方法名來實現(xiàn)方法調(diào)用,非常適合實現(xiàn)業(yè)務(wù)的靈活配置。
  • 缺點:
    • 也正因為反射不受類的訪問權(quán)限限制,其安全性低,很大部分的java安全問題都是反射導(dǎo)致的。
    • 相對于正常的對象的訪問調(diào)用,反射因為存在類和方法的實例化過程,性能也相對較低
    • 破壞java類封裝性,類的信息隱藏性和邊界被破壞

「碼文不易,如果您覺得有幫助,請幫忙點擊在看或者分享,沒有您的支持我可能無法堅持下去!」

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容