使用Jackson在Spring Boot中解析XML列表数据-java教程-PHP中文网

使用Jackson在Spring Boot中解析XML列表数据

花韻仙語

发布： 2025-10-01 10:33:26

原创

227人浏览过

使用Jackson在Spring Boot中解析XML列表数据

本文详细介绍了如何在Spring Boot应用中使用Jackson库解析包含重复子元素的XML文件。通过分析常见错误，重点讲解了@JacksonXmlElementWrapper和@JacksonXmlProperty注解的正确使用方法，特别是针对列表类型字段的配置，以确保XML中所有重复元素都能被成功解析到Java对象列表中。

引言

在java spring boot项目中处理xml数据是常见的任务，jackson库提供了强大的xml模块（jackson-dataformat-xml）来简化这一过程。然而，对于初学者来说，解析包含多个相同子元素的xml文件，并将其映射到java对象的list中，可能会遇到一些挑战。本文将通过一个具体的案例，详细演示如何正确配置jackson注解，以实现xml列表数据的完整解析。

XML数据结构示例

我们以一个简单的XML文件为例，该文件包含一个cpe-list根元素，其下有多个cpe-item子元素：

<?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>

登录后复制

目标是将这个XML解析成一个Java对象，其中包含一个CpeItem对象的列表。

定义Java数据模型

首先，我们需要为XML结构中的每个元素定义对应的Java类。

CpeItem 类

cpe-item元素包含一个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") // 指明根元素名称
public class CpeItem {
    @JacksonXmlProperty(localName = "name", isAttribute = true) // 映射为XML属性
    private String name;

    // 默认映射为同名子元素
    private String title;
}

登录后复制

CpeItem类的定义相对直观：

@JacksonXmlRootElement(localName = "cpe-item")：指定该类映射到名为cpe-item的XML元素。
@JacksonXmlProperty(localName = "name", isAttribute = true)：将Java字段name映射到XML元素的name属性。
title字段：Jackson会默认将其映射到cpe-item元素下的title子元素。

CpeList 类（关键部分）

cpe-list是XML的根元素，它包含一个CpeItem对象的列表。正确配置这个类是解析成功的关键。

错误的初始尝试及问题分析：

如果CpeList类最初被定义为：

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.ArrayList;
import java.util.List;

@Data
@JacksonXmlRootElement(localName = "cpe-list")
public class CpeList {
    @JacksonXmlElementWrapper(localName = "cpe-item") // 错误的用法
    private CpeItem cpeItems; // 错误的类型，应为List
}

登录后复制

或者即使是private List<CpeItem> cpeItems;但注解配置不当，也可能导致只解析最后一个cpe-item元素。这是因为Jackson在遇到重复的XML元素时，如果Java字段不是列表类型，或者列表注解配置不正确，它会默认覆盖之前的值，只保留最后一个。

正确的CpeList类定义：

序列猴子开放平台

具有长序列、多模态、单模型、大数据等特点的超大规模语言模型

查看详情

为了正确解析XML中的所有cpe-item元素到一个列表中，CpeList类需要做如下修改：

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; // 确保导入List

@Data
@JacksonXmlRootElement(localName = "cpe-list")
public class CpeList {
    // 关键注解配置
    @JacksonXmlElementWrapper(useWrapping = false) // 表示cpe-item不是在一个额外的包装元素内
    @JacksonXmlProperty(localName = "cpe-item") // 表示列表中的每个元素都是cpe-item
    private List<CpeItem> cpeItem; // 字段名可以与localName不同，但保持语义清晰
}

登录后复制

注解解释：

@JacksonXmlRootElement(localName = "cpe-list")：指定该类映射到名为cpe-list的XML根元素。
@JacksonXmlElementWrapper(useWrapping = false)：这个注解至关重要。它告诉Jackson，XML中的cpe-item元素并不是被一个额外的父元素（例如<items>）包裹起来的。相反，它们是直接作为cpe-list的子元素重复出现的。如果XML结构是<cpe-list><items><cpe-item>...</cpe-item><cpe-item>...</cpe-item></items></cpe-list>，那么useWrapping就应该设置为true，并且localName应指定为items。但在此案例中，cpe-item直接是cpe-list的子元素，因此useWrapping = false是正确的选择。
@JacksonXmlProperty(localName = "cpe-item")：这个注解与@JacksonXmlElementWrapper结合使用，它明确指出列表中每个元素的XML名称是cpe-item。

XML解析控制器

接下来，我们创建一个Spring Boot的RestController来处理HTTP请求，并执行XML解析操作。

package com.dependency.demo;

import com.fasterxml.jackson.databind.DeserializationFeature;
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") // 定义一个GET请求路径
    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.");
        }

        // 创建XMLStreamReader
        XMLInputFactory xmlInputFactory = XMLInputFactory.newFactory();
        XMLStreamReader xmlStreamReader = xmlInputFactory.createXMLStreamReader(xmlResource);

        // 创建XmlMapper实例
        XmlMapper mapper = new XmlMapper();
        // 可选：配置反序列化特性，例如忽略未知属性
        mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);

        // 执行XML解析
        CpeList cpeList = mapper.readValue(xmlStreamReader, CpeList.class);

        // 打印解析结果以验证
        if (cpeList != null && cpeList.getCpeItem() != null) {
            System.out.println("Parsed CpeList with " + cpeList.getCpeItem().size() + " items:");
            for (CpeItem item : cpeList.getCpeItem()) {
                System.out.println("  Name: " + item.getName() + ", Title: " + item.getTitle());
            }
        }

        return cpeList;
    }
}

登录后复制

代码说明：

@GetMapping("/parse-xml")：将parseCpeListXml方法映射到/parse-xml路径的GET请求。
getResourceAsStream("test.xml")：从项目的resources目录下加载test.xml文件。请确保test.xml文件存在于src/main/resources目录中。
XMLInputFactory和XMLStreamReader：Jackson内部使用StAX API进行XML解析，这里显式创建XMLStreamReader是为了演示其工作流程，但Jackson的readValue方法通常可以直接接受InputStream。
XmlMapper mapper = new XmlMapper();：创建Jackson XML模块的核心解析器。
mapper.readValue(xmlStreamReader, CpeList.class);：这是执行实际解析的关键行，将XML流反序列化为CpeList对象。
打印输出：为了验证解析结果，我们遍历了cpeList中的cpeItem列表并打印了每个元素的名称和标题。

运行与验证

部署并运行Spring Boot应用后，访问http://localhost:8080/parse-xml（假设应用运行在8080端口），你将看到如下输出：

控制台输出示例：

Parsed CpeList with 2 items:
  Name: John, Title: xmlread
  Name: Jack, Title: testtitle

登录后复制

HTTP响应体示例：

<CpeList>
    <cpeItem name="John">
        <title>xmlread</title>
    </cpeItem>
    <cpeItem name="Jack">
        <title>testtitle</title>
    </cpeItem>
</CpeList>

登录后复制

这表明两个cpe-item元素都被成功解析并存储在了CpeList对象的cpeItem列表中。

注意事项与总结

依赖管理： 确保在pom.xml中添加了Jackson XML模块的依赖：

<dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-xml</artifactId>
</dependency>

登录后复制

@JacksonXmlElementWrapper 的 useWrapping 属性： 这是处理列表类型字段的关键。
- 当列表元素（如cpe-item）直接作为父元素（如cpe-list）的子元素重复出现时，设置useWrapping = false。
- 当列表元素被一个额外的包装元素包裹时（例如<cpe-list><items><cpe-item>...</cpe-item></items></cpe-list>），则useWrapping应为true（默认值），并且@JacksonXmlElementWrapper(localName = "items")应指定包装元素的名称。
@JacksonXmlProperty 的 localName 属性： 确保它与XML中实际的元素名称匹配。
字段类型： 对于要解析为列表的XML元素，Java字段必须声明为List<T>类型。
错误处理： 在实际应用中，应添加更健壮的错误处理机制，例如文件未找到、XML格式错误等。