1. 程式人生 > >JAXB解析xml 的註解說明

JAXB解析xml 的註解說明

uri null qname files body load dex getc nbsp

1.將 xml 文件中的各個節點和屬性信息創建對應的Java模型

2.在Java模型中的創建與 xml 文件對應的節點和屬性需要用註解來表示
@XmlRootElement 將一個Java類映射為一段XML的根節點
參數:
name 定義這個根節點的名稱
namespace 定義這個根節點命名空間

@XmlAccessorType 定義映射這個類中的何種類型需要映射到XML。可接收四個參數,分別是:
XmlAccessType.PROPERTY:映射這個類中的屬性(get/set方法)到XML
XmlAccessType.PUBLIC_MEMBER:將這個類中的所有public的field或property同時映射到XML(默認)
XmlAccessType.NONE:不映射

@XmlElement 指定一個字段或get/set方法映射到XML的節點。如,當一個類的XmlAccessorType 被標註為PROPERTY時,在某一個沒有get/set方法的字段上標註此註解,即可將該字段映射到XML。
參數:
defaultValue 指定節點默認值
name 指定節點名稱
namespace 指定節點命名空間
required 是否必須(默認為false)
nillable 該字段是否包含 nillable="true" 屬性(默認為false)
type 定義該字段或屬性的關聯類型

@XmlAttribute 指定一個字段或get/set方法映射到XML的屬性。
參數:
name 指定屬性名稱
namespace 指定屬性命名空間
required 是否必須(默認為false)

@XmlTransient 定義某一字段或屬性不需要被映射為XML。
如,當一個類的XmlAccessorType 被標註為PROPERTY時,在某一get/set方法的字段上標註此註解,那麽該屬性則不會被映射。

@XmlType 定義映射的一些相關規則
參數:
propOrder 指定映射XML時的節點順序
factoryClass 指定UnMarshal時生成映射類實例所需的工廠類,默認為這個類本身
factoryMethod 指定工廠類的工廠方法
name 定義XML Schema中type的名稱
namespace 指定Schema中的命名空間

@XmlElementWrapper 為數組元素或集合元素定義一個父節點。
如,類中有一元素為List items,若不加此註解,該元素將被映射為
<items>...</items>
<items>...</items>
這種形式,此註解可將這個元素進行包裝,如:
@XmlElementWrapper(name="items")
@XmlElement(name="item")
public List items;
將會生成這樣的XML樣式:
<items>
<item>...</item>
<item>...</item>
</items>

@XmlJavaTypeAdapter 自定義某一字段或屬性映射到XML的適配器。
如,類中包含一個接口,我們可以定義一個適配器(繼承自 javax.xml.bind.annotation.adapters.XmlAdapter類),指定這個接口如何映射到XML。

@XmlSchema 配置整個包的namespace,這個註解需放在package-info.java文件中
<items>...</items>
這種形式,此註解可將這個元素進行包裝,如:
@XmlElementWrapper(name="items")
@XmlElement(name="item")
public List items;
將會生成這樣的XML樣式:
<items>
<item>...</item>
<item>...</item>
</items>

@XmlJavaTypeAdapter 自定義某一字段或屬性映射到XML的適配器。
如,類中包含一個接口,我們可以定義一個適配器(繼承自 javax.xml.bind.annotation.adapters.XmlAdapter類),指定這個接口如何映射到XML。

@XmlSchema 配置整個包的namespace,這個註解需放在package-info.java文件中
<item>...</item>
</items>

@XmlJavaTypeAdapter 自定義某一字段或屬性映射到XML的適配器。
如,類中包含一個接口,我們可以定義一個適配器(繼承自 javax.xml.bind.annotation.adapters.XmlAdapter類),指定這個接口如何映射到XML。

@XmlSchema 配置整個包的namespace,這個註解需放在package-info.java文件中

3.示例代碼
//Java Entity
@XmlAccessorType(XmlAccessType.FIELD)
@XmlRootElement(name = "automation")
public class JavaBean
{
@XmlAttribute(name = "service")
private String serviceName;

@XmlElementWrapper(name = "rules")
@XmlElement(name = "rule")
private List<Rule> rules;

@XmlElementWrapper(name = "actions")
@XmlElement(name = "action")
private List<Action> actions;

public List<Rule> getRules()
{
return rules;
}

public String getServiceName()
{
return serviceName;
}

public void setServiceName(String serviceName)
{
this.serviceName = serviceName;
}

public void setRules(List<Rule> rules)
{
this.rules = rules;
}

public List<Action> getActions()
{
return actions;
}

public void setActions(List<Action> actions)
{
this.actions = actions;
}
}
//ObjectFactory
@XmlRegistry
public class ObjectFactory
{
private final static QName _Configurations_SCALERULE_QNAME = new QName(
"http://www.huawei.com/cloudCube/cloudview", "entities");

public ObjectFactory()
{
}

public Action createAction()
{
return new Action();
}

public ActionProperty createActionProperty()
{
return new ActionProperty();
}

public JavaBean createJavaBean()
{
return new JavaBean();
}

public Dimension createDimension()
{
return new Dimension();
}

public Rule createRule()
{
return new Rule();
}

}
//解析
public static Object unmarshal(InputStream input, String classPath,
String schemaResPath, ClassLoader classLoader)
throws JAXBException, SAXException
{
JAXBContext jaxbContext = JAXBContext.newInstance(classPath,
classLoader);

SchemaFactory schemaFactory = SchemaFactory.newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);

Unmarshaller unmarshaller = jaxbContext.createUnmarshaller();

if (schemaResPath != null && !schemaResPath.isEmpty())
{
URL schemaURL = classLoader.getResource(schemaResPath);
Schema schema = schemaFactory.newSchema(schemaURL);
unmarshaller.setSchema(schema);
}
Object obj = unmarshaller.unmarshal(input);
return obj;
}
//轉換
public static Object convertor(String fi) throws Exception
{
ClassLoader classLoader = ObjectFactory.class.getClassLoader();
String contextPath = ObjectFactory.class.getPackage().getName();
File file = new File(fi);
if (!file.isDirectory())
{
InputStream input = new FileInputStream(file);
JavaBean bean = (JavaBean) XMLMarshallUtil.unmarshal(input,
contextPath,
null,
classLoader);
return bean;
}
else
{
File[] fs = file.listFiles();
List<Object> list = new ArrayList<Object>();
for (int i = 0; i < fs.length; i++)
{
InputStream input = new FileInputStream(fs[i]);
JavaBean bean = (JavaBean) XMLMarshallUtil.unmarshal(input,
contextPath,
null,
classLoader);
list.add(bean);
}
return list;
}
}
//main函數
public static void main(String[] args) throws Exception
{
Object obj = Test.convertor("bin/conf/");
if (obj instanceof JavaBean)
{
JavaBean bean = (JavaBean) obj;
System.out.println(bean.getServiceName());
}
if (obj instanceof List<?>)
{
List<JavaBean> list = (List<JavaBean>) obj;
for (JavaBean bean : list)
{
System.out.println(bean.getActions().get(1).getActionName());
}
}
}

4.解析過程中出現異常
1)解析文件中JAXBContext.newInstance(Service.class)創建新的實例錯誤,正確的是 (ServiceMetric.class)
javax.xml.bind.UnmarshalException
- with linked exception:
[java.io.IOException: Stream closed]
2)使用 StreamSource 類出現的異常

StreamSource streamSource = new StreamSource(read);
root = (Service) um.unmarshal(streamSource);
javax.xml.bind.UnmarshalException
- with linked exception:
[org.xml.sax.SAXParseException: Premature end of file.]
3)解析過程中返回的對象中有引用類型的屬性,需要將裏面所有的引用類型屬性,全都實例化(ObjectFactory作用)。

Exception in thread "main" javax.xml.bind.JAXBException: "bean.javaBean" doesnt contain ObjectFactory.class or jaxb.index

JAXB解析xml 的註解說明