Java如何使用Jackson XML模块处理XML

16次阅读

要避免Jackson xml模块依赖冲突,必须同时引入jackson-dataformat-xml和woodstox-core;XmlMapper需显式关闭FaiL_ON_UNKNOWN_PROPERTIES、启用命名空间支持;java类须合理使用@JacksonXmlProperty、@JacksonXmlText等注解,且根类标注@JacksonXmlRootElement。

Java如何使用Jackson XML模块处理XML

Jackson XML模块依赖怎么加才不冲突

用 Jackson 处理 XML,必须引入 jackson-dataformat-xml,但光加它不够——它依赖 stax2-apiwoodstox-core(推荐),否则运行时抛 ClassNotFoundException: com.fasterxml.woodstox.stax2.ri.Stax2EventFactoryImpl 或解析失败。

maven 正确写法:

   com.fasterxml.jackson.dataformat   jackson-dataformat-xml   2.15.2     com.fasterxml.woodstox   woodstox-core   6.5.0 

注意:jackson-dataformat-xml 本身会拉取 stax-api,但 Woodstox 是更稳定、支持更多 XML 特性的实现;若项目已含老版本 stax(如 JDK 1.6 自带或旧 spring 引入),容易因类加载顺序导致 XMLstreamException 隐式失败。

XmlMapper 初始化要注意哪些默认行为

XmlMapper 不是 ObjectMapper 的简单子类,它默认禁用很多 jsON 场景下的特性,比如不自动忽略未知字段(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES 默认为 true),也不默认支持无参构造器以外的构造方式。

立即学习Java免费学习笔记(深入)”;

常见初始化建议:

  • 始终显式关闭未知字段报错:xmlMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
  • 如需解析带命名空间的 XML,必须启用:xmlMapper.enable(FromXmlParser.Feature.USE_XML_NAME_SPACE)
  • 处理空标签(如 )时,若希望映射为 NULL 而非默认值,需设:xmlMapper.setDefaultUseWrapper(false) 并配合 @JacksonXmlProperty(isAttribute = false)
  • 避免线程不安全:不要复用未配置的裸 new XmlMapper() 实例,应构建单例并预设好配置

Java对象怎么写才能让XmlMapper正确序列化/反序列化

Jackson XML 对注解依赖比 json 更强,尤其涉及属性、文本内容、CDATA、命名空间时。不加注解常导致字段被忽略或嵌套错乱。

关键注解组合示例:

public class Product {   @JacksonXmlProperty(localName = "id", isAttribute = true)   private String id; 

@JacksonXmlProperty(localName = "name") private String name;

@JacksonXmlText // 表示该字段映射为标签体文本,不是子元素 private String description;

@JacksonXmlCData // 仅序列化生效,反序列化不识别 CDATA 包裹 private String content;

@JacksonXmlRootElement(localName = "product") public static class Wrapper { / ... / } }

注意点:

  • @JacksonXmlProperty(isAttribute = true) 必须配 localName,否则可能生成 xmlns:xxx 冗余命名空间声明
  • @JacksonXmlText@JacksonXmlCData 不能共存于同一字段
  • 若类有多个 @JacksonXmlText 字段,反序列化会失败——XML 只允许一个文本节点
  • 没有 @JacksonXmlRootElement 的类,序列化时会报 JsonMappingException: No root name specified

解析失败常见错误和快速定位方法

最常遇到的是 com.fasterxml.jackson.databind.exc.MismatchedinputException 或静默返回 null,根源往往不在数据格式,而在配置或注解缺失。

排查优先级:

  • 检查 XML 是否有 bom 头(如 UTF-8+BOM),XmlMapper 默认不跳过,会导致 Unexpected character 错误;读取前用 InputStreamReader 指定 UTF_8 并跳过 BOM
  • 打印实际解析的 XML 字符串,确认是否被其他框架(如 Spring 的 httpMessageConverter)提前消费或转义
  • 启用调试日志:Logging.level.com.fasterxml.jackson.dataformat.xml=DEBUG,看是否卡在 FromXmlParser 初始化阶段
  • 对复杂嵌套结构,先用 XmlMapper.readTree(input) 解析成 Jsonnode,再人工验证字段路径是否符合预期,比直接绑定 POJO 更易发现命名不一致问题

命名空间处理最容易漏:如果 XML 含 xmlns="http://example.com/ns",对应 Java 类必须用 @JacksonXmlRootElement(Namespace = "http://example.com/ns"),否则整个反序列化静默失败且无提示。

text=ZqhQzanResources