Java 中解析 XML 请求到 Java 对象

本文介绍了如何使用 JAXB (Java Architecture for XML Binding) 将 XML 请求解析为 Java 对象,重点解决了由于 XML 命名空间不匹配导致的 `UnmarshalException` 异常。通过示例代码和详细步骤,帮助开发者理解和掌握 XML 解析的关键配置,确保 XML 数据能正确映射到 Jav

a 类。

在 Java 开发中,XML 数据的处理非常常见。JAXB 是一种方便的工具,可以将 XML 数据绑定到 Java 对象,从而简化了 XML 数据的解析和生成。然而,在实际应用中,可能会遇到 javax.xml.bind.UnmarshalException: unexpected element 异常,这通常是由于 XML 命名空间不匹配引起的。本文将详细介绍如何解决这个问题,并提供一个完整的示例。

问题分析

当使用 JAXB 进行 XML 反序列化时,JAXB 引擎会检查 XML 元素的命名空间是否与 Java 类的 @XmlRootElement 注解中定义的命名空间匹配。如果不匹配,就会抛出 UnmarshalException 异常。

例如,以下 XML 示例:



  asasas

对应的 Java 类如下:

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlValue;

@XmlRootElement(name = "Signature")
public class Signature {

    private String xmlns;
    private String text;

    @XmlAttribute(name = "xmlns")
    public String getXmlns() {
        return xmlns;
    }

    public void setXmlns(String xmlns) {
        this.xmlns = xmlns;
    }

    @XmlValue
    public String getText() {
        return text;
    }

    public void setText(String text) {
        this.text = text;
    }
}

如果使用上述代码进行反序列化,将会出现 javax.xml.bind.UnmarshalException: unexpected element (uri:"http://www.w3.org/2000/09/xmldsig", local:"Signature"). Expected elements are 异常。这是因为 XML 文档中的 元素定义了命名空间 http://www.w3.org/2000/09/xmldsig,而 Java 类中的 @XmlRootElement 注解没有指定命名空间,导致命名空间不匹配。

解决方案

解决此问题的关键是在 @XmlRootElement 注解中指定正确的命名空间。

修改后的 Java 类如下:

import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlValue;

@XmlRootElement(name = "Signature", namespace="http://www.w3.org/2000/09/xmldsig")
public class Signature {

    private String xmlns;
    private String text;

    @XmlAttribute(name = "xmlns")
    public String getXmlns() {
        return xmlns;
    }

    public void setXmlns(String xmlns) {
        this.xmlns = xmlns;
    }

    @XmlValue
    public String getText() {
        return text;
    }

    public void setText(String text) {
        this.text = text;
    }
}

通过在 @XmlRootElement 注解中添加 namespace="http://www.w3.org/2000/09/xmldsig",指定了 XML 元素的命名空间,确保了 XML 文档和 Java 类之间的命名空间匹配,从而避免了 UnmarshalException 异常。

完整示例代码

以下是一个完整的示例代码,演示了如何使用 JAXB 将 XML 请求解析为 Java 对象。

import javax.xml.bind.JAXBContext;
import javax.xml.bind.JAXBException;
import javax.xml.bind.Unmarshaller;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlValue;
import java.io.StringReader;

@XmlRootElement(name = "Signature", namespace="http://www.w3.org/2000/09/xmldsig")
class Signature {

    private String xmlns;
    private String text;

    @XmlAttribute(name = "xmlns")
    public String getXmlns() {
        return xmlns;
    }

    public void setXmlns(String xmlns) {
        this.xmlns = xmlns;
    }

    @XmlValue
    public String getText() {
        return text;
    }

    public void setText(String text) {
        this.text = text;
    }

    @Override
    public String toString() {
        return "Signature{" +
                "xmlns='" + xmlns + '\'' +
                ", text='" + text + '\'' +
                '}';
    }
}

public class XmlParser {

    public static void main(String[] args) {
        String xml = "\n" +
                "\n" +
                "  asasas\n" +
                "";

        try {
            JAXBContext jaxbContext = JAXBContext.newInstance(Signature.class);
            Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();
            Signature signature = (Signature) unmarshaller.unmarshal(new StringReader(xml));

            System.out.println(signature);

        } catch (JAXBException e) {
            e.printStackTrace();
        }
    }
}

注意事项

  • 确保 @XmlRootElement 注解中的 name 属性与 XML 文档中的根元素名称一致。
  • 如果 XML 文档中定义了命名空间,必须在 @XmlRootElement 注解中指定相应的 namespace 属性。
  • 如果 XML 文档中使用了多个命名空间,需要在 Java 类中使用 @XmlSchema 注解进行声明。

总结

使用 JAXB 将 XML 请求解析为 Java 对象时,需要注意 XML 命名空间的处理。通过在 @XmlRootElement 注解中指定正确的命名空间,可以避免 UnmarshalException 异常,确保 XML 数据能正确映射到 Java 类。本文提供了一个完整的示例代码,帮助开发者理解和掌握 XML 解析的关键配置。