java 15+的textblock虽简化多行字符串,但直接用于sql/json易因缩进、尾部空格、转义问题导致运行时错误;应配合stripindent()、striptrailing()等方法处理,并避免动态拼接,复杂场景宜用资源文件或专用模板机制。

Java 15+ 的 TextBlock 确实能简化多行字符串,但直接塞 SQL/JSON 会踩坑
文本块(TextBlock)从 Java 15 作为预览特性引入,Java 17 正式转正,它用三重双引号 """ 包裹,自动保留换行和缩进。但它不是“万能模板引擎”——原样写 SQL 或 JSON 很容易因缩进、尾部空格、转义字符导致运行时错误或语义偏差。
SQL 字符串里常见的 TextBlock 错误现象
比如写一个带 JOIN 和注释的查询:
String sql = """
SELECT u.name, o.total
FROM users u
JOIN orders o ON u.id = o.user_id
WHERE u.status = 'active'
""";
问题来了:TextBlock 会把每行开头的 4 个空格(对齐缩进)全保留,最终生成的 SQL 开头带空格,某些 JDBC 驱动或 ORM(如 MyBatis 的 <script></script>)可能不敏感,但用 PreparedStatement 直接执行时,如果日志里看到 " SELECT...",就说明空格已进入字符串。更隐蔽的是末尾换行:JVM 默认在最后一行后加一个
,而多数 SQL 解析器并不在意,但做字符串比对或哈希校验时会失败。
- 用
sql.stripIndent()去掉公共前缀空格(推荐,Java 15+) - 用
sql.stripTrailing()去掉末尾空白(包括换行和空格,Java 11+ 就有) - 别依赖 IDE 自动缩进——手动删掉首行缩进,或用
"""后立刻换行,让第一行顶格(哪怕视觉上不美观),再用stripIndent()统一处理 - 如果 SQL 里要插变量,千万别在
TextBlock内用+拼接,改用String.format()或MessageFormat,否则破坏可读性
JSON 模板用 TextBlock 时的转义与格式陷阱
写 JSON 模板时,TextBlock 看似省事,但 JSON 对双引号、反斜杠极其敏感。下面这段看着没问题,实际会编译失败:
将一个或多个视频上传至YouTube。当用户想“上传到YouTube”“发YouTube”“批量上传”“upload to YouTube”“post videos to YouTube”或发布到YouTube时使用此技能。
String json = """
{
"name": "Alice",
"tags": ["java", "textblock"],
"config": {"timeout": 3000}
}
""";
错在哪?JSON 的 key 和 string 值必须用双引号,而 TextBlock 的 """ 已经是 Java 字符串边界,里面的双引号无需转义——这点是对的;但如果你模板里真要出现 "
" 这种字面量(比如想让 JSON 里存一个带换行的字段),就得写成 "\n",因为 Java 先解析字符串,再交给 JSON 解析器。更常见的是缩进污染:JSON 不要求缩进,但人眼需要;一旦用 stripIndent(),所有行首空格被削平,JSON 变成单行,可读性归零。
- 保持 JSON 可读性:用
stripIndent()+ 手动加换行符()控制格式,而不是靠空格缩进 - 避免在
TextBlock里写原始,比如路径"C: emplog.json"必须写成"C:\temp\log.json" - 如果 JSON 模板需动态填充,优先用 Jackson 的
ObjectMapper.readTree()+JsonNode修改,而非字符串拼接 - 用
json.isBlank()快速判空,比json == null || json.trim().isEmpty()更安全
生产环境建议:别让 TextBlock 独自承担模板职责
TextBlock 是字符串字面量的语法糖,不是模板引擎。它适合静态、结构清晰、无复杂逻辑的片段。一旦 SQL 需要条件拼接(比如动态 WHERE)、JSON 需要循环嵌套字段,硬撑着用 TextBlock + 大量 if 字符串拼接,代码会迅速失控。
- 轻量级场景:用
TextBlock+stripIndent()+formatted(...)(Java 15+)做简单占位替换 - 中等复杂度:抽成
private static final String常量,配合String::replace或MessageFormat.format() - 高动态性:移交到资源文件(
.sql/.json)用Class.getResourceAsStream()加载,或引入StringTemplate(Java 21+ 预览)这类专用机制 - 永远验证输出:对生成的 SQL/JSON 做一次
Objects.requireNonNull(...)+!json.isBlank()+ 尝试new JSONObject(json)(用 org.json)快速兜底
最常被忽略的一点:团队里有人还在用 Java 14 或更低版本,TextBlock 会直接编译报错——上线前务必确认 JDK 版本兼容性,别让一个 """ 成为发布阻塞点。
Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南










