使用Jackson将YAML反序列化为Java对象时如何保留文本缩进
问题根因
缩进丢失并非YAML块标量的解析规则本身导致的:
按照YAML规范,|块标量仅会剥离所有行与第一行内容等长的「基级缩进」,块内文本中超出基级的额外缩进属于内容本身,理应被完整保留。你当前丢失缩进的核心原因,是Jackson默认的YAML解析流程在拿到SnakeYAML返回的块文本后,额外做了逐行trim处理,将行首属于内容的前导空格清除,同时还会压缩连续空行,最终出现缩进丢失、空行被合并的现象。
可落地的配置方案
不需要编写自定义反序列化逻辑,仅需调整YAMLFactory的初始化方式,跳过默认的文本后处理,即可实现块内原有缩进的完整保留:
- Jackson 2.13及以上版本(推荐):通过构建器传入带自定义参数的SnakeYAML加载器,绕过默认的文本修剪逻辑:
// 自定义SnakeYAML解析参数 LoaderOptions loaderOptions = new LoaderOptions(); // 按需调整块文本大小限制(默认3M,可根据业务场景调整) loaderOptions.setCodePointLimit(5 * 1024 * 1024); YAMLFactory yamlFactory = YAMLFactory.builder() // 绑定自定义配置的SnakeYAML加载器 .loader(new SnakeYAMLLoader(loaderOptions)) .disable(YAMLGenerator.Feature.WRITE_DOC_START_MARKER) .enable(YAMLGenerator.Feature.MINIMIZE_QUOTES) .enable(YAMLGenerator.Feature.INDENT_ARRAYS) .build(); ObjectMapper objectMapper = new ObjectMapper(yamlFactory) .setSerializationInclusion(JsonInclude.Include.NON_NULL); - Jackson 2.12及更早版本:直接在构造YAMLFactory时传入带自定义配置的原生SnakeYAML实例,即可绕过默认的文本后处理逻辑:
LoaderOptions loaderOptions = new LoaderOptions(); // 传入原生SnakeYAML实例,禁用Jackson默认的文本trim包装 YAMLFactory yamlFactory = new YAMLFactory(new SnakeYAML(loaderOptions)) .disable(YAMLGenerator.Feature.WRITE_DOC_START_MARKER) .enable(YAMLGenerator.Feature.MINIMIZE_QUOTES) .enable(YAMLGenerator.Feature.INDENT_ARRAYS); ObjectMapper objectMapper = new ObjectMapper(yamlFactory) .setSerializationInclusion(JsonInclude.Include.NON_NULL);
注意事项
- 编写YAML块标量时,不要将带额外缩进的行作为块内容的第一行,否则YAML会将该行的缩进长度计算为基级,导致其他行的缩进被错误剥离
- 配置完成后重新解析示例YAML,原本被trim掉的行首额外空格、连续空行都会被完整保留,完全匹配原YAML中的文本格式
内容的提问来源于stack exchange,提问作者kimi1990mp
相关产品推荐
相关产品推荐

