XStream 注解

– Start
点击此处观看本系列配套视频。

---

package shangbo.xstream.example5;

import java.util.ArrayList;
import java.util.List;

import com.thoughtworks.xstream.XStream;

public class App {
	public static void main(String[] args) {
		// 实例化 XStream 对象
		XStream xstream = new XStream();
		xstream.autodetectAnnotations(true); // 注意，需要设置为 true
		
		// 所有以下设置通过注解定义在类中
//		xstream.alias("person", Person.class); // 自定义标签
//		xstream.alias("phone", PhoneNumber.class); // 自定义标签
//		xstream.aliasField("countrycode", PhoneNumber.class, "code"); // 自定义标签
//		xstream.addImplicitCollection(Person.class, "phones"); // 去掉集合标签
//		xstream.useAttributeFor(Person.class, "firstname"); // 生成属性，而非子标签
//		xstream.useAttributeFor(Person.class, "lastname"); // 生成属性，而非子标签

		// 将对象转成 xml
		String xml = xstream.toXML(newPerson());
		System.out.println(xml);

		// 将 xml 转成对象
		Person shangbo = (Person) xstream.fromXML(xml);
		System.out.println(shangbo);
	}

	private static Person newPerson() {
		List<PhoneNumber> phones = new ArrayList<>();

		PhoneNumber phone = new PhoneNumber();
		phone.setCode("86");
		phone.setNumber("0411-12345678");
		phones.add(phone);

		PhoneNumber cell = new PhoneNumber();
		cell.setCode("86");
		cell.setNumber("18912345678");
		phones.add(cell);

		Address address = new Address();
		address.setState("LiaoNing");
		address.setCity("DaLian");
		address.setStreat("GaoXingQu");

		Person shangbo = new Person();
		shangbo.setFirstname("Bo");
		shangbo.setLastname("Shang");
		shangbo.setAddress(address);
		shangbo.setPhones(phones);

		return shangbo;
	}
}

结果如下。

<person firstname="Bo" lastname="Shang">
  <address>
    <city>DaLian</city>
    <streat>GaoXingQu</streat>
  </address>
  <phone>
    <countrycode>86</countrycode>
    <number>0411-12345678</number>
  </phone>
  <phone>
    <countrycode>86</countrycode>
    <number>18912345678</number>
  </phone>
</person>
Security framework of XStream not initialized, XStream is probably vulnerable.
shangbo.xstream.example5.Person@646007f4[firstname=Bo,lastname=Shang,address=shangbo.xstream.example5.Address@545997b1[state=<null>,city=DaLian,streat=GaoXingQu],phones=[shangbo.xstream.example5.PhoneNumber@4cf4d528[code=86,number=0411-12345678], shangbo.xstream.example5.PhoneNumber@77846d2c[code=86,number=18912345678]]]

package shangbo.xstream.example5;

import java.util.List;

import org.apache.commons.lang3.builder.ToStringBuilder;

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

@XStreamAlias("person") // 自定义标签
public class Person {
	@XStreamAsAttribute // 生成属性，而非子标签
	private String firstname;
	@XStreamAsAttribute // 生成属性，而非子标签
	private String lastname;
	private Address address;
	
	@XStreamImplicit(itemFieldName="phone") // 去掉集合标签
	private List<PhoneNumber> phones;

	public String toString() {
		return ToStringBuilder.reflectionToString(this);
	}

	public String getFirstname() {
		return firstname;
	}

	public void setFirstname(String firstname) {
		this.firstname = firstname;
	}

	public String getLastname() {
		return lastname;
	}

	public void setLastname(String lastname) {
		this.lastname = lastname;
	}

	public Address getAddress() {
		return address;
	}

	public void setAddress(Address address) {
		this.address = address;
	}

	public List<PhoneNumber> getPhones() {
		return phones;
	}

	public void setPhones(List<PhoneNumber> phones) {
		this.phones = phones;
	}

}

package shangbo.xstream.example5;

import org.apache.commons.lang3.builder.ToStringBuilder;

import com.thoughtworks.xstream.annotations.XStreamOmitField;

public class Address {
	@XStreamOmitField // 忽略该字段
	private String state;
	private String city;
	private String streat;

	public String toString() {
		return ToStringBuilder.reflectionToString(this);
	}

	public String getState() {
		return state;
	}

	public void setState(String state) {
		this.state = state;
	}

	public String getCity() {
		return city;
	}

	public void setCity(String city) {
		this.city = city;
	}

	public String getStreat() {
		return streat;
	}

	public void setStreat(String streat) {
		this.streat = streat;
	}

}

package shangbo.xstream.example5;

import org.apache.commons.lang3.builder.ToStringBuilder;

import com.thoughtworks.xstream.annotations.XStreamAlias;

public class PhoneNumber {
	@XStreamAlias("countrycode") // 自定义标签
	private String code;
	private String number;

	public String toString() {
		return ToStringBuilder.reflectionToString(this);
	}

	public String getCode() {
		return code;
	}

	public void setCode(String code) {
		this.code = code;
	}

	public String getNumber() {
		return number;
	}

	public void setNumber(String number) {
		this.number = number;
	}

}

– 更多参见：XStream 精萃
– 声 明：转载请注明出处
– Last Updated on 2018-05-27
– Written by ShangBo on 2018-05-27
– End