【Reflect】私有变量和私有方法

素颜马尾好姑娘i 2022-05-31 11:26 277阅读 0赞

在通常的观点中从对象的外部访问私有变量以及方法是不允许的，但是Java反射机制可以做到这一点。

使用这个功能并不困难，在进行单元测试时这个功能非常有效。

注意：这个功能只有在代码运行在单机Java应用(standalone Java application)中才会有效,

就像你做单元测试或者一些常规的应用程序一样。

访问私有变量

要想获取私有变量你可以调用Class.getDeclaredField(String name)方法或者Class.getDeclaredFields()方法。

Class.getField(String name)和Class.getFields()只会返回公有的变量，无法获取私有变量。

下面例子定义了一个包含私有变量的类，以及如何通过反射获取私有变量的实例：

**PrivateObject代码:**

package com.lanhuigu.reflect.fields;
    
    /**
     * 定义一个反射访问私有变量和私有方法的对象
     */
    public class PrivateObject {
        private String privateString = null;
    
        /**
         * 有参构造器
         * @param privateString
         */
        public PrivateObject(String privateString) {
            this.privateString = privateString;
        }
    
        /**
         * 私有方法
         * @return String
         */
        private String getPrivateString() {
            return this.privateString;
        }
    }

**TestGetPrivateField代码:**

package com.lanhuigu.reflect.fields;
    
    import java.lang.reflect.Field;
    
    public class TestGetPrivateField {
        public static void main(String[] args) throws NoSuchFieldException, IllegalAccessException {
            /** 创建对象 */
            PrivateObject privateObject = new PrivateObject("The Private Value");
    
            /** 获取对象的私有变量 */
            Field privateStringField = PrivateObject.class.getDeclaredField("privateString");
            privateStringField.setAccessible(true);
    
            /** 获取私有变量的值 */
            String fieldValue = (String) privateStringField.get(privateObject);
            System.out.println("fieldValue = " + fieldValue);
        }
    }

这个实例在运行时会输出"fieldValue = The Private Value"，The Private Value是PrivateObject实例的privateString私有变量的值，  
注意调用PrivateObject.class.getDeclaredField(“privateString”)方法会返回一个私有变量，  
这个方法返回的变量是定义在PrivateObject类中的而不是在它的父类中定义的变量。  
注意privateStringField.setAccessible(true)这行代码，通过调用setAccessible()方法会关闭指定类Field实例的反射访问检查，  
这行代码执行之后不论是私有的、受保护的以及包访问的作用域，你都可以在任何地方访问，即使你不在他的访问权限作用域之内。  
但是你如果你用一般代码来访问这些不在你权限作用域之内的代码依然是不可以的，在编译的时候就会报错。  
  
  
访问私有方法

访问一个私有方法你需要调用Class.getDeclaredMethod(String name, Class\[\] parameterTypes)或者Class.getDeclaredMethods()方法。

Class.getMethod(String name, Class\[\] parameterTypes)和Class.getMethods()方法，只会返回公有的方法，无法获取私有方法。

沿用上面包含私有方法的类，下面是如何通过反射获取私有方法的实例：

package com.lanhuigu.reflect.fields;
    
    import java.lang.reflect.InvocationTargetException;
    import java.lang.reflect.Method;
    
    public class TestGetPrivateMethod {
        public static void main(String[] args) throws NoSuchMethodException, InvocationTargetException, IllegalAccessException {
            /** 创建对象 */
            PrivateObject privateObject = new PrivateObject("The Private Value");
    
            /** 获取对象的私有方法 */
            Method privateStringMethod = PrivateObject.class.getDeclaredMethod("getPrivateString", null);
            privateStringMethod.setAccessible(true);
    
            /** 方法调用，并打印方法返回结果 */
            String returnValue = (String)privateStringMethod.invoke(privateObject, null);
            System.out.println("returnValue = " + returnValue);
        }
    }

这个实例运行时会输出"returnValue = The Private Value"，The Private Value是PrivateObject实例的getPrivateString()方法的返回值。

PrivateObject.class.getDeclaredMethod("privateString")方法会返回一个私有方法，这个方法是定义在PrivateObject类中的而不是在

它的父类中定义的。同样的，注意Method.setAcessible(true)这行代码，通过调用setAccessible()方法会关闭指定类的Method实例的反射访问检查，

这行代码执行之后不论是私有的、受保护的以及包访问的作用域，你都可以在任何地方访问，即使你不在他的访问权限作用域之内。

但是你如果你用一般代码来访问这些不在你权限作用域之内的代码依然是不可以的，在编译的时候就会报错。