Object to XML

摘要：本节主要介绍如何把Object对象转换为XML

引言：最近工作中因为工作需要，需要把两个系统之间的传递的报文修改一下（现在系统之间一般都是通过发送xml字符串传数据吧），最开始用的Jdom来实现的，由于jdom实现需要手写的代码太多，并且遇到了点问题，只有另想办法了，最后准备用Object转xml来实现，虽然这个代码不见得少多少，但是get和set方法都是通过工具自动生成，手写的就少很多了。

准备工作：

下载xstream-1.2.1.jar包，我的是1.2.1的版本，可以直接去百度搜索，下载的链接就不提供了。

XStream类：

XStream是一个Java对象和XML相互转换的工具。提供了所有的基础类型、数组、集合等类型直接转换的支持。

因此XML常用于数据交换、对象序列化（这种序列化和Java对象的序列化技术有着本质的区别）。
XStream中的核心类就是XStream类，XStream对象相当Java对象和XML之间的转换器，转换过程是双向的。

创建XSteam对象的方式很简单，只需要new XStream()即可。 Java到xml，用toXML()方法。 Xml到Java，用fromXML()方法。

在没有任何设置默认情况下，java到xml的映射，是java成员名对应xml的元素名，java类的全名对应xml根元素的名字。

而实际中，往往是xml和java类都有了，要完成相互转换，必须进行别名映射。
别名配置包含三种情况：
1、类别名，用alias(String name, Class type)。
2、类成员别名，用aliasField(String alias, Class definedIn, String fieldName)
3、类成员作为属性别名，用 aliasAttribute(Class definedIn, String attributeName, String alias)，单独命名没有意义，还要通过useAttributeFor(Class definedIn, String fieldName) 应用到某个类上。

需要转换的XML样式为：

（实际开发中，一般都是xml的格式已知，你需要根据XML来建立object，然后拼装为指定格式的XML）

例如：(这个可是我项目中一个实际的报文发送XML格式哦，呵呵)

<?xml version="1.0" encoding="UTF-8"?>
<root>
    <msg_head>
        <time>2012-01-01 11:59:59</time>
        <version>版本号</version><!-- 版本号，不同版本号对应报文结构与处理实现可能不同 -->
        <msg_type>message_request</msg_type><!-- 固定 -->
        <from>CRM</from><!-- 请求来源系统 -->
        <to>SF</to><!-- 请求目标系统 -->
    </msg_head>
    <msg_content>
        <so_co_serial>3212131920110517800</so_co_serial><!-- 被追单订单号 -->
        <so_order_id>3212131920110517801</so_order_id><!-- 受理定单编号，撤单时新产生-->
        <old_so_order_id>3212131920110517800</old_so_order_id><!-- 被撤的受理定单编号 -->
        <order_kind>1</order_kind><!-- 定单大类 -->
        <oper_reason>CRMCANCEL</oper_reason>
        <oper_comment>服务定单撤单</oper_comment>
        <so_staff_id>111</so_staff_id>
        <so_staff_code>x受理人编码</so_staff_code>
        <so_staff_name>x受理人名称</so_staff_name>
        <so_date>2012-01-01 11:59:59</so_date>
    </msg_content>
</root>

示例代码：

简单分析：按照这个xml，我需要建立三个java类，同时设置每个属性的get和set方法，假设三个类分别为：Root.java、MsgHead.java、MsgContent.java

Root.java

import java.util.ArrayList;

public class Root {
    private ArrayList<MsgHead> msg_head;
    private ArrayList<MsgContent> msg_content;

    public ArrayList<MsgHead> getMsg_head() {
        return msg_head;
    }

    public void setMsg_head(ArrayList<MsgHead> msg_head) {
        this.msg_head = msg_head;
    }

    public ArrayList<MsgContent> getMsg_content() {
        return msg_content;
    }

    public void setMsg_content(ArrayList<MsgContent> msg_content) {
        this.msg_content = msg_content;
    }
}

MsgHead.java

public class MsgHead {
    private String time;
    private String version;
    private String msg_type;
    private String from;
    private String to;
    public String getTime() {
        return time;
    }
    public void setTime(String time) {
        this.time = time;
    }
    public String getVersion() {
        return version;
    }
    public void setVersion(String version) {
        this.version = version;
    }
    public String getMsg_type() {
        return msg_type;
    }
    public void setMsg_type(String msg_type) {
        this.msg_type = msg_type;
    }
    public String getFrom() {
        return from;
    }
    public void setFrom(String from) {
        this.from = from;
    }
    public String getTo() {
        return to;
    }
    public void setTo(String to) {
        this.to = to;
    }
}

MsgContent.java

public class MsgContent {
    private String so_co_serial;
    private String so_order_id;
    private String old_so_order_id;
    private String order_kind;
    private String oper_reason;
    private String oper_comment;
    private String so_staff_id;
    private String so_staff_code;
    private String so_staff_name;
    private String so_date;
    public String getSo_co_serial() {
        return so_co_serial;
    }
    public void setSo_co_serial(String so_co_serial) {
        this.so_co_serial = so_co_serial;
    }
    public String getSo_order_id() {
        return so_order_id;
    }
    public void setSo_order_id(String so_order_id) {
        this.so_order_id = so_order_id;
    }
    public String getOld_so_order_id() {
        return old_so_order_id;
    }
    public void setOld_so_order_id(String old_so_order_id) {
        this.old_so_order_id = old_so_order_id;
    }
    public String getOrder_kind() {
        return order_kind;
    }
    public void setOrder_kind(String order_kind) {
        this.order_kind = order_kind;
    }
    public String getOper_reason() {
        return oper_reason;
    }
    public void setOper_reason(String oper_reason) {
        this.oper_reason = oper_reason;
    }
    public String getOper_comment() {
        return oper_comment;
    }
    public void setOper_comment(String oper_comment) {
        this.oper_comment = oper_comment;
    }
    public String getSo_staff_id() {
        return so_staff_id;
    }
    public void setSo_staff_id(String so_staff_id) {
        this.so_staff_id = so_staff_id;
    }
    public String getSo_staff_code() {
        return so_staff_code;
    }
    public void setSo_staff_code(String so_staff_code) {
        this.so_staff_code = so_staff_code;
    }
    public String getSo_staff_name() {
        return so_staff_name;
    }
    public void setSo_staff_name(String so_staff_name) {
        this.so_staff_name = so_staff_name;
    }
    public String getSo_date() {
        return so_date;
    }
    public void setSo_date(String so_date) {
        this.so_date = so_date;
    }
}

Object转XML得测试类，Test.java

package com.asiainfo.b2p.soap.xml.objtoxml;

import java.io.File;
import java.io.FileOutputStream;
import java.io.OutputStreamWriter;
import java.nio.charset.Charset;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.TimeZone;
import com.asiainfo.b2p.soap.xml.common.*;
import com.thoughtworks.xstream.XStream;

public class Test {
    public String getCurrentTime() {
        // 设置时区 默认得到的时间和系统时间相差8个小时，为了解决此问题设置系统默认的时区
        TimeZone tz = TimeZone.getTimeZone("ETC/GMT-8");
        TimeZone.setDefault(tz);
        Date date = new Date();// 获取系统时间
        SimpleDateFormat df = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
        String currentTime = df.format(date);// 格式化日期输出
        return currentTime;
    }

    public void orderCancel() throws Exception {
        Root root = new Root();
        MsgHead msgHead = new MsgHead();
        MsgContent msgContent = new MsgContent();

        msgHead.setTime(getCurrentTime());
        msgHead.setVersion("1.1");
        msgHead.setMsg_type("message_request");
        msgHead.setFrom("CRM");
        msgHead.setTo("SF");

        ArrayList<MsgHead> msg_head = new ArrayList<MsgHead>();
        msg_head.add(msgHead);

        // 给每个元素赋值，实际开发中值肯定要动态的获取，当然这个不是本节的重点
        msgContent.setSo_co_serial("3212131920110517800");
        msgContent.setSo_order_id("3212131920110517801");
        msgContent.setOld_so_order_id("3212131920110517800");
        msgContent.setOrder_kind("1");
        msgContent.setOper_reason("CRMCANCEL");
        msgContent.setOper_comment("服务定单撤单");
        msgContent.setSo_staff_id("111");
        msgContent.setSo_staff_code("x受理人编码");
        msgContent.setSo_staff_name("x受理人名称");
        msgContent.setSo_date(getCurrentTime());

        ArrayList<MsgContent> msg_content = new ArrayList<MsgContent>();
        msg_content.add(msgContent);

        root.setMsg_head(msg_head);
        root.setMsg_content(msg_content);

        XStream xstream = new XStream();// 新建一个转换对象xstream
        // 设置别名 必须设置表明，否则显示的时候为类的全路径
        xstream.alias("root", Root.class);
        xstream.alias("msg_head", MsgHead.class);
        xstream.alias("msg_content", MsgContent.class);

        // 把Object对象按要求转换为指定的XML文件输出
        FileOutputStream fos = new FileOutputStream(new File("D:\\OrderCancel"
                + System.currentTimeMillis() + ".xml"));
        OutputStreamWriter osr = new OutputStreamWriter(fos, Charset
                .forName("GBK"));
        String xmlHead = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>";
        xstream.toXML(root, fos);
    }

    public static void main(String[] args) throws Exception {
        Test test = new Test();
        test.orderCancel();

    }

}

运行截图：

从截图可以看出以上转换有两个问题：

(1).转换为无XML的定义头语句，即：<?xml version="1.0" encoding="UTF-8"?>

(2).msg_head和msg_content标签重复了一次

 

另外，需增加一个功能，把转换的xml以字符串的形式输出，在实际的系统交互中，也是传字符串而非文件。

 

由于时间的关系，今天就不调试了，明天有时间再调，也希望朋友们多提提意见，good luck.....

 

解决前面的两个问题(2011/10/24)

问题1：实际开发中系统之间的交互并非用的是xml文件，而是xml字符串，

故问题1通过把xml转换为字符串，然后在字符串前加xml的定义语句。

代码更改：(从新建XStream 对象开始，后面的都不需要了。代码改为如下：)

XStream xstream=new XStream();

String  xmlhead="<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";

String xml=xstream.toXML(root);

String resultxml=xmlhead+xml;//此句就是最后格式化输出的xml字符串，并且包括xml文件定义头

问题2：msg_head和msg_content标签重复了一次

对于这个问题，只需要把root.java文件中声明为ArrayList的变量改为如下：

 private MsgHead msg_head;
 private MsgContent msg_content;

同时分别设置get和set方法。

对于这种问题，有如下结论：

如果节点有重复的，就用ArrayList类型的变量，如果节点没有重复的，就声明为如上类型的变量。

 

经过今天的工作，发现以上的问题基本解决了，但是输出的xml字符串有换行和缩进，

这样和和实际中的需求稍有不同，考虑如何设置通过XSrteam输出的字符串的格式？

去掉换行和缩进：

//匹配字符串中的空白字符(至少2次)、制表符、回车符、新行（换行）符

  Pattern p = Pattern.compile("\\s{2,}|\t|\r|\n");

  Matcher m = p.matcher(xml);
  finalresult = m.replaceAll("");

 

如果您比较细心的看过，会发现凡是下划线就会显示两个，即占用两个字符，

这个和我的需求是不一样的，解决此种问题两种方法：

方式1：声名XStream对象的时候，用它的构造方法，代码如下：

  XStream xstream = new XStream(new XppDriver(new XmlFriendlyReplacer("-_", "_")));

方法2：用replace("__","_")来解决

finalresult=finalresult.replace("__","_");