使用 MOXy 的 JAXB 中的动态 CDATA

Question

我正在使用EclipseLink JAXB (MOXy)。我有一个问题，Java 类的属性可以是 CDATA 或不是动态的。例如，

class Embed{  
//@XmlValue only  
//OR @XmlValue @CDATA  
private String value; //THIS CAN BE CDATA OR NOT  
}

我尝试使用继承来解决问题，其中一个子类将属性作为值，另一个作为 CDATA。我对这个解决方案的问题是生成的 Xml 具有我不想要的 xsi:type 和 xmlns:xsi 信息，因为我正在升级旧代码并且我需要生成的 xml 与旧代码完全相同。

我尝试过的解决方案：

@XmlAccessorType(XmlAccessType.FIELD)  
@XmlType(name = "itemType", namespace = "", propOrder = {"embed"}  
public class Item{  
 List`<Embed>` embed;  
 //getter and setters  
}

@XmlAccessorType(XmlAccessType.NONE)  
@XmlSeeAlso(EmbedDefault.class, EmbedAsCdata.class)  
public abstract class Embed{

}

@XmlAccessorType(XmlAccessType.FIELD)    
@XmlType( propOrder = {"value"})  
public class EmbedDefault extends Embed{

@XmlValue
protected String value;
 //getters and setters  
}

@XmlAccessorType(XmlAccessType.FIELD)  
@XmlType(propOrder = {"value"})  
public class EmbedAsCdata extends Embed {  

@XmlValue
@XmlCDATA
protected String value;
//getters and setters  
}

还有这样更简单的方法吗？

Answer 1

注意：我是EclipseLink JAXB (MOXy) 的负责人，也是JAXB (JSR-222) 专家组的成员。

我正在尝试为您提供一个体面的解决方法，但您可以遵循以下增强请求，我们将增强 @XmlCDATA 注释以使此用例更易于支持。

• http://bugs.eclipse.org/374977

---

更新 #1

以下是我正在为您的用例开发的一种方法。它需要对 MOXy 进行一些小改动，我已经想通了，但仍需要全面测试。您可以使用以下链接跟踪我们在此问题上的进展：

• http://bugs.eclipse.org/397517

DomHandler (CdataHandler)

JAXB 具有DomHandler 的概念，它允许您对 XML 的外观进行一些额外的控制。我们将利用DomHandler 在需要时添加CDATA 块。

package forum14145131;

import javax.xml.bind.ValidationEventHandler;
import javax.xml.bind.annotation.DomHandler;
import javax.xml.parsers.*;
import javax.xml.transform.Source;
import javax.xml.transform.dom.*;

import org.w3c.dom.*;

public class CdataHandler implements DomHandler<String, DOMResult> {

    private static DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();;

    @Override
    public DOMResult createUnmarshaller(ValidationEventHandler veh) {
        return new DOMResult();
    }

    @Override
    public String getElement(DOMResult domResult) {
        Document document = (Document) domResult.getNode();
        return document.getDocumentElement().getTextContent();
    }

    @Override
    public Source marshal(String string, ValidationEventHandler veh) {
        try {
            DocumentBuilder db = dbf.newDocumentBuilder();
            Document document = db.newDocument();

            Node node;
            if(string.contains("<") || string.contains("&") || string.contains("&")) {
                node = document.createCDATASection(string);
            } else {
                node = document.createTextNode(string);
            }
            return new DOMSource(node);
        } catch(Exception e) {
            throw new RuntimeException(e);
        }
    }

}

嵌入

@XmlAnyElement 注解用于指定DomHandler。

package forum14145131;

import javax.xml.bind.annotation.*;

@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
class Embed{  

    @XmlAnyElement(CdataHandler.class)
    private String value; //THIS CAN BE CDATA OR NOT  

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        this.value = value;
    }

}

更多信息

• http://blog.bdoughan.com/2011/04/xmlanyelement-and-non-dom-properties.html

---

更新 #2

以下是您现在可以使用现有的 EclipseLink 库并利用 XmlAdapter 和 CharacterEscapeHandler 的方法：

XmlAdapter (CdataAdapter)

package forum14145131;

import javax.xml.bind.annotation.adapters.XmlAdapter;

public class CdataAdapter extends XmlAdapter<String, String> {

    @Override
    public String marshal(String string) throws Exception {
        if(string.contains("&") || string.contains("<") || string.contains("\"")) {
            return "<![CDATA[" + string + "]]>";
        } else {
            return string;
        }
    }
    @Override
    public String unmarshal(String string) throws Exception {
        return string;
    }

}

嵌入

@XmlJavaTypeAdapter 注解用于指定XmlAdapter。

package forum14145131;

import javax.xml.bind.annotation.*;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;

@XmlRootElement
@XmlAccessorType(XmlAccessType.FIELD)
class Embed{  

    @XmlValue
    @XmlJavaTypeAdapter(CdataAdapter.class)
    private String value; //THIS CAN BE CDATA OR NOT  

    public String getValue() {
        return value;
    }

    public void setValue(String value) {
        this.value = value;
    }

}

演示

以下是指定CharacterEscapeHandler 的方法。请注意，这会覆盖此 Marshaller 的所有字符转义。我们这样做是为了避免CDATA 部分被转义。对于生产代码，您对该方法的实现需要比本示例中提供的内容更加强大。

package forum14145131;

import java.io.*;
import javax.xml.bind.*;
import org.eclipse.persistence.jaxb.MarshallerProperties;
import org.eclipse.persistence.oxm.CharacterEscapeHandler;

public class Demo {

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

        Unmarshaller unmarshaller = jc.createUnmarshaller();
        File xml = new File("src/forum14145131/input.xml");
        Embed embed = (Embed) unmarshaller.unmarshal(xml);

        Marshaller marshaller = jc.createMarshaller();
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
        marshaller.setProperty(MarshallerProperties.CHARACTER_ESCAPE_HANDLER,
                new CharacterEscapeHandler() {
                    @Override
                    public void escape(char[] ac, int i, int j, boolean flag,
                            Writer writer) throws IOException {
                        writer.write(ac, i, j);
                    }
                });
        marshaller.marshal(embed, System.out);
    }

}

input.xml/Output

<?xml version="1.0" encoding="UTF-8"?>
<embed><![CDATA[Hello & World]]></embed>