JAXB Java转xml或xml转Java工具

来源：互联网发布：rxjava 网络异常处理编辑：程序博客网时间：2024/06/06 09:09

一、简介

1、JAXB概念是什么：（Java Architecture for XML Binding) 是一个业界的标准，是一项可以根据XML Schema产生Java类的技术。是一种xml与object映射绑定技术标准，既然是标准就可以有不同实现.
2、JAXB中有什么：包含“xjc”工具和一个“schemagen”工具。

“xjc”工具可以用来将XML模式或其他类型模式文件（Java 1.6试验性地支持RELAX NG，DTD以及WSDL）转换为Java类。Java类使用javax.xml.bind.annotation包下的Java 标注，例如@XmlRootElement和@XmlElement。XML列表序列表示为java.util.List类型的属性，通过JAXBContext可以创建Marshallers（将Java对象转换成XML）和Unmarshallers（将XML解析为Java对象）。另外的“schemagen”工具，能够执行“xjc”的反向操作，通过一组标注的Java类创建一个XML模式。

二、开发前提

1、jdk 5.0以下（不建议使用）需要导入jar包：activation.jar、jaxb-api.jar、 jaxb-impl.jar、 jsr173-api.jar；如果是基于JDK6以上版本已经集成JAXB2的JAR，在目录{JDK_HOME}/jre/lib/rt.jar中。

三、注解解释

1. Jaxb中处理java和xml之间转换的常用注解有：

1) @XmlType

2) @XmlElement

3) @XmlRootElement

4) @XmlAttribute

5) @XmlAccessorType

6) @XmlAccessorOrder

7) @XmlTransient

8) @XmlJavaTypeAdapter

1. 常用annotation使用说明

1) @XmlType

该注解用在class类上，常与@XmlRootElement，@XmlAccessorType一起使用。它有三个属性：name、propOrder、namespace，经常使用的只有前两个属性。如：

[java] view plain copy
@XmlType(name = "basicStruct", propOrder = {"intValue","stringArray","stringValue"  
)  
Public class myType{…}  

在使用@XmlType的propOrder属性时，必须列出JavaBean对象中的所有属性（也要在所有属性上加上xml注解），否则会报错。

2) @XmlElement

该注解用在java类的属性上，用于将属性映射为xml的子节点。可通过在后面配置name属性值来改变java属性在xml文件中的名称。如：

[java] view plain copy
@XmlElement(name="Address")　　  
private String yourAddress;  

此处配置后，在xml文件中的节点为< Address></ Address>，而不是< yourAddress/>。

3) @XmlRootElement

类级别的注解，对应的是xml文件中的根节点。常与 @XmlType 和 @XmlAccessorType一起使用。如：

[java] view plain copy
@XmlType  
@XmlAccessorType(XmlAccessType.FIELD)  
@XmlRootElement  
public class Address {}  

4) @XmlAttribute

用于把java对象的属性映射为xml的属性,并可通过name属性为生成的xml属性指定别名。如：

[java] view plain copy
@XmlAttribute(name="Country")  
private String state;  

5) @XmlAccessorType

　　@XmlAccessorType用于指定由java对象生成xml文件时对java对象属性的访问方式。常与@XmlRootElement、@XmlType一起使用。它的属性值是XmlAccessType的4个枚举值，分别为：

　　XmlAccessType.FIELD：java对象中的所有成员变量；

　　XmlAccessType.PROPERTY：java对象中所有通过getter/setter方式访问的成员变量；

　　XmlAccessType.PUBLIC_MEMBER：java对象中所有的public访问权限的成员变量和通过getter/setter方式访问的成员变量；

　　XmlAccessType.NONE：java对象的所有属性都不映射为xml的元素。

注意：@XmlAccessorType的默认访问级别是XmlAccessType.PUBLIC_MEMBER。因此，如果java对象中的private成员变量设置了public权限的getter/setter方法，就不要在private变量上使用@XmlElement和@XmlAttribute注解，否则在由java对象生成xml时会报同一个属性在java类里存在两次的错误。同理，如果@XmlAccessorType的访问权限为XmlAccessType.NONE，如果在java的成员变量上使用了@XmlElement或@XmlAttribute注解，这些成员变量依然可以映射到xml文件。

6) @XmlAccessorOrder

用于对java对象生成的xml元素进行排序。它有两个属性值：

　　AccessorOrder.ALPHABETICAL：对生成的xml元素按字母顺序排序；

　XmlAccessOrder.UNDEFINED：不排序。

7) @XmlTransient

用于标示在由java对象映射xml时，忽略此属性。即，在生成的xml文件中不出现此元素。

8) @XmlJavaTypeAdapter

　　@XmlJavaTypeAdapter常用在转换比较复杂的对象时，如map类型或者格式化日期等。使用此注解时，需要自己写一个adapter类继承XmlAdapter抽象类，并实现里面的方法。

　　@XmlJavaTypeAdapter(value=xxx.class),value为自己定义的adapter类

XmlAdapter如下：

[java] view plain copy
public abstract class XmlAdapter<ValueType,BoundType> {  
    // Do-nothing constructor for the derived classes.  
    protected XmlAdapter() {}  
    // Convert a value type to a bound type.  
    public abstract BoundType unmarshal(ValueType v);  
    // Convert a bound type to a value type.  
    public abstract ValueType marshal(BoundType v);  
 }  

四、封装工具类

/**
* xmlTOjava
*
* @description TODO
* @param class1
* @param xml
* @return
* @throws Exception
* @return Object
* @throws
*/
public static Object xmlToJava(Class<?> class1, String xml)
throws Exception {

// xml = xml.replaceAll("<", "<");
// xml = xml.replaceAll(">", ">");
JAXBContext jc = JAXBContext.newInstance(class1);
Unmarshaller unmar = jc.createUnmarshaller();
return unmar.unmarshal(new StringReader(xml));
}

/**
* java对象转成XML
* @param class1
* @param obj
* @return
* @throws Exception
*/
public static String javaToXml(Class<?> class1, Object obj)
throws Exception {
JAXBContext jc = JAXBContext.newInstance(class1);
Marshaller marshaller = jc.createMarshaller();
// 编码格式
marshaller.setProperty(Marshaller.JAXB_ENCODING, "UTF-8");//
// 是否格式化生成的xml串
marshaller.setProperty(Marshaller.JAXB_FORMATTED_OUTPUT, false);//
// 是否省略xml头信息（<?xml version="1.0" encoding="gb2312" standalone="yes"?>）
marshaller.setProperty(Marshaller.JAXB_FRAGMENT, true);//
StringWriter sw = new StringWriter();
String xml = "";
marshaller.marshal(obj, sw);
xml = sw.toString();
return xml;
}

五、构造你想要的xml结构

以上面的xml模板为例，是构造gasiListImpXkCharge这个实体的多个xml的生成，并且根节点设置为root，所以你需要自己构造一个根节点未root并且子节点是gasiListImpXkCharge实体的xml，并且注解对应实体，最后就是在代码中实现。

<?xml version="1.0" encoding="UTF-8"?>
<root>
<gasiListImpXkCharge>
<pkId></pkId>
<adminisrativeDivisionCode></adminisrativeDivisionCode>
<amount></amount>
<chargeBasis></chargeBasis>
<chargeItemName></chargeItemName>
<createName></createName>
<createTime></createTime>
<createUser></createUser>
<itemGuid></itemGuid>
<reductionDesc></reductionDesc>

</gasiListImpXkCharge>
<gasiListImpXkCharge>
<pkId></pkId>
<adminisrativeDivisionCode></adminisrativeDivisionCode>
<amount></amount>
<chargeBasis></chargeBasis>
<chargeItemName></chargeItemName>
<createName></createName>
<createTime></createTime>
<createUser></createUser>
<itemGuid></itemGuid>
<reductionDesc></reductionDesc>

</gasiListImpXkCharge>
</root>

@XmlRootElement(name = "root")
//@XmlType(propOrder = { "GasiListImpXkCharge" })
public class GasiListImpXkRoot implements Serializable{

/**
*
*/
private static final long serialVersionUID = -4670709431859827858L;

private List<GasiListImpXkCharge> GasiListImpXkCharge;

................................

@XmlElement(name = "GasiListImpXkCharge")
public List<GasiListImpXkCharge> getGasiListImpXkCharge() {
return GasiListImpXkCharge;
}

public void setGasiListImpXkCharge(List<GasiListImpXkCharge> gasiListImpXkCharge) {
GasiListImpXkCharge = gasiListImpXkCharge;
}

package com.gsww.jup.entity.right.lic;

import java.io.Serializable;
import java.util.Date;
import java.util.List;

import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.NamedQuery;
import javax.persistence.Table;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlType;

import org.hibernate.annotations.GenericGenerator;

/**
* The persistent class for the GASI_LIST_IMP_XK_CHARGE database table.
*
*/
@Entity
@Table(name="GASI_LIST_IMP_XK_CHARGE")
@NamedQuery(name="GasiListImpXkCharge.findAll", query="SELECT g FROM GasiListImpXkCharge g")
@XmlRootElement
//@XmlType(propOrder = { "GasiListImpXkCharge" })
public class GasiListImpXkCharge implements Serializable {
private static final long serialVersionUID = 1L;
private String pkId; //序号
private String amount; //金额
private String chargeBasis; //收费标准
private String chargeItemName; //收费项目名称
private String createName; //创建人姓名
private String createTime; //创建时间
private String createUser; //创建人
private String itemGuid; //权力唯一标识
private String reductionDesc; //减免说明
private String state; //状态
private String updateName; //更新人姓名
private String updateTime; //更新时间
private String updateUser; //更新人
private Integer version; //版本号
private String adminisrativeDivisionCode; //行政区划编码
private String syncSign;//同步标识：0表示未同步，1表示已同步
private Date syncDate;//同步时间
private String operSync;//操作标识：1=insert，2=update，3=delete

public GasiListImpXkCharge() {
super();
}

public GasiListImpXkCharge(String pkId, String amount, String chargeBasis,
String chargeItemName, String createName, String createTime, String createUser, String itemGuid,
String reductionDesc, String state, String updateName, String updateTime, String updateUser,
Integer version,String adminisrativeDivisionCode) {
super();
this.pkId = pkId;
this.amount = amount;
this.chargeBasis = chargeBasis;
this.chargeItemName = chargeItemName;
this.createName = createName;
this.createTime = createTime;
this.createUser = createUser;
this.itemGuid = itemGuid;
this.reductionDesc = reductionDesc;
this.state = state;
this.updateName = updateName;
this.updateTime = updateTime;
this.updateUser = updateUser;
this.version = version;
this.adminisrativeDivisionCode = adminisrativeDivisionCode;
}

@Id
@GeneratedValue(generator = "system-uuid")
@GenericGenerator(name = "system-uuid", strategy = "uuid.hex")
@Column(name = "PK_ID")
public String getPkId() {
return this.pkId;
}

public void setPkId(String pkId) {
this.pkId = pkId;
}

@Column(length=50)
public String getAmount() {
return this.amount;
}

public void setAmount(String amount) {
this.amount = amount;
}

@Column(name="CHARGE_BASIS", length=2000)
public String getChargeBasis() {
return this.chargeBasis;
}

public void setChargeBasis(String chargeBasis) {
this.chargeBasis = chargeBasis;
}

@Column(name="CHARGE_ITEM_NAME", length=50)
public String getChargeItemName() {
return this.chargeItemName;
}

public void setChargeItemName(String chargeItemName) {
this.chargeItemName = chargeItemName;
}

@Column(name="CREATE_NAME", nullable=false, length=50)
public String getCreateName() {
return this.createName;
}

public void setCreateName(String createName) {
this.createName = createName;
}

@Column(name="CREATE_TIME", nullable=false, length=19)
public String getCreateTime() {
return this.createTime;
}

public void setCreateTime(String createTime) {
this.createTime = createTime;
}

@Column(name="CREATE_USER", nullable=false, length=32)
public String getCreateUser() {
return this.createUser;
}

public void setCreateUser(String createUser) {
this.createUser = createUser;
}

@Column(name="ITEM_GUID", length=50)
public String getItemGuid() {
return this.itemGuid;
}

public void setItemGuid(String itemGuid) {
this.itemGuid = itemGuid;
}

@Column(name="REDUCTION_DESC", length=2000)
public String getReductionDesc() {
return this.reductionDesc;
}

public void setReductionDesc(String reductionDesc) {
this.reductionDesc = reductionDesc;
}

@Column(name="STATE", nullable=false, length=1)
public String getState() {
return this.state;
}

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

@Column(name="UPDATE_NAME", length=50)
public String getUpdateName() {
return this.updateName;
}

public void setUpdateName(String updateName) {
this.updateName = updateName;
}

@Column(name="UPDATE_TIME", length=19)
public String getUpdateTime() {
return this.updateTime;
}

public void setUpdateTime(String updateTime) {
this.updateTime = updateTime;
}

@Column(name="UPDATE_USER", length=32)
public String getUpdateUser() {
return this.updateUser;
}

public void setUpdateUser(String updateUser) {
this.updateUser = updateUser;
}

@Column(name="VERSION", precision=3)
public Integer getVersion() {
return this.version;
}

public void setVersion(Integer version) {
this.version = version;
}
@Column(name="ADMINISRATIVE_DIVISION_CODE", length=20)
public String getAdminisrativeDivisionCode() {
return adminisrativeDivisionCode;
}

public void setAdminisrativeDivisionCode(String adminisrativeDivisionCode) {
this.adminisrativeDivisionCode = adminisrativeDivisionCode;
}
@Column(name = "SYNC_SIGN")
public String getSyncSign() {
return syncSign;
}

public void setSyncSign(String syncSign) {
this.syncSign = syncSign;
}
@Column(name = "SYNC_DATE")
public Date getSyncDate() {
return syncDate;
}

public void setSyncDate(Date syncDate) {
this.syncDate = syncDate;
}
@Column(name = "OPER_SYGN")
public String getOperSync() {
return operSync;
}

public void setOperSync(String operSync) {
this.operSync = operSync;
}
}

关键看红色标记部分

祝君成功！！！！可以留言讨论

阅读全文

1 0