1. 程式人生 > >Java高階篇(四)——反射

Java高階篇(四)——反射

  之前寫到了設計模式的代理模式,因為下一篇動態代理等內容需要用到反射的知識,所以在之前Java篇的基礎上再寫一篇有關反射的內容,還是以實際的程式為主,瞭解反射是做什麼的、應該怎麼用。

一、什麼是反射

  反射就是把Java類中的各個成分對映成一個個的Java物件。即在執行狀態中,對於任意一個類,都能夠知道這個類的所以屬性和方法;對於任意一個物件,都能呼叫它的任意一個方法和屬性。這種動態獲取資訊及動態呼叫物件方法的功能叫Java的反射機制。

  1. 反射機制的功能

  Java反射機制主要提供了以下功能:

  • 在執行時判斷任意一個物件所屬的類。
  • 在執行時構造任意一個類的物件。
  • 在執行時判斷任意一個類所具有的成員變數和方法。
  • 在執行時呼叫任意一個物件的方法。
  • 生成動態代理。

  2. 實現反射機制的類

   Java中主要由以下的類來實現Java反射機制(這些類都位於java.lang.reflect包中):

  • Class類:代表一個類。 Field類:代表類的成員變數(成員變數也稱為類的屬性)。

  • Method類:代表類的方法。

  • Constructor類:代表類的構造方法。

  • Array類:提供了動態建立陣列,以及訪問陣列的元素的靜態方法。

二、反射的使用

  下面分步說明以下如何通過反射獲取我們需要的內容。

  我們先隨意寫一個Customer類(就是一個PO類),然後看看如何通過反射對這個類進行操作。

  1. Customer類

 1 public class Customer {
 2     
 3     private Long id;
 4     private String name;
 5     private int age;
 6       
 7     public Customer() {}
 8     
 9     public Customer(String name,int age) {
10         this.name = name;
11         this.age = age;
12     }
13       
14     public
Long getId() { 15 return id; 16 } 17 public void setId(Long id) { 18 this.id=id; 19 } 20 public String getName() { 21 return name; 22 } 23 public void setName(String name) { 24 this.name=name; 25 } 26 public int getAge() { 27 return age; 28 } 29 public void setAge(int age) { 30 this.age=age; 31 } 32 33 }

   2. ReflectTester類

  這個類用來演示Reflection API的基本使用方法。這裡自定義的copy方法是用來建立一個和引數objcet同樣型別的物件,然後把object物件中的所有屬性拷貝到新建的物件中,並將其返回。

 1 import java.lang.reflect.Field;
 2 import java.lang.reflect.Method;
 3 
 4 public class ReflectTester {
 5     
 6     public Object copy(Object object) throws Exception{
 7         //獲得物件的型別
 8         Class classType=object.getClass();
 9         System.out.println("Class:"+classType.getName());
10 
11         //通過預設構造方法建立一個新的物件
12         Object objectCopy=classType.getConstructor(new Class[]{}).newInstance(new Object[]{});
13 
14         //獲得物件的所有屬性
15         Field fields[]=classType.getDeclaredFields();
16 
17         for(int i=0; i<fields.length;i++){
18               Field field=fields[i];
19 
20               String fieldName=field.getName();
21               String firstLetter=fieldName.substring(0,1).toUpperCase();
22               //獲得和屬性對應的getXXX()方法的名字
23               String getMethodName="get"+firstLetter+fieldName.substring(1);
24               //獲得和屬性對應的setXXX()方法的名字
25               String setMethodName="set"+firstLetter+fieldName.substring(1);
26 
27               //獲得和屬性對應的getXXX()方法
28               Method getMethod=classType.getMethod(getMethodName,new Class[]{});
29               //獲得和屬性對應的setXXX()方法
30               Method setMethod=classType.getMethod(setMethodName,new Class[]{field.getType()});
31 
32               //呼叫原物件的getXXX()方法
33               Object value=getMethod.invoke(object,new Object[]{});
34               System.out.println(fieldName+":"+value);
35               //呼叫拷貝物件的setXXX()方法
36              setMethod.invoke(objectCopy,new Object[]{value});
37         }
38         return objectCopy;
39      }
40 
41 }

  下面分析一下上述程式碼。

  首先,通過Object類中的getClass()方法獲取物件的型別。

Class classType=object.getClass();

  而Class類是Reflection API中的核心類,主要方法如下:

  • getName():獲得類的完整名字。 getFields():獲得類的public型別的屬性。

  • getDeclaredFields():獲得類的所有屬性。

  • getMethods():獲得類的public型別的方法。

  • getDeclaredMethods():獲得類的所有方法。

  • getMethod(String name, Class[] parameterTypes):獲得類的特定方法,name引數指定方法的名字,parameterTypes引數指定方法的引數型別。

  • getConstrutors():獲得類的public型別的構造方法。

  • getConstrutor(Class[] parameterTypes):獲得類的特定構造方法,parameterTypes引數指定構造方法的引數型別。

  • newInstance():通過類的不帶引數的構造方法建立這個類的一個物件。

  第二步,通過預設構造方法建立一個新的物件,即先呼叫Class類的getConstructor()方法獲得一個Constructor物件,它代表預設的構造方法,然後呼叫Constructor物件的newInstance()方法構造一個例項。

Object objectCopy=classType.getConstructor(new Class[]{}).newInstance(new Object[]{});

  第三步,獲得物件的所有屬性,即通過Class類的getDeclaredFields()方法返回類的所有屬性,包括public、protected、default和private訪問級別的屬性,

Field fields[]=classType.getDeclaredFields();

  第四步,獲得每個屬性相應的get/set方法,然後執行這些方法,把原來的物件屬性拷貝到新的物件中。

  這裡我們可以寫一個InvokeTester的類,然後運用反射機制呼叫一個InvokeTester物件的add()方法(自定義方法),如add()方法的兩個引數為int型別,那麼獲取表示add()方法的Method物件程式碼如下:

Method addMethod=classType.getMethod("add",new Class[]{int.class,int.class});

   上述程式碼中也有用到Method的invoke方法,其接收引數必須為物件,如果引數為基本資料型別,必須轉換為相應的包裝型別的物件,如int要轉換為Integer。而invoke方法的返回值總是物件,如果實際被呼叫的方法的返回型別是基本資料型別,那麼invoke方法會將其轉換為相應的包裝型別的物件,再將其返回。

  下面簡單測試一下,具體的方法呼叫如上面提到的add方法,可自行編寫(具體例項見下篇):

1 public static void main(String[] args) throws Exception {
2   Customer customer = new Customer();
3   customer.setId(10L);
4   customer.setName("adam");
5   customer.setAge(3);
6         
7   new ReflectTester().copy(customer);
8 }   

   執行結果如下:

  

三、具體例項

  下面我們嘗試著通過反射機制對一個jar包中的類進行分析,把類中所有的屬性和方法提取出來,並寫入到一個檔案裡中。

  目錄結構如下:

  

  1. ReflexDemo類

  主要程式碼部分,通過反射獲取類、屬性及方法。

 1 import java.io.File;
 2 import java.lang.reflect.Field;
 3 import java.lang.reflect.Method;
 4 import java.net.URL;
 5 import java.net.URLClassLoader;
 6 import java.util.Enumeration;
 7 import java.util.jar.JarEntry;
 8 import java.util.jar.JarFile;
 9 
10 /**
11  * @ClassName: ReflexDemo
12  * @Description: 通過反射獲取類、屬性及方法
13  * @author adamjwh
14  * @date 2018年5月28日
15  *
16  */
17 public class ReflexDemo {
18 
19     private static StringBuffer sBuffer;
20     
21     public static void getJar(String jar) throws Exception {
22         try {
23             File file = new File(jar);
24             URL url = file.toURI().toURL();
25             URLClassLoader classLoader = new URLClassLoader(new URL[] { url },
26                     Thread.currentThread().getContextClassLoader());
27 
28             JarFile jarFile = new JarFile(jar);
29             Enumeration<JarEntry> enumeration = jarFile.entries();
30             JarEntry jarEntry;
31             
32             sBuffer = new StringBuffer();    //存資料
33 
34             while (enumeration.hasMoreElements()) {
35                 jarEntry = enumeration.nextElement();
36 
37                 if (jarEntry.getName().indexOf("META-INF") < 0) {
38                     String classFullName = jarEntry.getName();
39                     if (classFullName.indexOf(".class") < 0) {
40                         classFullName = classFullName.substring(0, classFullName.length() - 1);
41                     } else {
42                         // 去除字尾.class,獲得類名
43                         String className = classFullName.substring(0, classFullName.length() - 6).replace("/", ".");
44                         Class<?> myClass = classLoader.loadClass(className);
45                         sBuffer.append("類名\t:" + className);
46                         System.out.println("類名\t:" + className);
47 
48                         // 獲得屬性名
49                         Class<?> clazz = Class.forName(className);
50                         Field[] fields = clazz.getDeclaredFields();
51                         for (Field field : fields) {
52                             sBuffer.append("屬性名\t:" + field.getName() + "\n");
53                             System.out.println("屬性名\t:" + field.getName());
54                             sBuffer.append("-屬性型別\t:" + field.getType() + "\n");
55                             System.out.println("-屬性型別\t:" + field.getType());
56                         }
57 
58                         // 獲得方法名
59                         Method[] methods = myClass.getMethods();
60                         for (Method method : methods) {
61                             if (method.toString().indexOf(className) > 0) {
62                                 sBuffer.append("方法名\t:" + method.toString().substring(method.toString().indexOf(className)) + "\n");
63                                 System.out.println("方法名\t:" + method.toString().substring(method.toString().indexOf(className)));
64                             }
65                         }
66                         sBuffer.append("--------------------------------------------------------------------------------" + "\n");
67                         System.out.println("--------------------------------------------------------------------------------");
68                     }
69                 }
70             }
71         } catch (Exception e) {
72             e.printStackTrace();
73         } finally {
74             sBuffer.append("End");
75             System.out.println("End");
76             
77             WriteFile.write(sBuffer);    //寫檔案
78         }
79     }
80 
81 }

  2. WriteFile類

  進行寫檔案操作。

 1 import java.io.BufferedWriter;
 2 import java.io.File;
 3 import java.io.FileWriter;
 4 
 5 /**
 6  * @ClassName: WriteFile
 7  * @Description: 寫檔案操作
 8  * @author adamjwh
 9  * @date 2018年5月28日
10  *
11  */
12 public class WriteFile {
13 
14     private static String pathname = "src/com/adamjwh/jnp/ex14/out.txt";
15     
16     public static void write(StringBuffer sBuffer) throws Exception {
17         File file = new File(pathname);
18         BufferedWriter bw = new BufferedWriter(new FileWriter(file));
19         
20         bw.write(sBuffer.toString());
21         bw.close();
22     }
23     
24 }

  3. Main類

  這裡我們需要在專案下新建一個lib資料夾,然後將要解析的jar包放入其中,比如這裡我們放入jdk的dt.jar。目錄結構如下:

  

  執行程式:

 1 /**
 2  * @ClassName: Main
 3  * @Description: 
 4  * @author adamjwh
 5  * @date 2018年5月28日
 6  *
 7  */
 8 public class Main {
 9     
10     private static String jar = "lib/dt.jar";
11     
12     public static void main(String[] args) throws Exception {
13         ReflexDemo.getJar(jar);
14     }
15 
16 }

  執行結果如下: