ReflectUitls類的編寫和對反射機制的解析

聖騎士wind發表於2014-05-13

UITLS反射

ReflectUitls類的編寫和對反射機制的解析

反射相關的類

　　反射相關的類，最基本的當然是Class類。

　　獲取了Class物件之後，就可以接著生成物件例項、呼叫方法、檢視欄位等等。

　　欄位(Field)、方法(Method)和構造方法(Constructor<T>)各有相應的類來表示，它們共同繼承於java.lang.reflect.AccessibleObject類：

　　這三個類共同實現的還有Member介面：

　　獲取欄位、方法和構造方法時，需要呼叫Class類的getXXX()和getDeclearedXXX()方法，需要注意二者區別。

　　比如對於方法：

getMethods();//獲取public (包括父類中的)

getDeclaredMethods();//獲取本類宣告(包括各種修飾符public、private)

　　相關博文：Java中的反射機制（一）

　　API 文件：http://docs.oracle.com/javase/7/docs/api/

訪問許可權相關

　　利用反射，可以訪問一些SDK、API中的私有方法。

　　相關博文：Java中的反射機制（四）利用反射訪問私有

　　訪問私有方法有一個關鍵點：

setAccessible(true); // 抑制Java對修飾符的檢查

　　這個方法是AccessibleObject類中的。

　　前面說過，它是Field、Method和Constructor<T>的共同基類。

　　正常情況下，呼叫isAccessible()返回的都是false，無論你的方法是public還是private。

　　這是因為這個accessible的flag是JVM用來限制是否可以直接訪問，預設情況下是需要進行訪問修飾符的檢查的，所以flag為false，即不能直接訪問。

　　當這個flag設定為true，表明可以直接訪問，不經過訪問修飾符的檢查。

　　輔助類中用於呼叫私有方法的介面：

/**
     * 呼叫私有方法
     *
     * @param obj
     *            呼叫類物件
     * @param methodName
     *            方法名
     * @param paramTypes
     *            引數型別
     * @param params
     *            引數
     * @return
     * @throws Exception
     */
    public static Object invokePrivateMethod(Object obj, String methodName,
            Class<?>[] paramTypes, Object[] params) throws Exception {

        Object value = null;
        Class<?> cls = obj.getClass();

        // 注意不要用getMethod(),因為getMethod()返回的都是public方法
        Method method = cls.getDeclaredMethod(methodName, paramTypes);

        method.setAccessible(true);// 抑制Java的訪問控制檢查

        value = method.invoke(obj, params);
        return value;
    }

訪問修飾符

　　對訪問修飾符的獲取可以通過Member介面的getModifiers()方法，該方法返回一個整型值，整型值是一系列的修飾符位操作組合的結果。

　　用Modifier類可以解析這個整型值中包含的修飾符資訊。

    /**
     * 獲取修飾符資訊
     *
     * @param member
     * @return
     */
    private static String getModifiersInfo(Member member) {
        StringBuilder sBuilder = new StringBuilder();
        int modifiers = member.getModifiers();
        sBuilder.append("\ngetModifiers: " + +modifiers + ", ");// 得到修飾符編碼
        sBuilder.append("\nisPublic: " + Modifier.isPublic(modifiers) + ", ");
        sBuilder.append("\nisPrivate: " + Modifier.isPrivate(modifiers) + ", ");
        sBuilder.append("\nisStatic: " + Modifier.isStatic(modifiers) + ", ");
        sBuilder.append("\nisFinal: " + Modifier.isFinal(modifiers) + ", ");
        sBuilder.append("\nisAbstract: " + Modifier.isAbstract(modifiers));

        return sBuilder.toString();
    }

包裝類與原生資料型別

　　相關博文： Java 包裝類自動裝箱和拆箱

　　寫了一個呼叫靜態方法的輔助類，我本來是這麼寫的：

    /*
     * wrong:
     * public static Object invokePublicStaticMethod(String className,
     * String methodName, Object[] params) throws Exception {
     *
     * Class<?> cls = Class.forName(className);
     * Class<?>[] paramTypes = new Class<?>[params.length];
     * for (int i = 0; i < params.length; ++i) {
     * paramTypes[i] = params[i].getClass();
     *
     * }
     * Method method = cls.getMethod(methodName, paramTypes);
     * Object value = null;
     * if (isPublicStatic(method)) {
     * value = method.invoke(null, params);
     * }
     *
     * return value;
     * }
     */

　　意圖是隻傳入引數陣列，在內部自己根據引數獲取型別陣列，可以少傳點引數，但是這樣遇到了問題。

　　在Example類裡寫了這麼三個測試方法：

    public static void printSomething(String line) {
        System.out.println(line);
    }

    public static int add(int a, int b) {
        return a + b;
    }

    public static double getPi() {
        return 3.14159d;
    }

　　測試的時候發現引數是String型別的時候可以正常執行，但是引數如果是原生資料型別(int型別)，用這個方法呼叫時就跑出了異常：

　　java.lang.NoSuchMethodException: com.mengdd.reflect.Example.add(java.lang.Integer, java.lang.Integer)

　　測試了一下：

Object[] array = new Object[] { 1, 2 };
System.out.println("getClass(): " + array[0].getClass());
System.out.println("Integer.TYPE: " + Integer.TYPE);

　　輸出：

getClass(): class java.lang.Integer
Integer.TYPE: int

　　而那個用於測試的add()方法：

getReturnType: int
getParameterTypes: [int, int]

　　可見Integer和int被認為是兩種型別，所以呼叫方法的時候，型別引數也還是從外部傳入比較科學。

　　修改後的呼叫方法如下：

    public static Object invokePublicStaticMethod(String className,
            String methodName, Class<?>[] paramTypes, Object[] params)
            throws Exception {

        Class<?> cls = Class.forName(className);

        Method method = cls.getMethod(methodName, paramTypes);
        Object value = null;
        if (isPublicStatic(method)) {
            value = method.invoke(null, params);
        }

        return value;
    }

　　測試程式碼：

            Object result1 = ReflectUtils.invokePublicStaticMethod(
                    "com.mengdd.reflect.Example", "add", new Class<?>[] {
                            int.class, Integer.TYPE }, new Object[] { 1, 2 });

            // int.class和Integer.TYPE都行

            Assert.assertEquals(3, result1);

ReflectUtils類

　　ReflectUtils類完整程式碼如下：

package com.mengdd.reflect;

import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Member;
import java.lang.reflect.Method;
import java.lang.reflect.Modifier;
import java.util.Arrays;

/**
 *
 * @ClassName ReflectUtils
 * @Description Reflection Helper class
 *
 * @author mengdandan
 * @Date 2014年5月13日上午10:40:32
 *
 */
public class ReflectUtils {

    /**
     * 建立類的例項，呼叫類的無參構造方法
     *
     * @param className
     * @return
     */
    public static Object newInstance(String className) {

        Object instance = null;

        try {
            Class<?> clazz = Class.forName(className);
            instance = clazz.newInstance();
        }
        catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
        catch (InstantiationException e) {
            // if this Class represents an abstract class, an interface, an
            // array class, a primitive type, or void; or if the class has no
            // nullary constructor; or if the instantiation fails for some other
            // reason.

            e.printStackTrace();
        }
        catch (IllegalAccessException e) {
            // if the class or its nullary constructor is not accessible
            e.printStackTrace();
        }

        return instance;

    }

    /**
     * 獲取所有的public構造方法的資訊
     *
     * @param className
     * @return
     */
    public static String getPublicConstructorInfo(String className) {
        StringBuilder sBuilder = new StringBuilder();

        try {
            Class<?> clazz = Class.forName(className);
            Constructor<?>[] constructors = clazz.getConstructors();
            sBuilder.append(getConstructorInfo(constructors));
        }
        catch (ClassNotFoundException e) {
            e.printStackTrace();
        }

        return sBuilder.toString();
    }

    /**
     * 得到本類內宣告的構造方法資訊
     *
     * @param className
     * @return
     */
    public static String getDeclearedConstructorInfo(String className) {
        StringBuilder sBuilder = new StringBuilder();

        try {
            Class<?> clazz = Class.forName(className);
            Constructor<?>[] constructors = clazz.getDeclaredConstructors();
            sBuilder.append(getConstructorInfo(constructors));
        }
        catch (ClassNotFoundException e) {
            e.printStackTrace();
        }

        return sBuilder.toString();
    }

    /**
     * 獲取public的欄位資訊
     *
     * @param className
     * @return
     */
    public static String getPublicFieldInfo(String className) {
        StringBuilder sBuilder = new StringBuilder();

        try {
            Class<?> clazz = Class.forName(className);

            Field[] fields = clazz.getFields();
            sBuilder.append(getFieldInfo(fields));
        }
        catch (ClassNotFoundException e) {
            e.printStackTrace();
        }

        return sBuilder.toString();
    }

    /**
     * 獲取本類內宣告的欄位資訊
     *
     * @param className
     * @return
     */
    public static String getDecleardFieldInfo(String className) {
        StringBuilder sBuilder = new StringBuilder();

        try {
            Class<?> clazz = Class.forName(className);

            Field[] fields = clazz.getDeclaredFields();
            sBuilder.append(getFieldInfo(fields));
        }
        catch (ClassNotFoundException e) {
            e.printStackTrace();
        }

        return sBuilder.toString();
    }

    /**
     * 得到所有public方法資訊
     *
     * @param className
     * @return
     */
    public static String getPublicMethodInfos(String className) {
        StringBuilder sBuilder = new StringBuilder();

        try {
            Class<?> clazz = Class.forName(className);
            Method[] methods = clazz.getMethods();// 得到所有的public方法，包括從基類繼承的

            sBuilder.append(getMethodInfo(methods));

        }
        catch (ClassNotFoundException e) {
            e.printStackTrace();
        }

        return sBuilder.toString();
    }

    /**
     * 得到類內宣告的方法資訊
     *
     * @param className
     * @return
     */
    public static String getDeclaredMethodInfos(String className) {

        StringBuilder sBuilder = new StringBuilder();
        try {
            Class<?> clazz = Class.forName(className);
            Method[] methods = clazz.getDeclaredMethods();// 得到本類宣告的所有方法,包括私有方法
            // clazz.getMethods(); 會返回所有public的方法，但是包括基類Object的方法

            sBuilder.append(getMethodInfo(methods));

        }
        catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
        catch (Exception e) {
            e.printStackTrace();
        }

        return sBuilder.toString();
    }

    /**
     * 得到構造器資訊
     *
     * @param constructor
     * @return
     */
    private static String getConstructorInfo(Constructor<?> constructor) {

        StringBuilder sBuilder = new StringBuilder();

        sBuilder.append("name: " + constructor.getName());
        sBuilder.append("\ngetParameterTypes: "
                + Arrays.toString(constructor.getParameterTypes()));
        return sBuilder.toString();
    }

    /**
     * 將一組構造器的資訊組成一個字串返回
     *
     * @param constructors
     * @return
     */
    private static String getConstructorInfo(Constructor<?>[] constructors) {

        StringBuilder sBuilder = new StringBuilder();
        int i = 0;
        for (Constructor<?> c : constructors) {
            sBuilder.append("method: " + ++i + " : ");
            sBuilder.append("\n" + getConstructorInfo(c));
            sBuilder.append("\n");
        }

        return sBuilder.toString();

    }

    /**
     * 獲取欄位資訊，組成一個字串返回
     *
     * @param field
     * @return
     */
    private static String getFieldInfo(Field field) {
        StringBuilder sBuilder = new StringBuilder();
        sBuilder.append("name: " + field.getName());
        sBuilder.append("\ngetType: " + field.getType());
        sBuilder.append(getModifiersInfo(field));
        return sBuilder.toString();
    }

    /**
     * 獲取一組欄位的資訊，返回字串
     *
     * @param fields
     * @return
     */
    private static String getFieldInfo(Field[] fields) {
        StringBuilder sBuilder = new StringBuilder();
        int i = 0;
        for (Field field : fields) {
            sBuilder.append("field: " + ++i + " : ");
            sBuilder.append("\n" + getFieldInfo(field));
            sBuilder.append("\n");
        }

        return sBuilder.toString();
    }

    /**
     * 獲取方法的資訊，組成一個字串返回
     *
     * @param method
     * @return
     */
    private static String getMethodInfo(Method method) {

        StringBuilder sBuilder = new StringBuilder();

        sBuilder.append("name: " + method.getName());
        sBuilder.append("\ngetReturnType: " + method.getReturnType());
        sBuilder.append("\ngetParameterTypes: "
                + Arrays.toString(method.getParameterTypes()));
        sBuilder.append(getModifiersInfo(method));
        return sBuilder.toString();
    }

    /**
     * 獲取一組方法的資訊，組成一個字串返回
     *
     * @param methods
     * @return
     */
    private static String getMethodInfo(Method[] methods) {
        StringBuilder sBuilder = new StringBuilder();
        int i = 0;
        for (Method method : methods) {

            sBuilder.append("method: " + ++i + " : ");
            sBuilder.append("\n" + getMethodInfo(method));
            sBuilder.append("\n");

        }

        return sBuilder.toString();
    }

    /**
     * 獲取修飾符資訊
     *
     * @param member
     * @return
     */
    private static String getModifiersInfo(Member member) {
        StringBuilder sBuilder = new StringBuilder();
        int modifiers = member.getModifiers();
        sBuilder.append("\ngetModifiers: " + +modifiers + ", ");// 得到修飾符編碼
        sBuilder.append("\nisPublic: " + Modifier.isPublic(modifiers) + ", ");
        sBuilder.append("\nisPrivate: " + Modifier.isPrivate(modifiers) + ", ");
        sBuilder.append("\nisStatic: " + Modifier.isStatic(modifiers) + ", ");
        sBuilder.append("\nisFinal: " + Modifier.isFinal(modifiers) + ", ");
        sBuilder.append("\nisAbstract: " + Modifier.isAbstract(modifiers));

        return sBuilder.toString();
    }

    /**
     * 是否是公用靜態方法
     *
     * @param member
     * @return
     */
    private static boolean isPublicStatic(Member member) {
        boolean isPS = false;
        int mod = member.getModifiers();
        isPS = Modifier.isPublic(mod) && Modifier.isStatic(mod);
        return isPS;
    }

    /**
     * 呼叫靜態方法
     *
     * @param className
     * @param methodName
     * @param paramTypes
     * @param params
     * @return
     * @throws Exception
     */
    public static Object invokePublicStaticMethod(String className,
            String methodName, Class<?>[] paramTypes, Object[] params)
            throws Exception {

        Class<?> cls = Class.forName(className);

        Method method = cls.getMethod(methodName, paramTypes);
        Object value = null;
        if (isPublicStatic(method)) {
            value = method.invoke(null, params);
        }

        return value;
    }

    /*
     * wrong:
     * public static Object invokePublicStaticMethod(String className,
     * String methodName, Object[] params) throws Exception {
     *
     * Class<?> cls = Class.forName(className);
     * Class<?>[] paramTypes = new Class<?>[params.length];
     * for (int i = 0; i < params.length; ++i) {
     * paramTypes[i] = params[i].getClass();
     *
     * }
     * Method method = cls.getMethod(methodName, paramTypes);
     * Object value = null;
     * if (isPublicStatic(method)) {
     * value = method.invoke(null, params);
     * }
     *
     * return value;
     * }
     */

    /**
     * 呼叫私有方法
     *
     * @param obj
     *            呼叫類物件
     * @param methodName
     *            方法名
     * @param paramTypes
     *            引數型別
     * @param params
     *            引數
     * @return
     * @throws Exception
     */
    public static Object invokePrivateMethod(Object obj, String methodName,
            Class<?>[] paramTypes, Object[] params) throws Exception {

        Object value = null;
        Class<?> cls = obj.getClass();

        // 注意不要用getMethod(),因為getMethod()返回的都是public方法
        Method method = cls.getDeclaredMethod(methodName, paramTypes);

        method.setAccessible(true);// 抑制Java的訪問控制檢查

        value = method.invoke(obj, params);
        return value;
    }
}

ReflectUtils.java

　　測試類和測試程式碼：

package com.mengdd.reflect;

public class Example {

    private String mFiledOne = null;
    private int mCount = 0;
    private double mNum = 6;

    public int mPub = 4;

    public Example() {
    }

    public Example(String filedOne, int count, double num) {
        super();
        this.mFiledOne = filedOne;
        this.mCount = count;
        this.mNum = num;
    }

    public String getFiledOne() {
        return mFiledOne;
    }

    public void setFiledOne(String filedOne) {
        this.mFiledOne = filedOne;
    }

    public int getCount() {
        return mCount;
    }

    public void setCount(int count) {
        this.mCount = count;
    }

    public double getNum() {
        return mNum;
    }

    public void setNum(double num) {
        this.mNum = num;
    }

    public static void printSomething(String line) {
        System.out.println(line);
    }

    public static int add(int a, int b) {
        return a + b;
    }

    public static double getPi() {
        return 3.14159d;
    }

    @Override
    public String toString() {
        return "Example [mFiledOne=" + mFiledOne + ", mCount=" + mCount + "]";
    }

    private String tellSecret(String name, int num) {
        String result = name + num + toString();
        return result;
    }

}

Example.java

package com.mengdd.reflect;

import org.junit.Assert;
import org.junit.Test;

public class ReflectTest {

    @Test
    public void testNewInstance() {
        Object object = ReflectUtils.newInstance("com.mengdd.reflect.Example");

        Assert.assertNotNull(object);

    }

    @Test
    public void testGetConstructorInfo() {
        String result = ReflectUtils
                .getPublicConstructorInfo("com.mengdd.reflect.Example");

        System.out
                .println("=============testGetConstructorInfo================");
        System.out.println(result);
        System.out
                .println("===================================================");

        Assert.assertNotNull(result);

    }

    @Test
    public void testFieldInfos() {
        String result = ReflectUtils
                .getDecleardFieldInfo("com.mengdd.reflect.Example");

        System.out.println("=============testFieldInfos================");
        System.out.println(result);
        System.out
                .println("===================================================");

        Assert.assertNotNull(result);
    }

    @Test
    public void testMethodInfos() {
        String result = ReflectUtils
                .getDeclaredMethodInfos("com.mengdd.reflect.Example");

        System.out.println("=============testMethodInfos================");
        System.out.println(result);
        System.out
                .println("===================================================");

        Assert.assertNotNull(result);
    }

    @Test
    public void testPublicStaticInvocation() {
        System.out
                .println("=============test static invocation================");

        try {

            // 靜態方法1
            ReflectUtils.invokePublicStaticMethod("com.mengdd.reflect.Example",
                    "printSomething", new Class<?>[] { String.class },
                    new Object[] { "Hello World" });

            // 靜態方法2
            Object result1 = ReflectUtils.invokePublicStaticMethod(
                    "com.mengdd.reflect.Example", "add", new Class<?>[] {
                            int.class, Integer.TYPE }, new Object[] { 1, 2 });

            // int.class和Integer.TYPE都行

            Assert.assertEquals(3, result1);

            // 靜態方法3
            Object result2 = ReflectUtils.invokePublicStaticMethod(
                    "com.mengdd.reflect.Example", "getPi", new Class<?>[] {},
                    new Object[] {});

            Assert.assertEquals(3.14159, result2);

        }
        catch (Exception e) {
            e.printStackTrace();

            System.out.println("Exception!");
        }

        System.out
                .println("===================================================");
    }

    @Test
    public void testPrivateInvocation() {
        Example example = new Example("1", 5, 0);
        Object secret = null;
        try {
            secret = ReflectUtils.invokePrivateMethod(example, "tellSecret",
                    new Class<?>[] { String.class, Integer.TYPE },
                    new Object[] { "Hello", 2 });
        }
        catch (Exception e) {
            e.printStackTrace();
        }

        String expected = "Hello2Example [mFiledOne=1, mCount=5]";

        Assert.assertEquals(expected, secret);
    }
}