欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Java开发笔记(一百零九)XML报文的定义和解析

程序员文章站 2022-07-11 11:18:47
前面介绍了JSON格式的报文解析,虽然json串短小精悍,也能有效表达层次结构,但是每个元素只能找到对应的元素值,不能体现更丰富的样式特征。比如某个元素除了要传输它的字符串文本,还想传输该文本的类型、字体大小、字体颜色等特征,且这些额外的风格样式与业务逻辑无关,自然不适合为它们单独设立参数字段。倘若 ......

前面介绍了json格式的报文解析,虽然json串短小精悍,也能有效表达层次结构,但是每个元素只能找到对应的元素值,不能体现更丰富的样式特征。比如某个元素除了要传输它的字符串文本,还想传输该文本的类型、字体大小、字体颜色等特征,且这些额外的风格样式与业务逻辑无关,自然不适合为它们单独设立参数字段。倘若采用json格式定义包括样式特征在内的文本元素,要么摒弃风格样式这种附加属性,要么将风格样式单列为专门的字段参数,然而不管哪种做法,都未能妥善解决附加属性的表达问题。可见轻量级的json格式依然存在力不从心的情况,为此人们早早发明了拥有强大表示能力的xml格式,xml的全称是“extensible markup language”(可扩展标记语言),它不但支持结构化数据的描述,还支持各类附加属性的定义,非常适合在网络中传输信息。
下面先看一个xml报文格式的购物订单样例:

<?xml version="1.0" encoding="gbk"?>
<order>
	<user_info>
	<name type="string">思无邪</name>
	<address type="string">桃花岛水帘洞123号</address>
	<phone type="string">15960238696</phone>
	</user_info>
	<goods_list>
		<goods_item>
			<goods_name type="string">mate30</goods_name>
			<goods_number type="int">1</goods_number>
			<goods_price type="double">8888</goods_price>
		</goods_item>
		<goods_item>
			<goods_name type="string">格力*空调</goods_name>
			<goods_number type="int">1</goods_number>
			<goods_price type="double">58000</goods_price>
		</goods_item>
		<goods_item>
			<goods_name type="string">红蜻蜓皮鞋</goods_name>
			<goods_number type="int">3</goods_number>
			<goods_price type="double">999</goods_price>
		</goods_item>
	</goods_list>
</order>

 

接着对上面的xml样例庖丁解牛,分析一下xml格式都有哪些特点,分析结果罗列如下:
1、每个元素依然由参数名称和参数值组成,参数名称为尖括号所包裹,且分为标记头与标记尾两部分,标记尾在尖括号内部多了个斜杆。如此一来,一个字段的完整形式为“<参数名称>参数值</参数名称>”。
2、因为每个元素都自带标记头与标记尾,很容易区分在哪开始在哪结束,所以元素之间无需额外的分隔符,只要有标记头与标记尾就足够辨别了。
3、每个结构也需要专门的标记头与标记尾,中间再填入若干元素或者其它结构。
4、对于数组形式的数据,xml报文采用多个同名的结构标记并排列举,表示这里存在同名结构的数组信息,也可看作是清单信息。
5、xml格式允许在报文开头的encoding属性处指定当前报文的字符编码类型,常见的有汉字内码规范gbk,以及世界通用编码规范utf-8。
6、每个结构或者元素节点,也支持在标记头部分填充附加属性,用于指定参数值以外的特定信息。
大致了解了xml报文的格式规范,还得在程序中加以解析才行。传统的xml解析方式有dom和sax两种,dom方式会把整个xml报文读进来,并且所有节点全被自动加载到一个树状结构,以后每个节点值都到该树状结构中读取。sax方式不会事先读入整个xml报文,而是根据节点名称从报文起点开始扫描,一旦找到该节点的标记头位置,即刻往后寻找该节点的标记尾,那么节点标记头尾之间的数据便是节点值了。单就某个节点值的解析过程而言,加载所有节点的dom方式显然较费功夫,从头顺序查找的sax方式执行效率更高。但若要求同时获取多个节点的数值,则采取树状结构遍历的dom方式总体性能更加,而每次都从头找起的sax方式无疑做了重复劳动。总之两种方式的解析效果各有优劣,需要按照实际场景决定取舍。
尽管jdk集成了dom与sax的解析工具,其中dom解析工具封装在包org.w3c.dom中,sax解析工具封装在包javax.xml.parsers中,可是它俩用起来着实费劲,解析过程艰深晦涩,实际开发当中基本不予采用。应用比较多的xml解析工具反而是第三方的dom4j,dom4j的解析方式遵循dom规则,但比起java自带的dom工具要易用得多,其性能也很优异,几乎成为java开发必备的xml解析神器了。通过dom4j解析xml报文的步骤主要有下列五步:
1、创建saxreader阅读器对象;
2、把字符串形式的xml报文转换为输入流对象;
3、命令阅读器对象从输入流中读取document文档对象;
4、获得文档对象的根节点element;
5、从根节点往下依次解析每个层级的节点值;
在具体的节点解析过程之中,会频繁调用element的相关方法,它的常用方法说明如下:
gettext:获得当前节点的字符串值。
element:获得当前节点下面指定名称的子节点对象。
elementtext:获得当前节点下面指定名称的子节点值。
elements:获得当前节点下面指定名称的子节点清单。
attribute:获得当前节点自身指定名称的属性对象。
attributevalue:获得当前节点自身指定名称的属性值。
attributes:获得当前节点拥有的全部属性清单。

仍以前述的xml报文为例,下面是采用dom4j解析该xml串的代码例子:

	// 通过dom4j解析xml串
	private static goodsorder testparserbydom4j(string xml) {
		goodsorder order = new goodsorder(); // 创建一个购物订单对象
		// 创建saxreader阅读器对象
		saxreader reader = new saxreader();
		// 根据字符串构建字节数组输入流
		try (inputstream is = new bytearrayinputstream(xml.getbytes(charset))) {
			// 命令阅读器从输入流中读取文档对象
			document document = reader.read(is);
			// 获得文档对象的根节点
			element root = document.getrootelement();
			// 获取根节点下面名叫user_info的节点
			element user_info = root.element("user_info");
			// 获取user_info节点下面名叫name的节点值
			order.user_info.name = user_info.element("name").gettext();
			// 获取user_info节点下面名叫address的节点值
			order.user_info.address = user_info.element("address").gettext();
			// 获取user_info节点下面名叫phone的节点值
			order.user_info.phone = user_info.element("phone").gettext();
			system.out.println(string.format("用户信息如下:姓名=%s,地址=%s,手机号=%s", 
					order.user_info.name, order.user_info.address, order.user_info.phone));
			// 获取根节点下面名叫goods_list的节点清单
			list<element> goods_list = root.element("goods_list").elements();
			for (int i=0; i<goods_list.size(); i++) { // 遍历商品节点清单
				element goods_item = goods_list.get(i);
				goodsitem item = new goodsitem(); // 创建一项商品对象
				// 获取当前商品项节点下面名叫goods_name的节点值
				item.goods_name = goods_item.element("goods_name").gettext();
				// 获取当前商品项节点下面名叫goods_number的节点值
				item.goods_number = integer.parseint(goods_item.element("goods_number").gettext());
				// 获取当前商品项节点下面名叫goods_price的节点值
				item.goods_price = double.parsedouble(goods_item.element("goods_price").gettext());
				system.out.println(string.format("第%d个商品:名称=%s,数量=%d,价格=%f", 
						i+1, item.goods_name, item.goods_number, item.goods_price));
				order.goods_list.add(item); // 往商品清单中添加指定商品对象
			}
		} catch (exception e) {
			e.printstacktrace();
		}
		return order; // 返回解析后的购物订单对象
	}

 

运行以上的解析代码,观察到以下的购物订单日志,可见成功实现了xml串到对象的解析操作:

用户信息如下:姓名=思无邪,地址=桃花岛水帘洞123号,手机号=15960238696
第1个商品:名称=mate30,数量=1,价格=8888.000000
第2个商品:名称=格力*空调,数量=1,价格=58000.000000
第3个商品:名称=红蜻蜓皮鞋,数量=3,价格=999.000000

除了解析各节点的节点值,dom4j还能解析各节点的属性值,若想正常解析指定名称的属性值,则需明确下列三个要素:该属性的上级节点对象、该属性所在节点的节点名称,该属性的属性名称。有了这三个要素,即可通过以下方法从指定节点的指定属性成功获取属性值:

	// 打印指定节点名称的指定属性值
	private static void printvalueandattr(element parent, string node_name, string attr_name) {
		// 获取父节点下面指定名称的子节点
		element element = parent.element(node_name);
		// 获得子节点的节点值
		string node_value = element.gettext();
		string attr_value = "";
		// 根据属性名称获取子节点的对应属性对象
		attribute attr = element.attribute(attr_name);
		if (attr != null) {
			attr_value = attr.gettext(); // 获取该属性的属性值
		}
		// 打印子节点的详细信息,包括节点名称、节点值、属性名称、属性值
		system.out.println(string.format("节点名称=%s, 节点值=%s, 属性名称=%s, 属性值=%s", 
				node_name, node_value, attr_name, attr_value));
	}

 

接下来在原先的xml解析代码里补充如下的一行属性解析代码:

			// 打印user_info节点的name子节点的type属性值
			printvalueandattr(user_info, "name", "type");

 

再次运行xml解析代码,在输出的购物订单日志中观察到多了下面这行日志,表示解析到了name节点的type属性值:

节点名称=name, 节点值=思无邪, 属性名称=type, 属性值=string

  


更多java技术文章参见《java开发笔记(序)章节目录