使用XStream注解实现Java对象与XML互相转换的代码示例

本文记录一下使用xstream这个api的注解特性对Java对象与XML字符串相互转换的一些代码示例。
    我们很多人都处理过XML文件，也有很多非常成熟的第三方开源软件。如：jdom、dom4j等。虽然他们的功能非常强大，但在使用上还是有点不那么习惯。对于格式比较固定的XML文档，它的结构没有变化或是很少变化，这时将它转换成我们熟悉的Java对象来操作的话，会使工作变得更容易一些，而xstream正好可以满足这一点。
    本文所用xstream的版本为：1.4.7

   <dependency>
       <groupId>com.thoughtworks.xstream</groupId>
       <artifactId>xstream</artifactId>
       <version>1.4.7</version>
   </dependency>

还是以之前的book XML为例，先上代码。

import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamAsAttribute;

@XStreamAlias("book")
public class Book {

// 别名注解，这个别名就是XML文档中的元素名，Java的属性名不一定要与别名一致
    @XStreamAlias("name")
    private String name;
    
    @XStreamAlias("author")
    private String author;
    
    // 属性注解，此price就是book的属性，在XML中显示为：<book price="108">
    @XStreamAsAttribute()
    @XStreamAlias("price")
    private String price;

省略get和set方法
}

import java.util.List;

import com.thoughtworks.xstream.annotations.XStreamAlias;
import com.thoughtworks.xstream.annotations.XStreamImplicit;

@XStreamAlias("books")
public class Books {

// 隐式集合，加上这个注解可以去掉book集合最外面的<list></list>这样的标记
    @XStreamImplicit
    private List<Book> list;

省略get和set方法
}

import java.util.List;

import com.thoughtworks.xstream.XStream;
import com.thoughtworks.xstream.io.xml.DomDriver;

public class XStreamHandle {

private static final String xmlString = "<books><book price=\"108\"><name>Java编程思想</name><author>Bruce Eckel</author></book><book price=\"52\"><name>Effective Java</name><author>Joshua Bloch</author></book><book price=\"118\"><name>Java 7入门经典</name><author>Ivor Horton</author></book></books>";

public static String toXml(Object obj) {
        XStream xstream = new XStream(new DomDriver("utf8"));
        xstream.processAnnotations(obj.getClass()); // 识别obj类中的注解
        /*
         // 以压缩的方式输出XML
         StringWriter sw = new StringWriter();
         xstream.marshal(obj, new CompactWriter(sw));
         return sw.toString();
         */
        // 以格式化的方式输出XML
        return xstream.toXML(obj);
    }
    
    public static <T> T toBean(String xmlStr, Class<T> cls) {
        XStream xstream = new XStream(new DomDriver());
        xstream.processAnnotations(cls);
        @SuppressWarnings("unchecked")
        T t = (T) xstream.fromXML(xmlStr);
        return t;
    }
    
    public static void main(String[] args) {
        Books books = toBean(xmlString, Books.class);
        List<Book> list = books.getList();
        for(Book book : list) {
            System.out.println("name=" + book.getName() + "\tauthor=" + book.getAuthor()
                    + "\tprice=" + book.getPrice());
        }
        System.out.println(toXml(books));
    }
}

除了上面示例中用的注解，xstream还有下面几种注解也经常用到。
    @XstreamOmitField 忽略字段
    这相当于设置某些字段为临时属性，在转换中不再起作用。
    @XStreamConverter(XXX.class)  转换器
    XXX.class是一个实现了com.thoughtworks.xstream.converters.Converter接口的转换器，对某些类型的值进行转换，比如布尔值类型的true或false，如果不加转换器，默认生成的值就是true或false。xstream自带了BooleanConverter转换器，可以将默认值转换成需要的文本值，如果xstream没有需要的转换器就得自己实现Converter接口来自定义转换器。
    根据大象的经验，为了少给自己找麻烦，比如避免使用转换器，最好将与XML元素或属性对应的Java对象属性都设置成String类型，当然列表还是要定义成List类型的。只要不是特别奇葩，一般情况下，示例部分就能满足绝大部分的需求。
    本文为菠萝大象原创，如要转载请注明出处。http://www.blogjava.net/bolo