Xstream介紹
Xstream是一種OXMapping 技術(shù)轿钠,是用來處理XML文件序列化的框架,在將JavaBean序列化举农,或?qū)ML文件反序列化的時候侦啸,不需要其它輔助類和映射文件梅鹦,使得XML序列化不再繁索突颊。Xstream也可以將JavaBean序列化成Json或反序列化鲁豪,使用非常方便。
特點:
簡化的API; 無映射文件; 高性能,低內(nèi)存占用; 整潔的XML; 不需要修改對象;支持內(nèi)部私有字段,不要求對private屬性提供set/get方法;類不需要默認構(gòu)造器
Xstream注解常用知識:
注解 | 作用目標 |
---|---|
@XStreamAlias("message") 別名注解 | 類,字段 |
@XStreamImplicit 忽略集合 | 集合字段 |
@XStreamAsAttribute 將字段轉(zhuǎn)換成節(jié)點屬性 | 字段 |
@XStreamOmitField 忽略屬性 | 字段 |
@XStreamConverter(SingleValueCalendarConverter.class) 注入轉(zhuǎn)換器 | 對象 |
- 重點就是學會它的注解和不通過注解直接用它API來MAPPING
- 其中次點是XML節(jié)點與MODEL屬性名不一樣的處理
Xstream的簡單例子
添加依賴
compile('com.thoughtworks.xstream:xstream:1.4.7')
//xml數(shù)據(jù)
<bus_station>
<aid>268216</aid>
<latitude>34.055596</latitude>
<longitude>-118.113722</longitude>
<name>
<![CDATA[ E Graves Ave - Los Angeles, CA ]]>
</name>
<station_city>16</station_city>
</bus_station>
//JavaBean
//如果不給類起別名律秃,則對應(yīng)的是類包名爬橡,例:com.common.entry.BusStation
@XStreamAlias("bus_station")
public class BusStation implements Serializable {
//屬性別名注解
@XStreamAlias("aid")
private String aid;
//如果和xml的節(jié)點一致就可以不使用別名
private Double latitude;
private Double longitude;
private String name;
@XStreamAlias("station_city")
private String stationCity;
@XStreamOmitField()
private String time;
}
public class Test
{
public static void main(String[] args)
{
BusStation bean=new BusStation();
XStream xstream = new XStream(new DomDriver());
xstream.ignoreUnknownElements();
xstream.processAnnotations(BusStation.class);
//XML序列化
String xml = xstream.toXML(bean);
System.out.println(xml);
//XML反序列化
bean=(Person)xstream.fromXML(xml);
System.out.println(bean);
}
}
xml和bean的映射mapping
1.通過注解映射
//設(shè)置類的別名
@XStreamAlias("person")
//設(shè)置字段的別名
@XStreamAlias("username")
private String name;
//將此字段名在XML中去掉
@XStreamImplicit()
private List<Address> addressList = new ArrayList<Address>();
2.通過api映射
//設(shè)置類的別名
xstream.alias("person",Person.class);
stream.alias("address1", Address.class);
//設(shè)置字段的別名
stream.aliasField("username", Person.class, "name");
//去掉集合類型生成xml的父節(jié)點
stream.addImplicitCollection(Person.class, "addressList");
//將name字段作為Person的屬性
//作用等同注解@XStreamAsAttribute()
stream.useAttributeFor(Person.class, "name");
//將此字段名在XML中去掉,去掉集合類型生成xml的父節(jié)點
xStream.addImplicitCollection(Person.class, "addressList");
//注冊使用了注解的Person類
stream.processAnnotations(new Class[]{People.class, Place.class});
3.默認的命名空間
定義一個默認的XML命名空間使得我們在子元素的開始標記中不需要使用前綴棒动。他的語法如下所示:
<element xmlns="namespace">
下面的XML文檔在table元素中包含了水果的信息:
<table xmlns="http://www.w3.org/TR/html4/">
<tr>
<td>Apples</td>
<td>Bananas</td>
</tr>
</table>
4.XStreamImplicit注解使用
當需要將collection或map類型的成員變量中數(shù)據(jù)轉(zhuǎn)換成xml相同層次的元素時糙申,可以在該成員變量使用該注解。
@XStreamImplicit(itemFieldName = "List_Element")
private List<JP> jps;
轉(zhuǎn)換的xml如下:
<People Age_Alias="10" name="sedric">
<List_Element>
<gender>man</gender>
<reason>人傻錢多</reason>
</List_Element>
<List_Element>
<gender>woman</gender>
<reason>巧言令色</reason>
</List_Element>
</People>
XStreamImplicit注解有兩個屬性:
- itemFieldName是指當前集合數(shù)據(jù)轉(zhuǎn)換為xml元素時的 elementName船惨;
- keyFieldName在集合元素為復(fù)雜對象時柜裸,會使用集合元素的成員變量名作為元素的elementName阵幸,當集合元素為 基本數(shù)據(jù)類型及String類型時沐飘,keyFieldName指定的值將作為元素的elementName立磁。
工具類
//把xml轉(zhuǎn)為object
public static <T> T toBean(String xmlStr, Class<T> cls) {
if (TextUtils.isEmpty(xmlStr) || xmlStr.contains("Error")) {
return null;
}
try {
XStream xstream = new XStream(new DomDriver());
//忽略不需要的節(jié)點
xstream.ignoreUnknownElements();
//對指定的類使用Annotations 進行序列化
xstream.processAnnotations(cls);
T obj = (T) xstream.fromXML(xmlStr);
return obj;
} catch (Exception e) {
e.printStackTrace();
}
return null;
}