Jackson / Woodstox XML编码字符解释

时间:2016-11-03 23:33:56

标签: xml jackson woodstox jackson-dataformat-xml xmlmapper

我已经递交了一个XML文件,其中包含使用Jackson和Woodstox读取,编辑和编写它的指令(根据文档中的建议)。在大多数情况下,这并不太难;他们都非常擅长做什么。不过,在这一点上,我遇到了一个问题:

我的XML对象本身包含XML对象。例如:

<XMLObject>
    <OuterObject attributeOne="1" attributeTwo="2" attributeThree="&gt;">
        <InnerObject>&lt;NestedObject&gt;Blah&lt;/NestedObject&gt;</InnerObject>
    </OuterObject>
    <OuterObject attributeOne="11" attributeTwo="22" attributeThree="&lt;">
        <InnerObject>&lt;NestedObject&gt;Blah&lt;/NestedObject&gt;</InnerObject>
    </OuterObject>
    <OuterObject attributeOne="111" attributeTwo="222" attributeThree="3" />
<XMLObject>

当我将XML文件读入我的Jackson注释的Java对象时,Woodstox将&lt;&gt;的所有实例转换为<> }, 分别。当我将对象作为XML文件写回时,<变为&lt;>保持>

<XMLObject>
    <OuterObject attributeOne="1" attributeTwo="2" attributeThree=">">
        <InnerObject>&lt;NestedObject>Blah&lt;/NestedObject></InnerObject>
    </OuterObject>
    <OuterObject attributeOne="11" attributeTwo="22" attributeThree="&lt;">
        <InnerObject>&lt;NestedObject>Blah&lt;/NestedObject></InnerObject>
    </OuterObject>
    <OuterObject attributeOne="111" attributeTwo="222" attributeThree="3" />
<XMLObject>

我最努力阅读文件的方法的最简单版本如下:

@RequestMapping("readXML")
public @ResponseBody CustomXMLObject readXML() throws Exception {
    File inputFile = new File(FILE_PATH);
    XmlMapper mapper = new XmlMapper();
    CustomXMLObject value = mapper.readValue(inputFile, CustomXMLObject .class);

    return value;
}

我的杰克逊注释的Java对象看起来像我上面给出的例子:

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;

@JsonInclude(JsonInclude.Include.NON_NULL)
public class CustomXMLObject {
    @JacksonXmlProperty(isAttribute=true)
    private long attributeOne;
    @JacksonXmlProperty(isAttribute=true)
    private String attributeTwo;
    @JacksonXmlProperty(isAttribute=true)
    private String attributeThree;
    @JacksonXmlProperty(localName = "InnerObject")
    private String innerObject;


    public long getAttributeOne() {
        return attributeOne;
    }

    public void setAttributeOne(long attributeOne) {
        this.attributeOne = attributeOne;
    }

    public String getAttributeTwo() {
        return attributeTwo;
    }

    public void setAttributeTwo(String attributeTwo) {
        this.attributeTwo = attributeTwo;
    }

    public String getAttributeThree() {
        return attributeThree;
    }

    public void setAttributeThree(String attributeThree) {
        this.attributeThree = attributeThree;
    }

    public String getInnerObject() {
        return innerObject;
    }

    public void setInnerObject(String innerObject) {
        this.innerObject = innerObject;
    }
}

最后,我的依赖关系看起来像这样:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>com.jayway.jsonpath</groupId>
    <artifactId>json-path</artifactId>
    <scope>test</scope>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.module</groupId>
    <artifactId>jackson-module-jaxb-annotations</artifactId>
    <version>2.5.0</version>
</dependency>
<dependency>
        <groupId>com.fasterxml.jackson.dataformat</groupId>
        <artifactId>jackson-dataformat-xml</artifactId>
        <version>2.8.4</version>
</dependency>
<dependency>
    <groupId>org.codehaus.woodstox</groupId>
    <artifactId>woodstox-core-asl</artifactId>
    <version>4.4.1</version>
</dependency>

这似乎是由于杰克逊使用Woodstox的BufferingXmlWriter而发生的。这个特殊的作家将拦截这些角色并对其进行编码,似乎没有任何方法可以绕过这个决定:

private final void writeAttrValue(String value, int len) throws IOException {
    int inPtr = 0;
    char qchar = this.mEncQuoteChar;
    int highChar = this.mEncHighChar;

    while(true) {
        String ent = null;

        while(true) {
            if(inPtr >= len) {
                return;
            }

            char c = value.charAt(inPtr++);
            if(c <= 60) {
                if(c < 32) {
                    if(c == 13) {
                        if(this.mEscapeCR) {
                            break;
                        }
                    } else {
                        if(c == 10 || c == 9 || this.mXml11 && c != 0) {
                            break;
                        }

                        c = this.handleInvalidChar(c);
                    }
                } else {
                    if(c == qchar) {
                        ent = this.mEncQuoteEntity;
                        break;
                    }

                    if(c == 60) {
                        ent = "&lt;";
                        break;
                    }

                    if(c == 38) {
                        ent = "&amp;";
                        break;
                    }
                }
            } else if(c >= highChar) {
                break;
            }

            if(this.mOutputPtr >= this.mOutputBufLen) {
                this.flushBuffer();
            }

            this.mOutputBuffer[this.mOutputPtr++] = c;
        }

        if(ent != null) {
            this.writeRaw(ent);
        } else {
            this.writeAsEntity(value.charAt(inPtr - 1));
        }
    }
}

所以为了总结问题,我得到了一个XML文件。该XML文件包含属性和元素,这些属性和元素本身包含已编码(<>)的符号(&lt;&gt;),以免破坏XML 。当Woodstox读取文件时,它不是将我的Java对象交给XML中包含的实际字符串,而是解码该字符。写完后,只有<被重新编码为&lt;。这似乎正在发生,因为杰克逊正在使用Woodstox的BufferingXmlWriter,它似乎无法配置以避免编码这些字符。

结果,我的问题如下:

我是否可以将Jackson对象配置为使用Woodstox XML阅读器,该阅读器允许我在不进一步编码的情况下读取和写入XML文件中的字符,或者我是否需要完全根据自己的需要研究不同的解决方案?

1 个答案:

答案 0 :(得分:0)

您可以将基础XMLOutputFactory2配置为使用CharacterEscapes,它可以指定覆盖默认情况下转义的内容。会这样:

http://www.cowtowncoder.com/blog/archives/2012/08/entry_476.html

工作?

编辑:对上面的建议表示道歉 - 这不适用于XML,只适用于JSON。我应该仔细检查一下。虽然有一个工作项可以使它也可以使用XML,但这还不存在(截至2016年11月)。