XFire开发时,在返回数据类型时遇到了一些麻烦,查到这样一篇文单,非常不错,故收藏之。
翻译:zilong3927 原文地址:http://docs.codehaus.org/display/XFIRE/Mapping+collections
调用Web Services时,经常需要返回集合(collection)作为结果,或者接受collection型的参数。 SOAP本身就支持这一点。
但是这一机制的问题在于,java语言的collections是无类型的(untyped).因此,如果要在Java 1.4 当中支持collections,就需要做一些额外的工作。
首先而且是推荐的做法是在JDK5当中使用范型(generics)。范型能够使你在代码当中为你的collections 指定类型信息,从而允许xfire自动地推导出collection类型,生成正确的wsdl等等。
下面示例了如何写这样的一个方法:
有些情况下并不总能够使用范型(generics).例如,如果你的部署环境使用JDK 1.4,或者你想暴露一些遗留的服务,而同时又不打算修改任何代码也不打算进行移植。
对于这样的一些情况而言,你需要生成一个xml映射文件,来指定方法和它们对应的集合类型(collection types).
这个xml文件的名字必须是<className>.aegis.xml,其中className是你的服务(service)的接口类(unqualified class)的名字。
下面最好通过一个例子来展示这个xml文件的格式。我们想要展现的服务有这样的一个接口:
String getFoo();
Collection getCollection();
void setList( int id , java.util.List);
}
既然代码中的collections没有指定类型,我们剧需要生成一个xml文件来指定所需要的类型。这个文件的路径应该和MyService1.class在同一个包(package)当中,并且它的名字应该是 MyService1.aegis.xml
对于这个接口来说,一个最简单的映射文件如下:
< mapping >
< method name = "getCollection" >
< return-type componentType = "java.lang.String" />
</ method >
< method name = "setList" >
< parameter index = "1" componentType = "java.lang.String" />
</ method >
</ mapping >
</ mappings >
注意这个映射文件确切地指定了所需要的信息,不包含任何冗余。例如,getFoo方法没有被指定,这是由于它没有包含任何collections,因此能够在没有任何映射信息的情况下暴露给使用者。
其次,setCollection 方法没有指定索引为0的参数。这是由于该参数类型为int,因此不需要任何映射
如果我们有多个方法,都匹配指定的映射又该怎么办? 这种情况下,映射就对所有匹配的方法均有效。
所以,如果在我们的接口中增加以下的方法:
那么现在我们的映射定义对于两个setList 方法都有作用。这种情况下,我们不必为额外的参数(译者注:此处指boolean persist)指定两次映射. 映射文件就指定了所有那些第二个参数为List的方法,并假定List中包含的都是strings。
如果我们想让那个具有3个参数的方法,其中的list不包含Strings,而是实际上包含Dates? 这种情况下,就需要一个更确切的映射来覆盖(override)原先那个更一般的,所以我们的映射文件需要添加下面这个定义:
< parameter index = "1" componentType = "java.lang.String" />
< parameter index = "2" class = "boolean" />
</ method >
注意一下类型属性。现在这个映射将对所有那些第二个参数为List,第三个参数为boolean型的方法适用。在我们的接口当中,这个映射唯一地确定了一个特定的方法,使用这个映射就能够解释方法当中的List参数。
在优先顺序方面,更确切的映射总是优先于更一般的。
让我们考虑下面这个复杂一些的例子:
{
Collection getCollection(); // method 1
Collection getCollection( int id); // method 2
Collection getCollection( String id); // method 3
Collection getCollectionForValues( int value , Collection c); // method 4
Collection getCollectionForValues( String id , Collection c); // method 5
}
映射文件的内容为:
< mapping >
<!-- mapping 1 -->
< method name = "getCollection" >
< return-type componentType = "java.lang.Double" />
</ method >
<!-- mapping 2 -->
< method name = "getCollection" >
< return-type componentType = "java.lang.Float" />
< parameter index = "0" class = "int" />
</ method >
<!-- mapping 3 -->
< method name = "getCollectionForValues" >
< return-type componentType = "java.math.BigDecimal" />
</ method >
<!-- mapping 4 -->
< method name = "getCollectionForValues" >
< parameter index = "0" class = "java.lang.String" />
< parameter index = "1" componentType = "java.util.Date" />
</ method >
<!-- mapping 5 -->
< method name = "getCollectionForValues" >
< return-type componentType = "java.util.Calendar" />
< parameter index = "0" class = "int" />
< parameter index = "1" componentType = "java.lang.Bit" />
</ method >
</ mapping >
</ mappings >
这个文件的格式是不需要做过多解释的。但有几点还是需要加以说明。
先来看一下第一个映射(mapping 1)。这个映射指定了所有getCollection 方法所返回的collections contain均包含java.lang.Doubles。如果没有指定其他的getCollection映射,那么这个映射将对方法1, 2, 3都适用。
但是,第二个映射更加明确地指定了它所适用的方法。即如果getCollection方法的第一个参数是int型,那么该方法所返回的collection包含的是Float 型。由于这条规则更加明确,它将为方法2覆盖掉第一个映射,这是满足映射约束标准的。
使用以上的规则,不难推导出方法4和方法5返回的collections结果的组件类型(component types)。
对于使用collections的java beans来说,语法也是类似的。例如,比方说我们有一个Company bean,包含了一个List ,其中的对象是employees:
{
private Collection employees;
Collection getEmployees() { return employees; }
public void setEmployees(Collection employees) { this .employees = employees };
}
除了可以使用<method> & <parameter> 元素外,也可以使用<property>元素:
< mapping >
< property componentType = "org.codehaus.xfire.Employee" />
</ mapping >
</ mappings >
Java Maps 并不能很好地映射到 XML Schema (no pun intended) ,因为XML Schema 中没有Map的概念,客户端也是这样,Maps被转换成{key, value}元组的集合。除了要提供value的类型以外,你还必须为Aegis 提供key的类型:
Map getGiftList() { /* returns a map of NiceChild => Present */ }
}
映射文件应该像下面这样:
< mapping >
< method name = "getGiftList" >
< return-type keyType = "org.codehaus.xfire.NiceChild" componentType = "org.codehaus.xfire.Present" >
</ method >
</ mapping >
</ mappings >
这将生成下面的类型:
< xsd:sequence >
< xsd:element name = "entry" minOccurs = "0" maxOccurs = "unbounded" >
< xsd:complexType >
< xsd:sequence >
< xsd:element name = "key" type = "ns1:NiceChild" minOccurs = "0" maxOccurs = "1" />
< xsd:element name = "value" type = "ns1:Present" minOccurs = "0" maxOccurs = "1" />
</ xsd:sequence >
</ xsd:complexType >
</ xsd:element >
</ xsd:sequence >
</ xsd:complexType >
在某些情况下,你可能想要传递Collections of Collections。比方说你有一个返回List of a List of Doubles的服务 (不要问为什么你要做这样一件事情...):
{
public List getListOfListOfDoubles
{
List l = new ArrayList();
List doubles = new ArrayList();
doubles.add( new Double ( 1.0 ));
l.add(doubles);
return l;
}
}
要处理这种情况,我们需要引进一个新的<component>元素。下面是一个很好的例子:
< mapping >
< method name = "getListofListofDoubles" >
< return-type componentType = "#someDoubles" />
</ method >
< component name = "someDoubles" class = "java.util.List" componentType = "java.lang.Double" />
</ mapping >
</ mappings >
正像你在这里所看到的,返回类型的componentType 是一个指向<component>的引用,而不是一个类。组件类型"#someDoubles" 引用到名字为"someDoubles"的 <component>。
Aegis 将会自动给这些collections命名为ArrayOfDouble 和 ArrayOfArrayOfDouble。你也可以改变这些名字。要设置你自己的名字,提供一个"typeName" 属性即可:
< mapping >
< method name = "getListofListofDoubles" >
< return-type componentType = "#someDoubles" typeName = "LotsOfDoubles" />
</ method >
< component name = "someDoubles" class = "java.util.List" typeName = "SomeDoubles" componentType = "java.lang.Double" />
</ mapping >
</ mappings >