Java String.stripIndent 怎样保留文本块的相对缩进

我在 Java 文本块里写 SQL 和 HTML 模板时，最容易遇到的不是换行，而是“代码看起来整齐，实际字符串却多出一层缩进”。直接把文本块贴进日志或请求体，公共排版空白会跟着内容输出；手工对每一行调用 trim() 又会把真正有意义的层级一起抹掉。

这个场景适合用 String.stripIndent()。它会识别多行文本中的偶然公共缩进，移除这部分排版空白，同时保留行与行之间的相对缩进。关键是先分清“所有行共有的排版缩进”和“内容内部的层级缩进”，不要把它当成无差别清空空格的方法。

如果目标是让文本块脱离 Java 源码排版后仍保持内部层级，优先使用 stripIndent()；如果只是清理整个字符串两端的空白，才考虑 strip()。

先看清文本块里的两层缩进

下面的字符串有两层空白：每一行前面用于对齐 Java 源码的公共缩进，以及 HTML 内部为了表达嵌套关系保留的相对缩进。前者可以删除，后者应该保留。

String html = """
        
订单摘要
            
内容仍然位于 section 内部。
        
        """;

// 只去掉文本块的偶然公共缩进，不破坏 h2 和 p 的相对层级
String normalized = html.stripIndent();

这里的调用对象是整个字符串。stripIndent() 不会把每行都变成左对齐文本，而是根据多行内容计算可以共同移除的偶然空白；因此

用 stripIndent 保留 SQL 或 HTML 的层级

实际使用时，可以把文本块当作“可读模板”，在边界处统一处理。下面的例子用 SQL 展示这一点：查询关键字保持在左侧，条件和排序条件保留相对层级，最终字符串不会携带 Java 代码块外层的公共缩进。

public final class SqlTemplate {
    public static String recentOrders() {
        String sql = """
                SELECT id, amount
                  FROM orders
                 WHERE status = ?
                   AND created_at > ?
                 ORDER BY created_at DESC
                """;

        // 统一移除文本块的排版空白，保留 SQL 行之间的相对关系
        return sql.stripIndent();
    }
}

这段代码的重点不是把 SQL 压成一行，而是让源码排版和发送出去的内容分离。使用占位符仍然比字符串拼接安全；stripIndent() 只负责文本格式，不负责参数绑定、转义或 SQL 注入防护。

空行、制表符和尾部空白怎么理解

判断缩进时，不要只盯着第一行。多行文本可能包含空行、不同数量的空格或制表符。可以用下面三条规则排查：

• 把公共缩进理解为文本块排版带来的偶然空白，不要把内容内部的额外层级当成公共缩进。
• 空白行通常不应决定内容行的层级；如果模板依赖空行中的空格来表达格式，需要先把格式约定说清楚。
• 空格和制表符不要混用。它们视觉宽度可能相同，但字符串中的字符并不相同，调试时应查看实际字符。

如果你需要确认结果，建议在日志中临时把换行显示为 \\n、把空格显示为可见标记；这只是排查手段，不要为了“看起来整齐”在业务代码里无条件调用 trim()。

stripIndent、strip 和 indent 不要混为一谈

三个方法处理的对象不同。做选择时可以先问自己：我要修正的是整段文本的公共排版、字符串两端的空白，还是每一行的统一缩进？

例如，先 stripIndent() 再 indent(2) 可以表达“先脱离源码排版，再嵌入下一级文档”的意图；但这种组合应该由模板边界决定，不要在每次字符串处理时机械套用。

把它放在模板边界，而不是业务数据清洗层

stripIndent() 最适合放在固定模板的创建处：方法返回 SQL、HTML、提示词或配置片段之前统一处理一次。它不应该替代字段校验，也不应该用来清洗来自用户的自由文本。

我通常会保留三个约束：

1. 模板本身只包含固定结构，动态值通过参数、占位符或经过明确编码的变量进入。
2. 模板方法的返回契约写清楚是否保留开头换行、结尾换行和内部层级。
3. 需要严格比较字符串时，把换行符和空白字符纳入测试用例，而不是只比较渲染后的视觉效果。

常见疑问

stripIndent 会把所有行都顶到最左边吗？

不会。它的目标是移除可以视为偶然公共缩进的部分，行之间原本存在的相对缩进仍然可以保留。

只想去掉字符串首尾空格该用什么？

使用 strip() 更直接。它解决的是整个字符串边界的空白，不是多行文本的公共缩进。

stripIndent 能处理 SQL 的参数绑定吗？

不能。它只改变文本排版；参数绑定、类型转换和数据库安全仍由 JDBC 或具体数据库访问层负责。

总结

Java 文本块的可读性和最终字符串的稳定格式可以同时保留，关键在于把公共排版空白与内容内部层级分开。String.stripIndent() 适合处理这一层边界：先让模板脱离源码缩进，再把结果交给 SQL、HTML、日志或配置生成逻辑；需要清理首尾空白时使用 strip()，需要统一调整每行层级时再考虑 indent(n)。