Java中 StringBuilder 怎么实现自定义的多行日志格式化输出器

浅磊同学_8233

浅磊同学_8233

2026-07-27

942人浏览

原创

java中stringbuilder适合构建多行结构化日志,需封装为链式multilinelogbuilder类,支持缩进控制、段落分隔、敏感字段脱敏及异常堆栈格式化输出。

java中 stringbuilder 怎么实现自定义的多行日志格式化输出器

Java 中 StringBuilder 本身不提供日志格式化功能,但它是非常适合构建多行、结构化日志字符串的底层工具。实现一个“自定义多行日志格式化输出器”,核心是用 StringBuilder 拼接带缩进、换行、字段对齐和上下文信息的文本块,而不是依赖日志框架的内置格式(如 Logback 的 %X{traceId}),而是手动控制每一行内容。

设计一个可复用的多行日志构建器

不要每次日志都手写 sb.append("...").append(" "),封装成类更清晰:

  • 构造时传入基础信息(如时间、线程名、日志级别)
  • 提供链式方法添加「段落」:请求头、参数、响应体、异常堆栈等
  • 每段自动加前缀缩进(比如 " │ " 或 " "),并以空行分隔
  • 最终调用 toString() 返回完整多行字符串,供 logger.info(builder.toString()) 输出

支持嵌套结构与缩进控制

多行日志常需体现层次,比如 HTTP 请求 → Headers → Body → Response。可用简单缩进计数模拟层级:

javascript-pro
javascript-pro

专注现代 ECMAScript、异步编程、性能优化和全栈的 JavaScript 专家,适用于现代开发

下载
  • 内部维护一个 indentLevel,初始为 0
  • indent() 方法将层级 +1,outdent() 减 1
  • appendLine(String s) 自动拼上前缀空格(如 " ".repeat(indentLevel))和换行
  • 遇到 JSON 或 XML 内容,可调用第三方库(如 Jackson 的 defaultPrettyPrinter)美化后追加,避免手写换行缩进

处理特殊内容:异常堆栈与敏感字段脱敏

直接 e.printStackTrace(new PrintWriter(stringWriter)) 会生成多行字符串,但需注意:

  • 用 StringWriter + PrintWriter 捕获堆栈,再逐行读取、每行前加缩进,避免破坏整体排版
  • 对日志中的手机号、身份证号、token 等字段,在 append 前做正则替换(如 str.replaceAll("(\d{3})\d{4}(\d{4})", "$1****$2"))
  • 敏感字段建议统一走 mask(String raw) 方法,而非散落在各处

示例:一个轻量级 MultiLineLogBuilder

代码片段示意(不含依赖):

public class MultiLineLogBuilder {
    private final StringBuilder sb = new StringBuilder();
    private int indent = 0;

    public MultiLineLogBuilder info(String msg) {
        appendLine("INFO | " + msg);
        return this;
    }

    public MultiLineLogBuilder section(String title) {
        appendLine("─ " + title + " ─");
        indent++;
        return this;
    }

    public MultiLineLogBuilder kv(String key, Object value) {
        String line = String.format("%-12s: %s", key, Objects.toString(value, "null"));
        appendLine(line);
        return this;
    }

    private void appendLine(String s) {
        sb.append("    ".repeat(indent)).append(s).append("
");
    }

    public String toString() {
        return sb.toString().trim(); // 去掉末尾多余换行
    }
}

使用:

logger.debug(new MultiLineLogBuilder()<br>
    .info("HTTP request start")<br>
    .section("Request")<br>
    .kv("Method", "POST")<br>
    .kv("URL", "/api/user")<br>
    .section("Headers")<br>
    .kv("Auth", mask("Bearer abc123..."))<br>
    .toString());

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

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java 格式化输出

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

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

2023.06.15

9417

6

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

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

2023.07.05

6582

9

java自学难吗
java自学难吗

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

2023.07.31

5852

8

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

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

2023.08.01

1024

3

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

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

2023.08.02

868

3

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

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

2023.08.02

1236

5

java有什么用
java有什么用

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

2023.08.02

2469

5

java在线网站
java在线网站

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

2023.08.03

19811

3

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

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

2023.08.03

1115

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习