JAXB生成CDATA类型的节点

最新推荐文章于 2023-10-10 15:47:53 发布
最新推荐文章于 2023-10-10 15:47:53 发布
阅读量7.4k 收藏 4
点赞数 2
分类专栏： java netbean jaxb eclipse 文章标签： java jaxb cdata maven Moxy
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/xiaofanku/article/details/52655641
版权
java 同时被 3 个专栏收录
60 篇文章 1 订阅
订阅专栏
eclipse
8 篇文章 0 订阅
订阅专栏
netbean
5 篇文章 0 订阅
订阅专栏

实体:

import com.t3news.doc.biz.xml.CDATAAdapter;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlTransient;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;

/**
 *
 * @author xiaofanku
 */
@XmlAccessorType(XmlAccessType.NONE)
@XmlRootElement
public class Section {
    /**
     * 索引名称
     */
    @XmlElement
    private String indexName;
    /**
     * 内容
     */
    @XmlJavaTypeAdapter(value=CDATAAdapter.class)
    private String content;
    /**
     * 锚点
     */
    @XmlTransient
    private String[] anchors;
    /**
     * 节标题
     */
    @XmlElement
    private String title;

    //SET/GET

}

测试主类:

    /**
     * @param args the command line arguments
     */
    public static void main(String[] args) {
        // TODO code application logic here
        Section s=new Section();
        s.setTitle("第二季：辣妈自拍上瘾誓做网红");
        s.setContent("<html><p>《四大名助》是一档社交服务爆笑节目。由著名主持人孟非领衔，并搭档三位一线名嘴嘉宾组成的“四大名助”阵容，</p></html>");
        s.setIndexName(StringHelper.randomUUID());

        try {
            Entry.saveSection(s,new File("d://"));
        } catch (JAXBException |IOException ex) {
            Logger.getLogger(TestFile.class.getName()).log(Level.SEVERE, null, ex);
        }
    }

Entry.saveSection方法

    public static void saveSection(Section section, File directory) throws JAXBException, IOException {
        File f=new File(directory,File.separator+section.getIndexName()+".xml");
        if(!f.exists()){
            f.createNewFile();
        }
        toXML(section,Section.class,f);
    }

A: JDK的实现,不需要引入任何jar,主要使用jdk中的rt.jar

    public static <T> void toXML(T obj,Class<?> cls,File output) throws JAXBException{    
        JAXBContext jc = JAXBContext.newInstance(cls);
        Marshaller marshaller = jc.createMarshaller();
        marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8");
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
        //JDK
        marshaller.setProperty("com.sun.xml.internal.bind.characterEscapeHandler", (com.sun.xml.internal.bind.marshaller.CharacterEscapeHandler) (char[] chars, int i, int i1, boolean bln, Writer writer) -> {
            writer.write(chars, i, i1);
        });
        // Output XML
        marshaller.marshal(obj,output);

    }

上面的代码中有个lambda表达式,不过此法至jdk6+都可以

B: JAXB-RI的实现,需要使用以下jar,pom.xml截选

    <repositories>
        <repository>
            <id>central</id>
            <url>http://repo.maven.apache.org/maven2/</url>
        </repository>
    </repositories>
    <properties>
        <endorsed.dir>${project.build.directory}/endorsed</endorsed.dir>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <jaxb-version>2.2.11</jaxb-version>
    </properties>

    <dependencies>
        <!-- https://mvnrepository.com/artifact/org.glassfish.jaxb/jaxb-core -->
        <dependency>
            <groupId>org.glassfish.jaxb</groupId>
            <artifactId>jaxb-core</artifactId>
            <version>${jaxb-version}</version>
        </dependency>
        <dependency>
            <groupId>org.glassfish.jaxb</groupId>
            <artifactId>jaxb-xjc</artifactId>
            <version>${jaxb-version}</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.glassfish.jaxb/jaxb-runtime -->
        <dependency>
            <groupId>org.glassfish.jaxb</groupId>
            <artifactId>jaxb-runtime</artifactId>
            <version>${jaxb-version}</version>
        </dependency>

toXML方法:

    public static <T> void toXML(T obj,Class<?> cls,File output) throws JAXBException{    
        JAXBContext jc = JAXBContext.newInstance(cls);
        Marshaller marshaller = jc.createMarshaller();
        marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8");
        marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
        //JAXB/RI
        //https://jaxb.java.net/nonav/2.2.11/docs/ch05.html
        marshaller.setProperty("com.sun.xml.bind.characterEscapeHandler",new com.sun.xml.bind.marshaller.CharacterEscapeHandler(){
            @Override
            public void escape(char[] chars, int i, int i1, boolean bln, Writer writer) throws IOException {
                writer.write(chars, i, i1);
            }
        });
        // Output XML
        marshaller.marshal(obj,output);
    }

C: 使用eclipselink
pom.xml截选:

    <repositories>
        <repository>
            <id>central</id>
            <url>http://repo.maven.apache.org/maven2/</url>
        </repository>
        <repository>
            <id>EclipseLink</id>
            <url>http://download.eclipse.org/rt/eclipselink/maven.repo</url>
        </repository>
    </repositories>
    <properties>
        <endorsed.dir>${project.build.directory}/endorsed</endorsed.dir>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <eclipseLink-version>2.6.4</eclipseLink-version>
        <jaxb-version>2.2.11</jaxb-version>
    </properties>
    <dependencies>
        <dependency>
            <groupId>org.eclipse.persistence</groupId>
            <artifactId>eclipselink</artifactId>
            <version>${eclipseLink-version}</version>
            <exclusions>
                <exclusion>
                    <groupId>org.eclipse.persistence</groupId>
                    <artifactId>commonj.sdo</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

以上(A,B)方法都使用了一个javax.xml.bind.annotation.adapters.XmlAdapter的子类在元素的内容前后包裹

<![CDATA[

和 

]]>

,因为marshaller输出时会自动转义实体符号,所以要重写相应的characterEscapeHandler, 如果属性和实现类型不匹配会把CDATA的

<

和

>

也转义掉同时输出以下错误(红色框住的)

这里写图片描述

以下代码是上面的CDATAAdapter

package com.t3news.doc.biz.xml;

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

/**
 *
 * @author xiaofanku
 */
public class CDATAAdapter extends XmlAdapter<String, String>{
   private static final String CDATA_END = "]]>";
   private static final String CDATA_BEGIN = "<![CDATA[";

    @Override
    public String unmarshal(String v) throws Exception {
     if (v.startsWith(CDATA_BEGIN) && v.endsWith(CDATA_END)) {
       v = v.substring(CDATA_BEGIN.length(), v.length() - CDATA_END.length());
     }
     return v;
    }

    @Override
    public String marshal(String v) throws Exception {
        return CDATA_BEGIN + v + CDATA_END;
    }

}

C.1 eclipselink不需要使用借助XmlJavaTypeAdapter注解,把Section属性content上的注解换成@XmlCDATA,如下:

    /**
     * 内容
     */
    @org.eclipse.persistence.oxm.annotations.XmlCDATA
    private String content;

C.2 Entry.toXML方法如下:

    public static <T> void toXML(T obj,Class[] classes,Map<String, Map<String, StreamSource>> properties,File output) throws JAXBException, IOException{    
        JAXBContext context;

        try (BufferedWriter writer=new BufferedWriter(new OutputStreamWriter(new FileOutputStream(output),"UTF-8"))){

            context = org.eclipse.persistence.jaxb.JAXBContextFactory.createContext(classes, properties);
            Marshaller m = context.createMarshaller();
            m.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true);
            m.marshal(obj, writer);
        }
    }

注意:
1) 代码中使用了jdk7的TWR特性, 如果jdk小于7换成try..catch..finally
2) TWR中的包装流是为了防止中文乱码,如果你的cdata中全是英文可以不用包装流，直接以下

BufferedWriter writer = new BufferedWriter(new FileWriter(output))

3) 最重要是JAXBContext 要使用org.eclipse.persistence.jaxb.JAXBContextFactory来构造

C.3 saveSection方法如下:

    public static void saveSection(Section section, File directory) throws JAXBException, IOException {
        File f=new File(directory,File.separator+section.getIndexName()+".xml");
        if(!f.exists()){
            f.createNewFile();
        }
        Map<String, StreamSource> oxm = new HashMap<>(1);
        oxm.put("com.t3news.doc.entity", new StreamSource("oxm.xml"));

        Map<String, Map<String, StreamSource>> properties = new HashMap<>();
        properties.put("eclipselink-oxm-xml", oxm);
        toXML(section,new Class[]{Section.class},properties,f);
    }

注意:
1) 如果JAXBContext 还使用

JAXBContext.newInstance(cls)

来构造会提示:eclipselink-oxm-xml属性不支持

2) oxm.xml定义eclipselink的Object xml mapping Metadata,代码

<?xml version="1.0" encoding="UTF-8"?>
<xml-bindings xmlns="http://www.eclipse.org/eclipselink/xsds/persistence/oxm">
   <java-types>
      <java-type name="com.t3news.doc.entity.Section">
         <java-attributes>
            <xml-element java-attribute="content" cdata="true"/>
         </java-attributes>
      </java-type>
   </java-types>
</xml-bindings>

oxm文件的更详细的参考地址:Bootstrapping from EclipseLink Metadata (OXM)

3) oxm文件的位置,如果放的不对会提示找不到文件

这里写图片描述

解决方案:
1.根据oxm的位置改变StreamSource的构造参数

2.不改代码,把oxm放到classpath下,我用的是netbean8.1,以上代码oxm需要放在这
这里写图片描述

以下是Netbean中看到的截图
这里写图片描述

运行环境:
JDK8 + NetBeans 8.1

街头小贩
关注
  • 2
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
JAXB的CDATA节点处理
chuoyutian7862的博客
04-09 750
JAXB的CDATA节点，参考了很多网上的博文，主要有： 1、通过@XmlJavaTypeAdapter，主要由于转义被省略了，放弃。 http://zhaoyx.iteye.com/blog/1856259 2、借助SunAPI版本编写XMLSerializer，这种蛮好的，但是我的M...
jaxb生成XML例子
07-08
在给定的例子中，我们将深入理解如何使用JAXB注解来生成XML。 1. **@XmlType**: 这个注解用于定义类的属性在XML输出中的顺序。在`WriterXml`类中，propOrder 属性指定了"id", "name", "age", "book"这四个属性的...
JAXB处理XML与对象互转
12-22
一、简介 本文主要讲解JAXB来处理对象与XML进行互转。 其中关于CDATA数据的处理参考： Jaxb如何优雅的处理CData 这篇文章的实现，并略作改动。 二、常用注解（TODO） 三、封装 3.1 pom依赖（TODO） 3.2 CDataAdapter package com.zhenai.sweet.qywx.provider.util; import javax.xml.bind.annotation.adapters.XmlAdapter; /** * JAXB的CDATA转换处理类 */ public class CDataAdapter extends XmlA
JAXB生成带＜![CDATA[]]的xml
Jarvan的博客
08-08 299
只要你下决心去做某件事，总能从中找到乐趣。
JAXB 使用记录 bean转xml xml转bean 数组 继承 CDATA（转义问题）
最新发布
weixin_44326073的博客
10-10 1269
JAXB 使用记录 bean转xml xml转bean 数组 继承 CDATA（转义问题）
JAVA JAXB 解析XML嵌套子节点为字符串
12-01
当我们面临XML文档中存在嵌套子节点，并且希望将其解析为字符串时，JAXB提供了一种有效的方法。 首先，我们需要理解XML文档的基本结构。XML是一种可扩展标记语言，它通过标签来定义元素和数据，允许数据以层次结构...
JAXB 生成XML文件
05-22
7. **示例应用**：在`shop`目录中可能包含了一个示例应用，该应用演示了如何使用JAXB生成XML文件。通常，这个示例可能会定义一些带有JAXB注解的Java类，然后创建`JAXBContext`实例，生成`Marshaller`，最后将Java...
JAXB简介_动力节点Java学院整理
08-29
主要为大家详细介绍了JAXB简介的相关资料，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
jaxb解析生成xml
04-28
3. **自动类型检查**：在序列化和反序列化过程中，JAXB会自动执行类型检查，确保数据一致性。 4. **与XML Schema集成**：可以直接从XML Schema生成Java类，使得代码与数据结构的定义保持一致。 ### JAXB的局限性 ...
xml 对特殊字符的处理(添加cdata标签)
时光的博客
01-13 6038
xml 对特殊字符的处理
Jaxb如何优雅的处理CData
weixin_33757911的博客
06-01 530
  前言   Jaxb确实是xml和java对象映射互转的一大利器. 但是在处理CData内容块的时候, 还是有些小坑. 结合网上搜索的资料, 本文提供了一种解决的思路, 看看能否优雅地解决CData产出的问题. 常规做法   网上最常见的做法是借助XmlAdapter和CharacterEscapeHandler(sun的api)组合来实现.  首先定义CDataAdapter类, 用于对...
XmlSerializer 序列化与反序列化CDATA 以及实现
ShuLiu's Log Book
10-26 6190
XmlSerializer类可以帮助我们将对象的状态序列化对保存，同时通过反序列化，可以还原对象的状态。通过与XML序列化与反序列化相关的特性(Attribute)，可以控制我们的序列化的XML格式；同时通过实现IXmlSerializable接口，可以自定义的实现序列化与反序列化。关于此类，详情查看MSDN XmlSerializer类。不过在一些特殊情况下，CDATA类型的序列化与反序列化
三步解决JAXB生成XML包含CDATA问题—JAVA编程
天蓝蓝
04-27 1631
废话不多说，写此文档的目的就是为了帮助java开发者，解决利用JAXB生成XML时，XML中带有CDATA问题。   分三步走：     首先创建适配器类：CDataAdapter.java   package com.zhaoyx; import javax.xml.bind.annotation.adapters.XmlAdapter; //有时候 Java 类不能自然映...
java 生成xml cdata_如何使用JAXB生成CDATA块？
weixin_29696451的博客
02-25 536
解决方案审查：fred的答案只是一种变通方法，当将Marshaller链接到Schema时，在验证内容时将失败，因为您仅修改字符串文字而不创建CDATA节。因此，如果仅将字符串从foo重写为，则Xerces会将字符串的长度识别为15而不是3。MOXy解决方案是特定于实现的，不能仅与JDK的类一起使用。使用getSerializer的解决方案引用了不推荐使用的XMLSerializer类。解决方案L...
JAXB将JAVA对象转换为XML时CDATA的问题
泊川
02-16 6506
对Java对象转换为xml字符串时，如果有特殊字符如<>必须要是用<![CDATA[]]>来声明。我先尝试了使用XStream解决这个问题也有使用MOXy CDATA注解解决，最后发现，都存在一定的缺陷，甚至不能正常的实现该功能。 最终解决方案有两个，都可以解决这个问题，但是第一个方案由于引用了sun的专有API，在编译时会存在警告，使用了内部的API并不是值得推荐的。但是这里也贴出来，供大家参考。
JAXB和Xerces处理JAVA Bean转XML及包含CDATA内容处理
爱软件-从懂得生活开始。
07-16 800
public static String convertToXmlWithCDATA(Object obj, String[] cdataNodeName, String encoding) throws JAXBException , IOException { JAXBContext context = JAXBContext.newInstance(obj.getClass()); ...
javaBean使用注解方式转成xml中，给元素添加CDATA的方法
qq_25927437的博客
02-14 2234
该注解使用的是jdk自带的rt.jar包下的 1、javaBean注解如下： @XmlAccessorType(XmlAccessType.FIELD) @XmlRootElement(name="process") public class Process extends BaseAttribute{ @XmlAttribute(name="isExecutable") Str...
jaxb生成xml时在父节点生成xmlns:xsi
06-08
在使用JAXB生成XML时，如果需要在父节点生成`xmlns:xsi`属性，可以使用`javax.xml.bind.Marshaller.JAXB_SCHEMA_LOCATION`属性来指定XML Schema的位置和命名空间，并通过`javax.xml.bind.Marshaller.setProperty()`方法将该属性设置为要生成的XML中的`xmlns:xsi`属性的值。同时，需要给父节点添加一个新的属性，属性名为`xmlns:xsi`，属性值为`http://www.w3.org/2001/XMLSchema-instance`。例如： ``` JAXBContext jaxbContext = JAXBContext.newInstance(Root.class); Marshaller marshaller = jaxbContext.createMarshaller(); marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, true); marshaller.setProperty(Marshaller.JAXB_SCHEMA_LOCATION, "http://example.com/ns path/to/schema.xsd"); Root root = new Root(); Document doc = DocumentBuilderFactory.newInstance().newDocumentBuilder().newDocument(); marshaller.marshal(root, doc); doc.getDocumentElement().setAttributeNS("http://www.w3.org/2000/xmlns/", "xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance"); Transformer tf = TransformerFactory.newInstance().newTransformer(); tf.setOutputProperty(OutputKeys.INDENT, "yes"); tf.transform(new DOMSource(doc), new StreamResult(System.out)); ``` 在这个例子中，`Marshaller.JAXB_SCHEMA_LOCATION`属性指定了XML Schema的位置和命名空间。在生成XML时，JAXB会自动将`xsi:schemaLocation`属性添加到生成的XML中，并将其值设置为`http://example.com/ns path/to/schema.xsd`。然后，通过`setAttributeNS()`方法给父节点添加一个新的属性`xmlns:xsi`，属性值为`http://www.w3.org/2001/XMLSchema-instance`。最后，使用`Transformer`将生成的XML格式化输出。例如： ``` <root xmlns="http://example.com/ns" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://example.com/ns path/to/schema.xsd"> ... </root> ```
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值