如何消除ByteArrayOutputStream结果中的多余字符？Java技术问题

一、消除多余字符的常见方法 #

多余字符通常来自平台差异的换行符（比如Windows下是\r\n，而你预期的是\n），或是流未正确重置导致的残留输出，可按以下方式处理：

1. 统一换行符格式 #

捕获输出后，将平台相关的换行符替换为预期格式，或直接使用系统标准换行符做断言：

ByteArrayOutputStream out = new ByteArrayOutputStream();
System.setOut(new PrintStream(out));

// 执行Hello类的输出逻辑
Hello.printHello();

// 方式1：替换多余的回车符（针对Windows环境的\r）
String output = out.toString().replaceAll("\r", "");
assertEquals("Hello world!\n", output);

// 方式2：用系统标准换行符做预期值，避免平台差异
String expected = "Hello world!" + System.lineSeparator();
assertEquals(expected, out.toString());

2. 每次测试前重置输出流 #

如果是多次测试导致的残留输出，要在@BeforeEach（JUnit 5）或@Before（JUnit 4）中重置流：

private ByteArrayOutputStream out;

@BeforeEach
void setUp() {
    out = new ByteArrayOutputStream();
    System.setOut(new PrintStream(out));
}

@Test
void testHelloOutput() {
    Hello.printHello();
    assertEquals("Hello world!" + System.lineSeparator(), out.toString());
}

二、更优的实现方式 #

直接操作System.out属于硬编码依赖，耦合性高，推荐以下更优雅的方案：

1. 依赖注入输出流 #

改造Hello类，让它接收PrintStream作为参数，而非直接使用System.out：

public class Hello {
    public static void printHello(PrintStream out) {
        out.println("Hello world!");
    }
}

测试时直接传入自定义的ByteArrayOutputStream，无需修改系统流：

@Test
void testHelloOutput() {
    ByteArrayOutputStream out = new ByteArrayOutputStream();
    Hello.printHello(new PrintStream(out));
    assertEquals("Hello world!" + System.lineSeparator(), out.toString());
}

这种方式完全解耦了系统输出，测试更灵活，也避免了修改System.out可能带来的副作用。

2. 使用JUnit扩展/工具类（JUnit 5） #

如果不想修改业务代码，可以封装一个输出捕获工具类，用try-with-resources自动管理系统流：

public class OutputCapture implements AutoCloseable {
    private final PrintStream originalOut;
    private final ByteArrayOutputStream out;

    public OutputCapture() {
        originalOut = System.out;
        out = new ByteArrayOutputStream();
        System.setOut(new PrintStream(out));
    }

    public String getOutput() {
        return out.toString();
    }

    @Override
    public void close() {
        System.setOut(originalOut);
    }
}

测试时使用：

@Test
void testHelloOutput() {
    try (OutputCapture capture = new OutputCapture()) {
        Hello.printHello();
        assertEquals("Hello world!" + System.lineSeparator(), capture.getOutput());
    }
}

这样可以避免手动重置系统流，减少重复代码，同时保证测试的独立性。

内容的提问来源于stack exchange，提问作者Liza