java - 在 Spring 强制将XML编码中的特殊字符转义

我想在使用Spring Marshaller时强制转义特殊字符。当我使用javax.xml.bind.Marshaller时，以下代码可以完美地工作

书本类

package com.odr.core.action;

import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlRegistry;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;

@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name = "book")
public class Book {

    private String name;
    private String author;
    private String publisher;
    private String isbn;

    @XmlJavaTypeAdapter(value=CDATAAdapter.class)
    private String description;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getAuthor() {
        return author;
    }

    public void setAuthor(String author) {
        this.author = author;
    }

    public String getPublisher() {
        return publisher;
    }

    public void setPublisher(String publisher) {
        this.publisher = publisher;
    }

    public String getIsbn() {
        return isbn;
    }

    public void setIsbn(String isbn) {
        this.isbn = isbn;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }

    @Override
    public String toString() {
        return "Book [name=" + name + ", author=" + author + ", publisher="
            + publisher + ", isbn=" + isbn + ", description=" + description
            + "]";
    }
}

XML的对象

        writer = new BufferedWriter(new FileWriter(selectedFile));
        context = JAXBContext.newInstance(Book.class);
        Marshaller m = context.createMarshaller();
        m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);

        m.setProperty("com.sun.xml.bind.marshaller.CharacterEscapeHandler",
                new CharacterEscapeHandler() {
                    @Override
                    public void escape(char[] ch, int start, int length,
                            boolean isAttVal, Writer writer)
                            throws IOException {
                        writer.write(ch, start, length);
                    }
                });
        m.marshal(book, writer);

输出:

<description>

<![CDATA[<p>With hundreds of practice questions and hands-on exercises, <b>SCJP Sun Certified Programmer for Java 6 Study Guide</b> covers what you need to know--and shows you how to prepare--for this challenging exam. </p>]]>
</description>

但是当我使用org.springframework.oxm.jaxb.Jaxb2Marshaller时，相同类型的代码不起作用，下面是代码

    Jaxb2Marshaller jaxb2Marshaller = new Jaxb2Marshaller();
    Map<String, Object> map = new HashMap<String, Object>();
    map.put("jaxb.formatted.output", true);
    jaxb2Marshaller.setPackagesToScan("com.odr.core.action");
    // com.sun.xml.bind.characterEscapeHandler
    // com.sun.xml.bind.marshaller.CharacterEscapeHandler
    map.put("com.sun.xml.bind.marshaller.CharacterEscapeHandler",
            new CharacterEscapeHandler() {
                @Override
                public void escape(char[] ac, int i, int j, boolean flag,
                        Writer writer) throws IOException {
                    writer.write(ac, i, j);
                }
            });
    jaxb2Marshaller.setMarshallerProperties(map);

    org.springframework.oxm.Marshaller marshaller = jaxb2Marshaller;
    FileOutputStream fos = null;
    // String fileNamePath = directory.getAbsolutePath() + "\\" + fileName;

    try {
        // fos = new FileOutputStream(fileNamePath);
        fos = new FileOutputStream(selectedFile);
        marshaller.marshal(book, new StreamResult(fos));

        // File f = new File(directory,fileName);
    } catch (Exception e) {
        e.printStackTrace();
    } finally {
        if (fos != null) {
            fos.close();
        }
    }

输出

<description>&lt;![CDATA[&lt;p&gt;With hundreds of practice questions and hands-on exercises, &lt;b&gt;SCJP Sun Certified Programmer for Java 6 Study Guide&lt;/b&gt; covers what you need to know--and shows you how to prepare--for this challenging exam. &lt;/p&gt;]]&gt;</description>

第一个片段未对特殊字符进行编码。但是，虽然我设置了属性，但是使用Spring的第二个片段确实进行了编码。我必须在项目中使用Spring才能不影响现有代码。有什么办法可以解决吗

最佳答案

好的，我遇到了同样的问题，并且我用这种方法解决了。

首先是第一件事。您应该创建两个bean。一个用于Jaxb2Marshaller，另一个用于MarshallingHttpMessageConverter。我假设您想保留您的配置，所以我将使用您的代码。

创建Jaxb2Marshaller bean:

@Bean
public Jaxb2Marshaller getJaxb2Marshaller() {
    Jaxb2Marshaller jaxb2Marshaller = new Jaxb2Marshaller();
    Map<String, Object> map = new HashMap<String, Object>();
    map.put("jaxb.formatted.output", true);
    jaxb2Marshaller.setPackagesToScan("com.odr.core.action");
    map.put("com.sun.xml.internal.bind.marshaller.CharacterEscapeHandler",
            new CharacterEscapeHandler() {
                @Override
                public void escape(char[] ac, int i, int j, boolean flag,
                                   Writer writer) throws IOException {
                    writer.write(ac, i, j);
                }
            });
    jaxb2Marshaller.setMarshallerProperties(map);

    org.springframework.oxm.Marshaller marshaller = jaxb2Marshaller;
    FileOutputStream fos = null;

    try {
        fos = new FileOutputStream(selectedFile);
        marshaller.marshal(book, new StreamResult(fos));
    } catch (Exception e) {
        e.printStackTrace();
    } finally {
        if (fos != null) {
            fos.close();
        }
    }

    return jaxb2Marshaller;
}

好吧，我使用的是Java 8，因此如上所述，我将 com.sun.xml.bind.marshaller.CharacterEscapeHandler 更改为 com.sun.xml.internal.bind.marshaller.CharacterEscapeHandler 。

创建MarshallingHttpMessageConverter bean:

@Bean
public MarshallingHttpMessageConverter getMarshallingHttpMessageConverter() {
    return new MarshallingHttpMessageConverter(getJaxb2Marshaller());
}

您必须注意，我已经创建了自己的HttpMessageConverter来解决该问题。这是因为Spring每次需要将实体或DTO转换为XML对象时，都会使用自己的转换器来创建新的Marshaller实例。因此，我认为以下代码将解决您的问题。希望对您有帮助。

import com.sun.xml.internal.bind.marshaller.CharacterEscapeHandler;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.xml.MarshallingHttpMessageConverter;
import org.springframework.oxm.jaxb.Jaxb2Marshaller;

@Configuration
public class XmlParseConfig {
    @Bean
    public Jaxb2Marshaller getJaxb2Marshaller() {
        Jaxb2Marshaller jaxb2Marshaller = new Jaxb2Marshaller();
        Map<String, Object> map = new HashMap<String, Object>();
        map.put("jaxb.formatted.output", true);
        jaxb2Marshaller.setPackagesToScan("com.odr.core.action");
        map.put("com.sun.xml.internal.bind.marshaller.CharacterEscapeHandler",
                new CharacterEscapeHandler() {
                    @Override
                    public void escape(char[] ac, int i, int j, boolean flag,
                                       Writer writer) throws IOException {
                        writer.write(ac, i, j);
                    }
                });
        jaxb2Marshaller.setMarshallerProperties(map);

        org.springframework.oxm.Marshaller marshaller = jaxb2Marshaller;
        FileOutputStream fos = null;

        try {
            fos = new FileOutputStream(selectedFile);
            marshaller.marshal(book, new StreamResult(fos));
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            if (fos != null) {
                fos.close();
            }
        }

        return jaxb2Marshaller;
    }

    @Bean
    public MarshallingHttpMessageConverter getMarshallingHttpMessageConverter() {
        return new MarshallingHttpMessageConverter(getJaxb2Marshaller());
    }
}