如何从日志行中删除包名？

Question

我希望调整Java util日志的输出格式，使其不显示包名。当前的格式设置是这样的：

java.util.logging.SimpleFormatter.format = %4$s %2$s %n

这导致日志输出的格式像这样，其中第一个main代表包名，而最后一个main是方法名：

INFO main.MySuperPuperClassName main

我的目标是去掉包名，使得日志行看起来像这样：

INFO MySuperPuperClassName main

我想要实现的是在日志行中不输出包名。

McGarnagle · Answer

为了达到您所期望的输出效果，即在日志记录中不包含包名，您已正确地调整了日志记录器声明，并且更新了logging.properties文件中的配置以匹配您的需求。下面是对您操作的一个总结和验证步骤的解释。

调志记录器声明调整

您已经将日志记录器的初始化更改为使用类的简单名称，这样就避免了输出包名的出现：

private static final Logger LOG = Logger.getLogger(FooBar.class.getSimpleName());

logging.properties 配置置更改

您也更新了logging.properties文件中的配置，以定制输出格式，确保不包含包名，并提供所需的时间戳和级别等信息：

java.util.logging.ConsoleHandler.level = ALLjava.util.logging.ConsoleHandler.formatter = java.util.logging.SimpleFormatterjava.util.logging.SimpleFormatter.format=%1$tY-%1$tm-%1$td %1$tH:%1$tM:%1$tS %4$s: %3$s %5$s %n```

### 测试与验证

您提供了测试命令行方式来确保这些配置生效，通过指定`- Djava.util.logging.config.file`参数来加载特定的配置文件：

```sh
java -Djava.util.logging.config.file=logging.properties FooBar

预期许输出示例

您期望的输出结果展示了一个不包含包名，但有日期时间戳、级别和类名及消息的志记录：

2024-07 08:35:07 INFORMAÇÕES: FooBar main I was there```

Benjamin Gruenbaum · Answer

我非常确定仅凭日志属性本身是无法实现这个功能的。但是，你可以通过编写自定义的格式化器类来达成目的：

import java.time.ZonedDateTime;
import java.time.ZoneId;
import java.io.StringWriter;
import java.io.PrintWriter;
import java.util.IllegalFormatException;
import java.util.logging.LogManager;
import java.util.logging.LogRecord;
import java.util.logging.SimpleFormatter;

public class NoPackageFormatter extends SimpleFormatter {
    private static final String FORMAT_PROPERTY = "java.util.logging.SimpleFormatter.format";
    private static final String DEFAULT_FORMAT = "%4$s %2$s%6$s%n"; // Java SE的默认格式化字符串，适用于美国英语区域设置
    private static final ZoneId ZONE = ZoneId.systemDefault();

    // 方法用于移除类名中的包名部分
    private static String stripPackage(String name) {
        return name.substring(name.lastIndexOf('.') + 1);
    }

    // 重写format方法以自定义日志输出格式
    @Override
    public String format(LogRecord record) {
        String formatPattern = System.getProperty(FORMAT_PROPERTY);
        if (formatPattern == null) {
            formatPattern = LogManager.getLogManager().getProperty(FORMAT_PROPERTY);
        }
        if (formatPattern == null) {
            formatPattern = DEFAULT_FORMAT;
        }

        // 移除记录器名称中的包名
        String loggerName = record.getLoggerName();
        loggerName = stripPackage(loggerName);

        // 处理源类名和方法名，如果存在则组合并移除包名，否则使用日志记录器名称
        String sourceClass = record.getSourceClassName();
        String sourceMethod = record.getSourceMethodName();
        String source = (sourceClass != null && sourceMethod != null) ?
            stripPackage(sourceClass) + ' ' + sourceMethod : loggerName;

        // 如果记录中有异常，则获取其堆栈跟踪信息
        String stackTrace = "";
        if (record.getThrown() != null) {
            StringWriter sw = new StringWriter();
            PrintWriter pw = new PrintWriter(sw);
            record.getThrown().printStackTrace(pw);
            stackTrace = System.lineSeparator() + sw.toString();
        }

        // 准备用于格式化的参数数组
        Object[] arguments = {
            record.getInstant().atZone(ZONE),
            source,
            loggerName,
            record.getLevel().getLocalizedName(),
            formatMessage(record),
            stackTrace
        };

        // 尝试使用指定的格式化字符串进行格式化，如果失败则使用默认格式
        try {
            return String.format(formatPattern, arguments);
        } catch (IllegalFormatException e) {
            return String.format(DEFAULT_FORMAT, arguments);
        }
    }
}

要应用这个自定义格式化器，你可以在日志配置属性中引用它：

java.util.logging.ConsoleHandler.formatter=com.example.NoPackageFormatter
java.util.logging.FileHandler.formatter=com.example.NoPackageFormatter
java.util.logging.SocketHandler.formatter=com.example.NoPackageFormatter

或者，你也可以在代码中编程式地设置它：

import java.util.logging.Logger;

public class MyApplication {
    private static final Logger logger;

    static {
        logger = Logger.getLogger(MyApplication.class.getName());

        // 创建并设置自定义格式化器到所有的处理器上
        Formatter customFormatter = new NoPackageFormatter();
        for (Logger currentLogger = logger; currentLogger != null; currentLogger = currentLogger.getParent()) {
            for (Handler handler : currentLogger.getHandlers()) {
                handler.setFormatter(customFormatter);
            }
        }
    }
    // ... 其他代码
}