String.indent() 是按行切分、逐行增减空格并标准化换行符的操作,不处理制表符、对 null 抛 NPE、空行仍参与缩进,负数仅机械删空格,非智能去缩进,大文本易 OOM。

String.indent() 能快速调整多行文本缩进,但必须注意它只处理空格、不识别制表符、对 null 直接抛 NPE——不是“加前缀”那么简单,而是按行切分 + 逐行增减 + 换行符标准化的一整套行为。
为什么 indent() 对空行和全空白行也生效
因为 indent() 内部调用 String.lines() 切分,而 lines() 会把空行("\n")、纯空白行(" \n")都当作独立行处理。每行都会被加上或减去指定数量的空格,然后用 \n 拼回。
-
"".indent(4)→""(空字符串无行,返回原样) -
"\n".indent(2)→"\n"(空行加 2 空格?不,是"\n"被切分为[""],"".indent(2)还是"",再拼成"\n") -
" x\n\n y".indent(-1)→" x\n\n y"(首行减 1 空格剩 1 个,空行不变,末行同理)
负数参数 indent(-n) 实际是“尽力删空格”,不是“对齐去缩进”
很多人误以为 indent(-4) 能自动识别并抹掉公共缩进,其实它只是机械地对每行开头最多删 n 个空格,且只删空格(U+0020),无视 \t。
- 某行是
"\tx",调用.indent(-2)→ 结果仍是"\tx"(制表符不参与) - 某行是
"ab",调用.indent(-100)→ 还是"ab"(没空格可删,不报错也不截断) - 真正要“按最小非空行缩进对齐”,得用 Java 15+ 的
String.stripIndent(),或手动:str.lines().map(String::stripLeading).collect(Collectors.joining("\n"))
调用前必须判空,且不能跳过换行符标准化
indent() 对 null 输入不做防护,直接抛 NullPointerException;同时它内部按 \n 切分,若原始字符串含混合换行符(如 "line1\r\nline2\nline3"),lines() 会识别出 3 行,但缩进后换行符全变成 \n——输出可能不符合 Windows 预期。
分析 Java Spring Boot 后端 Controller 代码,自动生成 Markdown 格式的接口文档。当用户说“生成 Java 接口文档”、“生成 API 文档”、“从 Spring 代码生成文档”时触发。
- 务必先检查:
if (str != null) str.indent(n),别依赖 IDE 补全 - 上游可能为空时,用:
Optional.ofNullable(str).map(s -> s.indent(4)).orElse("") - 从旧系统读配置/文件后,先统一换行符:
str.replaceAll("\r\n", "\n").replaceAll("\r", "\n") - 若需 Windows 风格输出,缩进后再整体替换:
result.replace("\n", "\r\n")
大文本 + 大缩进值容易触发 OOM,别在循环里滥用
indent(1000) 对 10 万行文本,等于要生成 10 万个长度为 1000 的空格字符串(每个都是新对象),再逐行拼接——堆内存压力陡增,GC 频繁。
- 单行加前缀?直接用
" " + str,比indent(4)快得多 - 循环中频繁调用?确认是否真需动态缩进;多数场景可预计算或改用
StringBuilder批量拼接 - 处理日志块、模板渲染等大文本时,优先考虑专用方案(如 Jackson 的
setPrettyPrinting()),indent()只适合结构简单、行数可控的场景
最易被忽略的点:它不理解语义,只做机械行操作。传入混合了空格和制表符的缩进文本,结果不可控;想实现代码块对齐、JSON 格式化、YAML 缩进校验,indent() 都不是正确工具——它只是个轻量级的“每行空格增减器”。
Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南










