怎么利用 java.util.logging.SimpleFormatter 自定义日志输出的时间、类名与消息模板

千墨吖_8681

千墨吖_8681

2026-05-02

569人浏览

原创

simpleformatter 不支持直接自定义时间格式、类名占位符或消息模板,必须继承并重写 format(logrecord) 方法;可通过重写灵活控制时间格式、类名提取、字段顺序及消息拼接,注意使用 formatmessage()、避免 simpledateformat 线程安全问题,并在异步场景下 fallback 到 getloggername()。

怎么利用 java.util.logging.simpleformatter 自定义日志输出的时间、类名与消息模板

SimpleFormatter 本身不支持直接自定义时间格式、类名占位符或消息模板,它只提供固定格式:日志级别 日志时间 类名 方法名 行号 消息(如 INFO: Wed Jan 01 12:00:00 CST 2025 MyClass.doWork:42 Hello)。若需灵活控制时间格式、省略/替换类名、调整字段顺序或添加自定义内容,必须**继承 SimpleFormatter 并重写 format(LogRecord) 方法**。

1. 继承 SimpleFormatter 重写 format 方法

这是最直接可控的方式。通过覆盖 format(),你可以完全决定每条日志的字符串结构:

  • 调用 record.getLevel() 获取日志级别
  • 用 new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS").format(new Date(record.getMillis())) 格式化时间
  • 用 record.getSourceClassName() 或 record.getLoggerName() 获取类名(注意:前者依赖栈帧,可能为 null;后者是 Logger 名,更稳定)
  • 用 record.getMessage() 和 record.getParameters() 拼接格式化后的消息(若使用 logger.log(Level.INFO, "User {0} logged in", userId))

2. 示例:输出 [时间][类名][级别] 消息

(简洁可读风格,适合开发调试)

```java
public class CustomFormatter extends SimpleFormatter {
  private final DateFormat df = new SimpleDateFormat("HH:mm:ss.SSS");

  @Override
  public String format(LogRecord record) {
    String time = df.format(new Date(record.getMillis()));
    String className = record.getSourceClassName() != null
      ? record.getSourceClassName().substring(record.getSourceClassName().lastIndexOf('.') + 1)
      : "unknown";
    String level = record.getLevel().getName();
    String msg = formatMessage(record); // 处理参数占位符,如 {0}
    return String.format("[%s][%s][%s] %s%n", time, className, level, msg);
  }
}
```

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载

然后注册到 Handler:

ConsoleHandler handler = new ConsoleHandler();<br>handler.setFormatter(new CustomFormatter());<br>Logger.getLogger("myapp").addHandler(handler);

3. 注意事项与常见坑

  • 时间精度:SimpleFormatter 默认用 getMillis(),毫秒级准确;避免用 System.currentTimeMillis() 替代,否则丢失原始时间戳
  • 类名可靠性:在异步、代理、Lambda 场景下 getSourceClassName() 常为 null,建议 fallback 到 record.getLoggerName()
  • 消息格式化:务必调用 formatMessage(record) 而非直接取 record.getMessage(),否则无法解析 {0} 等参数
  • 线程安全:SimpleDateFormat 非线程安全,应每个 formatter 实例独享一个(如上面示例中作为成员变量初始化),或改用 DateTimeFormatter(Java 8+)

4. 替代方案:用 java.util.logging.Formatter 的其他实现

如果定制需求复杂(如 JSON 输出、多行堆栈、MDC 支持),SimpleFormatter 继承方式会越来越重。此时可考虑:

  • 直接实现 Formatter 接口(更彻底自由)
  • 迁移到 Log4j2 或 SLF4J + Logback(它们的 PatternLayout / PatternLayoutEncoder 原生支持 %d{HH:mm:ss.SSS} [%c] %-5p %m%n 这类模板语法)
  • 仅对 java.util.logging 做轻量增强时,继承 SimpleFormatter 是最轻量、侵入最小的选择

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

10317

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

7442

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

6512

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1124

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

928

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1356

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2709

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20031

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1195

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习