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