JAXB空元素解组

时间:2013-09-20 16:07:20

标签: java xml exception jaxb

问题如下:

我在内部使用空元素获取soap响应(例如... <someDate /> ...) 因此,当JAXB想要解析这个元素时,抛出异常 而是使用null值设置相应的字段。

如何配置JAXB以将空元素视为null? 我们是否可以仅使用JAXB(不使用某些第三方解决方法)

1 个答案:

答案 0 :(得分:9)

基本问题

String不是xsd:date类型的有效值。为了对XML模式有效,可选元素应表示为缺席节点。


为什么基本问题会影响你

所有JAXB实现都会识别出空String不是xsd:date的有效值。他们通过将其报告给ValidationEventHandler的实例来实现此目的。您可以通过执行以下操作自己查看:

    Unmarshaller unmarshaller = jc.createUnmarshaller();
    unmarshaller.setEventHandler(new ValidationEventHandler() {

        @Override
        public boolean handleEvent(ValidationEvent event) {
            System.out.println(event);
            return true;
        }
    });

您正在使用的JAX-WS的实现,利用EclipseLink MOXy作为JAXB提供程序。在您使用MOXy的版本中,默认情况下会在遇到ValidationEvent严重性ERROR时抛出异常,而不是像参考实现那样FATAL_ERROR。这已经在以下错误中得到修复:


解决方法

如果您直接使用JAXB API,则可以简单地覆盖默认的ValidationEventHandler。在JAX-WS环境中,XmlAdapter可用于提供自定义转换逻辑。我们将利用XmlAdapter覆盖与Date的转化处理方式。

XmlAdapter(DateAdapter)

import java.text.SimpleDateFormat;
import java.util.Date;
import javax.xml.bind.annotation.adapters.XmlAdapter;

public class DateAdapter extends XmlAdapter<String, Date>{

    private SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd");

    @Override
    public Date unmarshal(String v) throws Exception {
        if(v.length() == 0) {
            return null;
        }
        return dateFormat.parse(v);
    }

    @Override
    public String marshal(Date v) throws Exception {
        if(null == v) {
            return null;
        }
        return dateFormat.format(v);
    }

}

Java模型(根)

使用XmlAdapter注释引用@XmlJavaTypeAdapter。如果您希望此XmlAdapter适用于Date的所有实例,您可以在包级别注册它(请参阅:http://blog.bdoughan.com/2012/02/jaxb-and-package-level-xmladapters.html)。

import java.util.Date;
import javax.xml.bind.annotation.*;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;

@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
public class Root {

    @XmlSchemaType(name = "date")
    @XmlJavaTypeAdapter(value=DateAdapter.class, type=Date.class)
    private Date abc;

    @XmlSchemaType(name="date")
    @XmlJavaTypeAdapter(value=DateAdapter.class, type=Date.class)
    private Date qwe;

}

演示代码

下面是一个独立的示例,您可以运行以查看一切正常。

<强> jaxb.properties

在使用MOXy作为JAXB提供程序的独立示例中,您需要在与域模型相同的程序包中包含名为jaxb.propeties的文件,并带有以下条目(请参阅:http://blog.bdoughan.com/2011/05/specifying-eclipselink-moxy-as-your.html)。

javax.xml.bind.context.factory=org.eclipse.persistence.jaxb.JAXBContextFactory

<强> input.xml中

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <abc></abc>
    <qwe>2013-09-05</qwe>
</root>

<强>演示

import java.io.File;
import javax.xml.bind.*;

public class Demo {

    public static void main(String[] args) throws Exception {
        JAXBContext jc = JAXBContext.newInstance(Root.class);

        Unmarshaller unmarshaller = jc.createUnmarshaller();
        File xml = new File("src/forum18617998/input.xml");
        Root root = (Root) unmarshaller.unmarshal(xml);

        Marshaller marshaller = jc.createMarshaller();
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
        marshaller.marshal(root, System.out);
    }

}

<强>输出

请注意,在编组的XML中,将null为Date的字段编组为缺少元素(请参阅:http://blog.bdoughan.com/2012/04/binding-to-json-xml-handling-null.html)。

<?xml version="1.0" encoding="UTF-8"?>
<root>
   <qwe>2013-09-05</qwe>
</root>