Java SimpleFormatter 日志格式化详解与自定义实践

# 默认的 ConsoleHandler 使用 SimpleFormatter
java.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatter

# 自定义 SimpleFormatter 的格式
# %1$tc: 日期时间 (完整格式)
# %2$s: 来源
# %4$s: 日志级别
# %5$s: 日志消息
# %6$s: 异常信息
# %n: 换行符
java.util.logging.SimpleFormatter.format = [%1$tc] [%2$s] %4$s: %5$s%6$s%n

import java.io.IOException;
import java.util.logging.ConsoleHandler;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.logging.SimpleFormatter;

public class CustomLogFormatter {

    private static final Logger logger = Logger.getLogger(CustomLogFormatter.class.getName());

    public static void main(String[] args) {
        // 移除默认的 ConsoleHandler，避免重复输出
        Logger rootLogger = Logger.getLogger("");
        for (java.util.logging.Handler handler : rootLogger.getHandlers()) {
            if (handler instanceof ConsoleHandler) {
                rootLogger.removeHandler(handler);
            }
        }

        // 创建并配置自定义的 ConsoleHandler
        ConsoleHandler consoleHandler = new ConsoleHandler();
        // 设置 SimpleFormatter 的格式
        SimpleFormatter formatter = new SimpleFormatter();
        // 注意：在代码中设置格式需要通过系统属性或者自定义Formatter类
        // 最直接的方式是通过logging.properties文件，或者创建一个匿名子类
        // 为了演示，我们假设SimpleFormatter的format属性可以通过某种方式被设置
        // 实际应用中，通常会通过logging.properties或者自定义Formatter类来实现

        // 假设我们通过系统属性设置了格式 (在运行前设置 -Djava.util.logging.SimpleFormatter.format=...)
        // 或者创建一个匿名SimpleFormatter子类来硬编码格式
        SimpleFormatter customFormatter = new SimpleFormatter() {
            private static final String FORMAT = "[%1$tc] [%2$s] %4$s: %5$s%6$s%n";
            @Override
            public String format(java.util.logging.LogRecord record) {
                return String.format(FORMAT,
                                     new java.util.Date(record.getMillis()), // 1$
                                     record.getSourceClassName() != null ? record.getSourceClassName() + "." + record.getSourceMethodName() : record.getLoggerName(), // 2$
                                     record.getLoggerName(), // 3$
                                     record.getLevel().getLocalizedName(), // 4$
                                     formatMessage(record), // 5$
                                     record.getThrown() != null ? formatThrowable(record.getThrown()) : "" // 6$
                                     );
            }

            private String formatThrowable(Throwable thrown) {
                java.io.StringWriter sw = new java.io.StringWriter();
                java.io.PrintWriter pw = new java.io.PrintWriter(sw);
                pw.println(); // Add a newline before stack trace
                thrown.printStackTrace(pw);
                pw.close();
                return sw.toString();
            }
        };

        consoleHandler.setFormatter(customFormatter);
        logger.addHandler(consoleHandler);
        logger.setLevel(Level.INFO); // 设置日志级别

        logger.info("这是一个普通的信息日志。");
        logger.warning("发现一个警告！");

        try {
            throw new IOException("文件读取失败！");
        } catch (IOException e) {
            logger.log(Level.SEVERE, "发生严重错误", e);
        }
    }
}

[2023年12月19日 下午03时30分45秒 CST] [CustomLogFormatter.main] 信息: 这是一个普通的信息日志。
[2023年12月19日 下午03时30分45秒 CST] [CustomLogFormatter.main] 警告: 发现一个警告！
[2023年12月19日 下午03时30分45秒 CST] [CustomLogFormatter.main] 严重: 发生严重错误
java.io.IOException: 文件读取失败！
    at CustomLogFormatter.main(CustomLogFormatter.java:50)