
在Java单元测试中,直接依赖`System.in`(如通过`Scanner`读取用户输入)的方法会阻碍自动化测试的进行,导致测试无限等待或无法提供输入。本文将详细介绍一种有效的解决方案:通过重定向`System.in`到`ByteArrayInputStream`来模拟用户输入,并结合JUnit和Mockito框架,实现对这类交互式方法的自动化单元测试,确保测试的隔离性和可重复性。
在开发过程中,我们经常会编写需要与用户交互的命令行程序,这些程序通常会使用java.util.Scanner类从System.in读取用户输入。例如,一个简单的账单服务方法可能会提示用户选择菜单选项,然后根据输入执行不同的逻辑:
public class BillingService {
public void addBill() {
Scanner scanner = new Scanner(System.in); // 直接依赖System.in
System.out.print("Insert menu you want to be served: ");
var option = scanner.nextLine(); // 阻塞等待用户输入
try {
switch (option) {
case "1":
System.out.print("Choose menu you want to eat: ");
var menuOptionFood = scanner.nextLine(); // 再次阻塞
// ... 处理食物选项
break;
case "2":
System.out.print("Choose menu you want to drink: ");
var menuOptionDrink = scanner.nextLine(); // 再次阻塞
// ... 处理饮品选项
break;
case "e":
System.out.println("e");
break;
default:
System.out.println("No option found !!!");
break;
}
} catch (NullPointerException exception) {
System.out.println(exception.getMessage());
}
// 注意:实际应用中,Scanner应该被关闭,或者通过依赖注入管理
// scanner.close();
}
}当尝试对这样的方法进行单元测试时,由于Scanner会阻塞并等待实际的用户输入,测试框架无法自动提供这些输入,从而导致测试长时间挂起或失败。传统的单元测试方法无法直接模拟System.in的行为。
解决这一问题的关键在于,在测试执行期间,将System.in这个标准的输入流重定向到一个由我们控制的输入源。Java提供了System.setIn(InputStream is)方法,允许我们将System.in指向任何InputStream的实现。ByteArrayInputStream是理想的选择,因为它允许我们用一个字节数组(即一个字符串)来构造一个输入流,从而模拟用户在控制台输入的数据。
立即学习“Java免费学习笔记(深入)”;
同时,为了确保测试的隔离性和可重复性,我们还需要在每个测试方法执行前后保存和恢复原始的System.in(以及可选的System.out,以便测试输出)。
我们将使用JUnit 5和MockitoExtension来编写这个单元测试。
首先,确保你的项目中包含了JUnit 5和Mockito的依赖。
<dependencies>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-api</artifactId>
<version>5.10.0</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-engine</artifactId>
<version>5.10.0</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.mockito</groupId>
<artifactId>mockito-junit-jupiter</artifactId>
<version>5.6.0</version>
<scope>test</scope>
</dependency>
</dependencies>创建一个测试类,并使用@ExtendWith(MockitoExtension.class)来集成Mockito。
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.ExtendWith;
import org.mockito.junit.jupiter.MockitoExtension;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.io.PrintStream;
@ExtendWith(MockitoExtension.class)
class BillingServiceTest {
private BillingService billingService;
// 保存原始的System.in和System.out
private final InputStream systemIn = System.in;
private final PrintStream systemOut = System.out;
// 用于模拟输入的流
private ByteArrayInputStream testIn;
// 用于捕获System.out的输出
private ByteArrayOutputStream testOut;
@BeforeEach
public void init() {
billingService = new BillingService();
// 在每个测试开始前,重定向System.out到ByteArrayOutputStream
testOut = new ByteArrayOutputStream();
System.setOut(new PrintStream(testOut));
}
@AfterEach
public void restoreSystemInputOutput() {
// 在每个测试结束后,恢复原始的System.in和System.out
System.setIn(systemIn);
System.setOut(systemOut);
}
/**
* 辅助方法:设置模拟的用户输入
* @param data 模拟的输入字符串,多行输入使用 '\n' 分隔
*/
private void provideInput(String data) {
testIn = new ByteArrayInputStream(data.getBytes());
System.setIn(testIn);
}
@Test
void whenAddNewMenuItemToBill_selectFoodAndBreakfast_shouldProcessCorrectly() {
// 模拟用户输入 "1" (选择食物菜单) 和 "1" (选择早餐)
provideInput("1\n1");
billingService.addBill();
// 进一步的断言可以检查System.out的输出,或者服务内部状态的改变
// 例如:Assertions.assertTrue(testOut.toString().contains("1"));
}
@Test
void whenAddNewMenuItemToBill_selectDrinkAndAlcohol_shouldProcessCorrectly() {
// 模拟用户输入 "2" (选择饮品菜单) 和 "1" (选择酒精饮品)
provideInput("2\n1");
billingService.addBill();
// 例如:Assertions.assertTrue(testOut.toString().contains("1.2"));
}
@Test
void whenAddNewMenuItemToBill_selectExit_shouldExit() {
// 模拟用户输入 "e" (退出)
provideInput("e");
billingService.addBill();
// 例如:Assertions.assertTrue(testOut.toString().contains("e"));
}
@Test
void whenAddNewMenuItemToBill_selectInvalidOption_shouldShowErrorMessage() {
// 模拟用户输入 "invalid" (无效选项)
provideInput("invalid\nignored"); // 第二个输入会被忽略,因为第一个已处理
billingService.addBill();
// 例如:Assertions.assertTrue(testOut.toString().contains("No option found !!!"));
}
}恢复标准流的重要性: 务必在@AfterEach中恢复System.in和System.out。如果忘记这一步,后续的测试可能会使用错误的输入流,导致测试失败或行为异常。
测试System.out输出: 如示例所示,通过重定向System.out到ByteArrayOutputStream,可以捕获服务方法的打印输出,并在测试中对其内容进行断言,验证程序的行为是否符合预期。
依赖注入优化: 尽管重定向System.in可以解决问题,但更推荐的做法是避免服务类直接依赖System.in或Scanner。相反,可以通过依赖注入的方式,将Scanner或一个抽象的输入接口(例如InputReader)注入到服务类中。这样,在生产环境中可以注入一个读取System.in的实现,而在测试环境中则可以注入一个模拟输入源的实现(例如一个带有预设输入的InputReader实现),从而使测试更加简洁和模块化。
// 更好的设计:通过依赖注入
public interface InputReader {
String readLine();
}
public class SystemInputReader implements InputReader {
private final Scanner scanner = new Scanner(System.in);
@Override
public String readLine() {
return scanner.nextLine();
}
}
public class MockInputReader implements InputReader {
private final String[] inputs;
private int index = 0;
public MockInputReader(String... inputs) {
this.inputs = inputs;
}
@Override
public String readLine() {
if (index < inputs.length) {
return inputs[index++];
}
throw new IllegalStateException("No more mock input available.");
}
}
public class BillingServiceImproved {
private final InputReader inputReader;
public BillingServiceImproved(InputReader inputReader) {
this.inputReader = inputReader;
}
public void addBill() {
System.out.print("Insert menu you want to be served: ");
var option = inputReader.readLine(); // 使用注入的InputReader
// ...
}
}
// 测试时
@Test
void testWithDependencyInjection() {
InputReader mockReader = new MockInputReader("1", "1");
BillingServiceImproved service = new BillingServiceImproved(mockReader);
service.addBill();
// ... 断言
}这种方式将I/O逻辑与业务逻辑解耦,是更符合面向对象设计原则和单元测试理念的方案。
通过重定向System.in,我们能够有效地对那些直接依赖标准输入流的Java方法进行单元测试。这种方法提供了一种模拟用户输入的能力,确保了测试的自动化和可重复性。虽然这种技术是解决特定测试场景的有效手段,但从长远来看,通过依赖注入来解耦I/O操作与核心业务逻辑,将是构建更健壮、更易于测试的应用程序的最佳实践。
以上就是Java方法中System.in输入的单元测试策略的详细内容,更多请关注php中文网其它相关文章!
每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。
Copyright 2014-2025 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号