Java String.indent 怎样统一多行文本缩进

Java 的 String.indent(int n) 适合把多行字符串统一向右缩进，或把每行开头已有的空白减少。参数为正数时逐行增加空格，参数为负数时逐行移除最多相应数量的前导空白，参数为 0 时不改变行内容但仍会统一行结束符。需要特别注意：制表符按一个空白字符计数，不会先展开成多个空格。

官方文档：https://docs.oracle.com/en/java/javase/25/docs/api/java.base/java/lang/String.html

把 indent 看成“逐行调整前导空白并重建字符串”的方法：它不修改原字符串，也不负责解析模板变量；它会返回一个新的字符串，并把结果行结束符统一为 LF。

• n > 0：每行开头增加 n 个普通空格。
• n = 0：保留每行字符，但仍进行换行符归一化。
• n ：每行最多移除 |n| 个前导空白字符，不足时全部移除。
• 制表符 \t 按一个字符计算，不按制表位宽度展开。

先用 n 的正负值决定缩进方向

最小示例可以把一段两行文本分别向右移动、保持原样和向左收紧。indent 的调用不会改变变量 source 指向的原字符串，因此可以保留原始模板，再按不同输出场景生成派生文本。

public class IndentBasics {
    public static void main(String[] args) {
        // 使用显式换行，便于观察每一行开头发生了什么变化。
        String source = "name=demo\\nport=8080";

        // 正数：两行都增加 4 个普通空格。
        String right = source.indent(4);
        // 零：不增加或删除字符，但仍会规范行结束符。
        String unchanged = source.indent(0);
        // 负数：每行最多删除 2 个前导空白字符。
        String left = "  name=demo\\n  port=8080".indent(-2);

        System.out.print(right);
        System.out.print(unchanged);
        System.out.print(left);
    }
}

工程代码里，正数常用于把配置片段、嵌套日志或 SQL 片段放进更大的文本块；负数则适合去掉一层固定的公共前缀。若原文本各行缩进不一致，负数只按每行实际存在的前导空白处理，不会替你推断“最小公共缩进”。

负数缩进按字符移除，不能当作制表位计算器

官方 API 把前导空白按字符处理。下面的字符串第一行从两个普通空格开始，第二行从一个制表符开始。调用 indent(-2) 时，第一行会移除两个空格，第二行只会移除一个制表符；制表符不会被展开成四个或八个空格后再计算。

public class IndentWhitespace {
    public static void main(String[] args) {
        // 第二行的 \\t 是一个制表符字符，不是固定数量的普通空格。
        String source = "  alpha\\n\\tbeta\\n    gamma";
        String compact = source.indent(-2);

        // 用方括号包住每一行，便于看出前导空白是否还存在。
        compact.lines().forEach(line -> System.out.println("[" + line + "]"));
    }
}

这也是 indent 与“按视觉列对齐”之间的区别。如果需求是让字段出现在固定列，应先明确使用空格还是制表符，并考虑接收端如何解释它们；不要把 indent(-n) 当成排版引擎。

它会把行结束符统一成 LF

String.indent 会概念上按 lines() 拆分字符串，再逐行处理，最后为结果行追加 LF。因此输入中即使混有 CRLF、单独的 CR 或 LF，返回值的行结束表现也会被统一。参数是 0 时也一样会发生这一步，这正是“内容不变”和“字符串字节序列完全不变”的差别。

import java.util.Arrays;

public class IndentLineEnding {
    public static void main(String[] args) {
        // 模拟来自 Windows 文本的 CRLF 输入，并保留可见的字符边界。
        String windowsText = "one\\r\\ntwo";
        String normalized = windowsText.indent(0);

        // 只打印数值，避免把换行符误看成控制台排版效果。
        System.out.println(Arrays.toString(normalized.toCharArray()));
        // 结果中使用 '\\n' 作为行结束符；这里不依赖当前操作系统。
    }
}

如果下游协议要求保留原始换行符，就不要把 indent 当作无损格式化操作。此时可以先使用更明确的字符串处理逻辑，或在协议层规定输出换行格式后再生成内容。

文本块中的 indent 与 stripIndent 不是一回事

文本块会处理编译器认为的 incidental indentation；stripIndent() 的目标是移除这类相对缩进，而 indent(n) 的目标是对已经得到的字符串逐行增加或减少前导空白。两者可以链式使用，但顺序表达的意图不同：先去掉文本块布局带来的公共缩进，再按输出位置补一层缩进，通常更容易读。

public class IndentTextBlock {
    public static void main(String[] args) {
        String fragment = """
                key: value
                enabled: true
                """;

        // 先清理文本块的布局缩进，再作为嵌套配置片段增加两格。
        String nested = fragment.stripIndent().indent(2);
        System.out.print(nested);
    }
}

不要把 stripIndent() 的行为理解成“把所有行左移相同数量”，也不要把 indent(0) 理解成完全不加工。前者遵循文本块相关的相对缩进规则，后者仍然会做行结束符归一化。

在日志和配置输出中保留清晰的边界

实际使用时可以把它放在输出边界，而不是业务对象内部。比如日志要嵌入一段请求摘要时，先让摘要拥有自己的多行格式，再在日志前缀之后统一增加缩进；配置导出则要先决定接收端是否接受 LF，以及是否把制表符视为普通字符。

常见问题

String.indent(0) 会完全返回原字符串吗？

不会把它当作字节级原样返回。每行字符本身不增加也不删除，但行结束符仍可能被规范为 LF，所以包含 CRLF 的输入会发生变化。

indent(-4) 一定会删除四个空格吗？

每行最多删除四个前导空白字符。如果某行只有两个普通空格，两个都会删除；如果某行没有前导空白，内容保持不变。

制表符会按四个空格计算吗？

不会。API 语义把制表符当作一个空白字符处理，不会根据终端或编辑器的制表位设置展开。

应该用 indent 还是 stripIndent？

需要主动增加或减少每行缩进时用 indent；需要去掉文本块布局带来的相对缩进时考虑 stripIndent。两者可以组合，但先明确输入文本的来源和下游格式要求。