1. 理解Jackson XML解析机制
jackson是一个流行的json处理库，但通过其jackson-dataformat-xml模块，它也能高效地处理xml数据。在spring boot中集成jackson xml，通常涉及定义java对象来映射xml结构，并使用xmlmapper进行序列化和反序列化。
当XML结构中包含重复的子元素，例如<cpe-list>下有多个<cpe-item>，并希望将这些<cpe-item>映射到一个Java对象的List中时，正确的注解使用至关重要。如果注解配置不当，Jackson可能只会识别并解析最后一个同名元素，导致数据丢失。
2. 问题分析：为何只解析到最后一个元素？
在初始的代码实现中，CpeList类中的cpeItems字段被定义为单个CpeItem对象：
@Data
@JacksonXmlRootElement(localName = "cpe-list")
public class CpeList {
@JacksonXmlElementWrapper(localName = "cpe-item")
private CpeItem cpeItems; // 这里定义为单个CpeItem
}而对应的XML结构是：
<cpe-list>
<cpe-item name="John">
<title>xmlread</title>
</cpe-item>
<cpe-item name="Jack">
<title>testtitle</title>
</cpe-item>
</cpe-list>当Jackson尝试将XML中的多个<cpe-item>元素映射到CpeList的cpeItems字段时，由于cpeItems被声明为单个CpeItem类型，它会不断覆盖前一个解析到的值，最终只保留最后一个<cpe-item>的数据。要正确解析所有<cpe-item>，cpeItems字段必须是一个List<CpeItem>类型。
3. 构建正确的Java数据模型
为了正确地将XML中的多个<cpe-item>元素解析到Java的List中，我们需要对CpeList类进行修改。
3.1 CpeItem 数据模型
CpeItem类用于映射单个<cpe-item>元素。根据XML结构，它包含一个name属性和一个title子元素。
package com.dependency.demo;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;
import lombok.Data;
@Data
@JacksonXmlRootElement(localName = "cpe-item") // 标识XML根元素为cpe-item
public class CpeItem {
@JacksonXmlProperty(localName = "name", isAttribute = true) // 映射name属性
private String name;
// Jackson默认会将与字段名匹配的子元素映射，此处title无需额外注解
private String title;
}3.2 CpeList 数据模型（修正后）
CpeList类用于映射根元素<cpe-list>，并包含一个CpeItem对象的列表。关键在于@JacksonXmlElementWrapper和@JacksonXmlProperty的组合使用。
package com.dependency.demo;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;
import lombok.Data;
import java.util.List;
@Data
@JacksonXmlRootElement(localName = "cpe-list") // 标识XML根元素为cpe-list
public class CpeList {
/**
* @JacksonXmlElementWrapper(useWrapping = false):
* 表示XML中没有额外的包装元素来包裹cpe-item列表。
* 例如，如果XML是 <cpe-list><items><cpe-item>...</cpe-item></items></cpe-list>，
* 那么`useWrapping`应为true，`localName`为"items"。
* 但在我们的XML中，<cpe-item>直接是<cpe-list>的子元素，因此`useWrapping = false`。
*
* @JacksonXmlProperty(localName = "cpe-item"):
* 指定列表中每个元素的XML标签名为"cpe-item"。
*/
@JacksonXmlElementWrapper(useWrapping = false)
@JacksonXmlProperty(localName = "cpe-item")
private List<CpeItem> cpeItems; // 将字段类型改为List<CpeItem>
}注解详解：
- @JacksonXmlRootElement(localName = "cpe-list"): 指示此Java类映射XML的根元素<cpe-list>。
- @JacksonXmlElementWrapper(useWrapping = false): 这是解决问题的关键。它告诉Jackson，XML中没有一个额外的“包装”元素来包含cpe-item列表。在我们的XML中，<cpe-item>元素直接作为<cpe-list>的子元素出现，没有像<items>这样的中间层。因此，useWrapping = false是必要的。
- @JacksonXmlProperty(localName = "cpe-item"): 指定列表中每个元素的XML标签名为cpe-item。结合@JacksonXmlElementWrapper，Jackson知道它应该收集所有名为cpe-item的子元素并将它们放入cpeItems列表中。
4. 实现XML解析控制器
在Spring Boot控制器中，我们将使用XmlMapper来执行XML的反序列化操作。
package com.dependency.demo;
import com.fasterxml.jackson.dataformat.xml.XmlMapper;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import java.io.IOException;
import java.io.InputStream;
@RestController
public class XmlController {
@GetMapping("/parse-xml") // 定义一个REST端点
public CpeList parseCpeListXml() throws XMLStreamException, IOException {
// 从classpath加载XML文件
InputStream xmlResource = XmlController.class.getClassLoader().getResourceAsStream("test.xml");
if (xmlResource == null) {
throw new IOException("XML file 'test.xml' not found in classpath.");
}
// 使用XMLInputFactory创建XMLStreamReader，提高解析效率和内存管理
XMLInputFactory xmlInputFactory = XMLInputFactory.newFactory();
XMLStreamReader xmlStreamReader = xmlInputFactory.createXMLStreamReader(xmlResource);
// 创建XmlMapper实例
XmlMapper mapper = new XmlMapper();
// 如果需要，可以配置DeserializationFeature，例如忽略未知属性
// mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
// 执行XML反序列化
CpeList cpeList = mapper.readValue(xmlStreamReader, CpeList.class);
// 打印解析结果以验证
System.out.println("Parsed CpeList:");
if (cpeList != null && cpeList.getCpeItems() != null) {
for (CpeItem cpeItem : cpeList.getCpeItems()) {
System.out.println(" Name: " + cpeItem.getName() + ", Title: " + cpeItem.getTitle());
}
} else {
System.out.println(" No CpeItems parsed.");
}
return cpeList;
}
}XML文件 (src/main/resources/test.xml):
<?xml version="1.0" encoding="UTF-8" ?>
<cpe-list>
<cpe-item name="John">
<title>xmlread</title>
</cpe-item>
<cpe-item name="Jack">
<title>testtitle</title>
</cpe-item>
</cpe-list>5. 测试与验证
启动Spring Boot应用后，访问 /parse-xml 端点（例如 http://localhost:8080/parse-xml），您将看到JSON格式的CpeList对象，其中cpeItems字段是一个包含两个CpeItem对象的列表：
预期输出示例 (JSON格式):
{
"cpeItems": [
{
"name": "John",
"title": "xmlread"
},
{
"name": "Jack",
"title": "testtitle"
}
]
}同时，控制台也会打印出解析的CpeItem信息，验证所有元素都被正确解析。
6. 注意事项与最佳实践
-
依赖管理: 确保您的pom.xml文件中包含jackson-dataformat-xml依赖。
<dependency> <groupId>com.fasterxml.jackson.dataformat</groupId> <artifactId>jackson-dataformat-xml</artifactId> </dependency> - XML结构与Java模型匹配: Jackson的XML模块对XML结构与Java类之间的匹配要求较高。仔细检查XML元素名、属性名与Java字段名及注解是否一致。
-
useWrapping属性: 这是处理列表类型XML的关键。
- useWrapping = false: 当列表元素直接是父元素的子元素时使用（如本例）。
- useWrapping = true (默认值): 当列表元素被一个额外的包装元素包裹时使用。例如，如果XML是<parent><items><item/><item/></items></parent>，则items是包装元素，item是列表元素。
- 错误处理: 在实际应用中，应增加对InputStream为空、XML解析异常等情况的健壮性处理。
- Lombok: 本教程使用了Lombok的@Data注解来自动生成getter/setter、equals、hashCode和toString方法，简化了代码。如果您的项目不使用Lombok，需要手动编写这些方法。
7. 总结
通过正确配置Jackson的XML注解，特别是@JacksonXmlElementWrapper(useWrapping = false)和@JacksonXmlProperty(localName = "...")，我们可以有效地将包含重复子元素的XML结构映射到Java的List对象中。理解这些注解的语义及其与XML结构的对应关系，是成功进行XML解析的关键。本教程提供了一个完整的示例，希望能帮助初学者在Spring Boot中顺利进行Jackson XML解析。
