从文本到字节码
本数据绑定系列的第三部分演示了如何使用“JSR-031:数据绑定,Sun 数据绑定规范申请”中指定的方法,将 XML 元素和属性转换成 Java 对象。这部分主要讲述从数据的XML 表示移到应用程序代码易于使用的 Java 实例。第三部分论及通过将 XML 文档中的嵌套元素取消编组成 Java 对象、测试和用某些实际示例来使用新的工具。
本系列的目标是演示如何将 XML 元素转换成 Java 对象,然后可以使用 Java 语言 accessor 和 mutator 方法直接处理 XML 数据。第一部分比较了数据绑定和 Java 应用程序中其它处理 XML 数据的方法,分析了设计决策,还定义了示例 Web 服务配置文档的 XML 模式。第二部分说明了如何从 XML 模式生成接口和实现,以便符合 XML 模式的 XML 文档可以转换成这些生成类的实例。
在第三部分(共四部分)中,将完成基础知识的讲解,并且描述了如何精心设计代码以执行取消编组,取消编组将完成将 XML 转换成 Java 对象的过程。执行了取消编组后,可以使用测试类(已包括在内)来检查是否所有部分都已正确组合在一起。本系列的每一部分都建立在其它部分的基础之上,所以如果您还没有看过第一和第二部分,您也许会看不懂本文中的一些描述。如果要回顾专门的词汇表,请参阅术语解释侧栏。
使用第一部分中为 WebServiceConfiguration 定义的 XML 模式(请参阅更新版本)和第二部分中的接口,即将创建为配置数据的特定实例提供数据的 XML 文档。任何符合模式的 XML 文档都可以编组成 Java 对象。这些对象应该是使用 SchemaMapper 类生成的类的实例。当然,最终结果就是数据绑定。
制作 XML 实例文档
创建符合模式的 XML 文档 -- 通常叫做 XML 实例 -- 很简单。文档必须只提供与模式中定义的约束相匹配的数据值,如清单 1 所示。
清单 1. 符合示例 XML 模式的 XML 实例文档
<?xml version="1.0"?>
<webServiceConfiguration xmlns="http://www.enhydra.org"
xmlns:xsi="http://www.w3.org/1999/XMLSchema/instance"
xsi:schemaLocation="http://www.enhydra.org
configuration.xsd"
version="1.1"
name="Unsecured Web Listener" >
<port number="80" protocol="http" protectedPort="false" />
<document root="/usr/local/enhydra/html" index="*.html,*.xml"
error="error.html" />
</webServiceConfiguration>
清单 1 中的示例完整地显示了 WebServiceConfiguration 的实例。实例文档包括了两个名称空间声明。第一个是缺省名称空间声明,请参考 http://www.enhydra.org。这表示所有没有前缀的元素会分配到此名称空间。虽然,在本示例中不需要声明缺省名称空间,它还给予了文档一些身份。这个缺省名称空间有助于将该文档与其它有相似或等同元素名称的 XML 文档区分出来。
定义的另一个名称空间分配给 xsi 前缀,所以带该前缀的所有元素都分配到此名称空间。它 (http://www.w3.org/1999/XMLSchema/instance) 引用“XML 模式实例规范”的 URI。该规范依次定义了 XML 文档如何引用文档符合的 XML 模式。最后,schemaLocation 属性引用 XML 模式。该属性的第一个变量是受到约束的名称空间(示例缺省名称空间,它包括文档中的每个元素)。第二个变量,用空格与第一个变量分开,引用 XML 模式的实际位置。本例中,模式 configuration.xsd 是一个本地文件,它与文档在同一个目录中。也可以通过使用 URL 来引用网络上任意位置的模式。
在缺省名称空间中,附加属性(因为它们没有前缀)定义了版本 (1.1) 和名称 (Unsecured Web Listener)。
接着,声明了模式中的 Port 对象,并定义了它的数据:端口号为 80,协议是 http。正确取消编组成 Java 代码后,该文档就变成了 WebServiceConfigurationImpl 类的实例。然后,Java 代码可以使用本系列第二部分中设计的接口 WebServiceConfiguration,以使用基本 XML 文档中的数据。(请注意,可能会在应用程序中执行验证,如模式验证侧栏中所概述的。)
模式验证
较新的 XML 语法分析器,如 Apache Xerces 语法分析器的当前发行版,允许对 XML 实例文档执行模式验证。验证允许在程序格式上确保 XML 文档符合它引用的 XML 模式。请与语法分析器供应商联系或参考文档,以确定语法分析器是否支持模式验证,其验证范围,以及如何打开验证。
打开前门
正式开始之前,需要提供入口点以取消编组 XML 文档,该文档作为返回 Java 对象的方法的输入。(由于您会忆起,本例中取消编组的结果只是 Java 对象。)然后,该对象可以转换成适当的接口,其实,您已经生成了该接口(在本系列第二部分中)。
对于示例 SchemaMapper 类,允许传入 URL 是最有意义的。由于可以使用网络资源作为输入,而不是只允许文件名,这就提供了更多选择。知道了这一点后,下一步就从 URL 创建 JDOM 文档对象 (org.jdom.Document),然后处理文档。请查看清单 2 中执行该操作的代码。
清单 2. 将字符串映射成 Java 指定的类型 /**
*
* This method is the public entry point for unmarshalling an object from
* an XML instance document.
*
*
* @param instanceURL URL for the instance document.
* @return Object - the created Java Object, or
* null if problems occur in a way that does not
* generate an Exception.
* @throws IOException when errors in binding occur.
*/
public static Object unmarshall(URL instanceURL) throws IOException {
// Read in the document
SAXBuilder builder = new SAXBuilder();
try {
Document doc = builder.build(instanceURL);
Element rootElement = doc.getRootElement();
Unmarshaller unmarshaller = new Unmarshaller();
return unmarshaller.getJavaRepresentation(rootElement);
} catch (JDOMException e) {
throw new IOException (e.getMessage());
}
}
清单 2 中的方法是静态的,允许直接调用它而无需实例化类的实例。由于对 unmarshall 方法的多个调用之间没有需要共享的数据,因此该方法可以是静态的。一旦处理了 XML,就将文档的根元素(以 JDOM 表示)就被传到执行从 XML 到 Java 对象转换的内部方法。
转换数据
我不打算逐行解释取消编组中使用的完整代码。可以查看类的完整源码清单,它基本上是不需加以说明的。但是,在入口点示例中,有一些值得强调的事情。如果创建了适当类的新实例,将使用 XML 文档提供的值调用 mutator 方法(全都名为 setXXX)。当然,这将使 XML 数据在实例的 Java 方法中随处都可用。清单 3 显示了处理这种查找方法以及随后调用的代码片段。
清单 3. unmarshaller 类的入口点
// For each attribute, get its name and call mutator
List attributes = rootElement.getAttributes();
Method[] methods = objectClass.getMethods();
for (Iterator i = attributes.iterator(); i.hasNext(); ) {
Attribute att = (Attribute)i.next();
// Only want attributes for this namespace
if ((!att.getNamespace().equals(ns)) &&
(!att.getNamespace().equals(Namespace.NO_NAMESPACE))) {
continue;
}
// Determine method to call
String methodName = new StringBuffer()
.append("set")
.append(BindingUtils.initialCaps(att.getName()))
.toString();
// Find the method to call, and its parameter type
for (int j=0; j
找到了根元素的属性,并确定了每个属性的适用方法。然后,就是处理实际的 java.lang.reflect.Method 对象。XML 属性的值已确定,并作为调用的参数传送到方法。但是,需要解决一个映射问题;XML 文档中的所有数据都作为 String 抽取,但传递时必须是适当的 Java 类型。清单 4 将一个方法添加到 DataMapping 辅助类中,以满足转换的需要。
清单 4 将字符串映射成 Java 特定的类型
/**
*
* This will take the String value supplied and convert it
* to an Object of the type specified in paramType.
*
*
* @param value String value to convert.
* @param paramType Class with type to convert to.
* @return Object - value in correct type.
*/
public static Object getParameter(String value, Class paramType) {
Object ob = null;
String type = paramType.getName();
if (type.equals("java.lang.String")) {
ob = value;
} else if ((type.equals("int")) || (type.equals("java.lang.Integer"))) {
ob = Integer.valueOf(value);
} else if ((type.equals("long")) || (type.equals("java.lang.Long"))) {
ob = Long.valueOf(value);
} else if ((type.equals("float")) || (type.equals("java.lang.Float"))) {
ob = Float.valueOf(value);
} else if ((type.equals("double")) || (type.equals("java.lang.Double"))) {
ob = Double.valueOf(value);
} els