如何单元测试Java的private方法

我会带着你远行 2022-12-29 01:54 861阅读 0赞

## 问题 ##

Java类中private方法通常只能被其所属类的调用，其他类只能望而却步，单元测试private方法也就一筹莫展。

尝试解法：

1.  在测试时，手动将private改为public，测试完后再将其改回。
2.  将测试方法写进private方法的所属类中，这样就能调用private方法了。

上述解法虽然可行，但这些解法或多或少地违背单元测试应遵守AIR原则。

单元测试在线上运行时，感觉像空气（AIR）那样透明，但在测试质量的保障上，却是非常关键的。好的单元测试宏观上来说，具有自动化、独立性、可重复执行的特点。

*  A：Automatic（自动化）
 *  I：Independent（独立性）
 *  R：Repeatable（可重复）

## 解法 ##

先创建一个测试目标类App作为示例，目标是测试App类中private方法callPrivateMethod()：

public class App { 
    
    	public void doSomething() { 
    		callPrivateMethod();
    	}
    	
    	
    	private String callPrivateMethod() { 
    		return "Private method is called.";
    	}
    	
    }

### 一 ###

我们可以用Java的**反射**特性来突破private的限制，从而对private方法进行单元测试：

单元测试代码：

import java.lang.reflect.InvocationTargetException;
    import java.lang.reflect.Method;
    
    import org.junit.Assert;
    import org.junit.Test;
    
    public class AppTest { 
    
    	@Test
    	public void test() throws NoSuchMethodException, SecurityException, IllegalAccessException, IllegalArgumentException, InvocationTargetException { 
    		App app = new App();
    		
    		Method privateMethod = app.getClass().getDeclaredMethod("callPrivateMethod");
    		privateMethod.setAccessible(true);
    		
    		Assert.assertEquals("Private method is called.", privateMethod.invoke(app));
    	}
    }

### 二 ###

引入第三方工具，如Spring测试框架。

引入依赖：

<dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-test</artifactId>
        <version>5.3.5</version>
        <scope>test</scope>
    </dependency>

单元测试代码：

import static org.junit.Assert.*;
    
    import org.junit.Test;
    import org.springframework.test.util.ReflectionTestUtils;
    
    public class AppTest { 
    
    	@Test
    	public void test() { 
    		App app = new App();
    		
    		assertEquals("Private method is called.", //
    				ReflectionTestUtils.invokeMethod(app, "callPrivateMethod", null));
    	}
    
    }

## 参考 ##

1.  [Junit测试private方法][Junit_private]
2.  [阿里巴巴Java开发手册][Java]
3.  [How do I test a private function or a class that has private methods, fields or inner classes?][How do I test a private function or a class that has private methods_ fields or inner classes]

[Junit_private]: https://blog.csdn.net/iameyama/article/details/50411212
[Java]: https://tool.lu/deck/gK/detail?slide=24
[How do I test a private function or a class that has private methods_ fields or inner classes]: https://stackoverflow.com/questions/34571/how-do-i-test-a-private-function-or-a-class-that-has-private-methods-fields-or