如何将Java错误列表中的信息写入本地TXT/JSON文件？

问题背景 #

现有工具类Util维护了一个错误信息列表errorMessages，compare方法会通过outputResult将错误信息添加到该列表中。在main方法调用compare后，需要将列表中的每条错误信息单独写入本地文件，但当前使用ByteArrayOutputStream的方式生成的文件为空，无法达到需求。

相关代码如下：

public class Util {
    private List<String> errorMessages = new ArrayList<>();

    public void outputResult(String content) {
        logger.error(content);
        errorMessages.add(content);
    }
}

public void compare(Config source, Config target) {
    if (source.getId() != target.getId()) {
        util.outputResult("id not equal");
    }
    // ...其他对比逻辑
}

public class MyClass {
    public void main() {
        compare();

        // writeToFile
        ByteArrayOutputStream errorMessages = new ByteArrayOutputStream();

        try (FileWriter w = new FileWriter(pathToReport)) {
            w.write(errorMessages.toString());
        }
        File errorMessagesFile = new File(pathToReport);

        errorMessagesFile.writeText(errorMessages.toString());
    }
}

问题原因 #

当前代码中的ByteArrayOutputStream与Util类中的errorMessages列表完全无关，写入的是空流内容，因此生成的文件为空。

解决方案 #

1. 给Util类添加错误列表的获取方法

由于errorMessages是私有成员，需要添加公共方法来获取列表：

public class Util {
    private List<String> errorMessages = new ArrayList<>();

    public void outputResult(String content) {
        logger.error(content);
        errorMessages.add(content);
    }

    // 添加获取错误列表的方法
    public List<String> getErrorMessages() {
        return errorMessages;
    }
}

2. 正确实现文件写入逻辑

有两种简洁的方式可以将列表中的每条错误单独写入文件：

方式一：使用FileWriter遍历写入

public class MyClass {
    public static void main(String[] args) {
        Util util = new Util();
        // 初始化source和target实例
        Config source = new Config();
        Config target = new Config();
        // 将util传入compare方法，确保错误信息能存入列表
        compare(source, target, util);

        String pathToReport = "./error_messages.txt";

        // 使用try-with-resources自动关闭流
        try (FileWriter writer = new FileWriter(pathToReport)) {
            for (String error : util.getErrorMessages()) {
                // 每条错误后添加换行符，实现单独一行
                writer.write(error + System.lineSeparator());
            }
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    // 修改compare方法，传入Util实例
    public static void compare(Config source, Config target, Util util) {
        // 若ID是包装类型（如Integer），建议用equals比较避免空指针或非预期结果
        if (!source.getId().equals(target.getId())) {
            util.outputResult("id not equal");
        }
        // ...其他对比逻辑
    }
}

方式二：使用Files类快速写入（Java 7+）

Files.write方法默认会将列表中的每个元素单独写入一行，代码更简洁：

import java.nio.file.Files;
import java.nio.file.Paths;
import java.nio.charset.StandardCharsets;

public class MyClass {
    public static void main(String[] args) {
        Util util = new Util();
        Config source = new Config();
        Config target = new Config();
        compare(source, target, util);

        String pathToReport = "./error_messages.txt";

        try {
            Files.write(Paths.get(pathToReport), util.getErrorMessages(), StandardCharsets.UTF_8);
        } catch (IOException e) {
            e.printStackTrace();
        }
    }

    public static void compare(Config source, Config target, Util util) {
        if (!source.getId().equals(target.getId())) {
            util.outputResult("id not equal");
        }
        // ...其他对比逻辑
    }
}

注意事项 #

• 确保compare方法能正确访问到Util实例，否则错误信息无法存入列表
• 对比ID时，若ID是包装类型（如Integer），需使用equals而非==，避免因对象引用不同导致的误判
• 始终使用try-with-resources语法处理文件流，确保资源自动释放，避免内存泄漏

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