Apache Axis用户指南(3)

来源：互联网发布：网络受限制或无连接编辑：程序博客网时间：2024/05/18 03:03

本部分是apache axis用户指南的第三部分。在Axis中使用WSDL文件。

10.使用WSDL

Web Service Description Language是由IBM和Microsoft完成的规范，并且被很多其他的组织所支持。WSDK用于结构化的描述Web Services。Web服务的WSDL是由程序来使用的，它包含了服务的接口，服务使用的数据类型以及服务的位置。更多的内容，可以参考W3C的WSDL规范。

Axis通过以下三宗方式来支持WSDL

¨ 在Axis中发布一个服务后，用户可以通过标准的web浏览器来访问服务的URL，在后面添加一个?WSDL，这样就可以获得自动生成的服务的WSDL文件。

¨ 提供了一个WSDL2Java工具，用于根据WSDL文件生成Java代理类和框架类。

¨ 提供了一个Java2WSDL工具，用于根据Java类构建WSDL文件。

?WSDL：获取服务的WSDL文件

当通过Axis成功发布一个服务后，这个服务和唯一的一个URL相关联。对于JWS文件来说，URL就是JWS文件本身的路径；对于非JWS服务来说，一般情况下URL的格式如下：

http://<host>[:port]/axis/services/<service-name>

如果可以通过浏览器访问服务的URL，那么就会看到一个提示消息，提示终端节点是一个Axis服务，那么你应该通过SOAP来访问。提示信息如下：

<service-name>

Hi there, this is an AXIS service!

Perhaps there will be a form for invoking the service here...

然而，如果在URL后面添加一个”?wsdl”，那么Axis会自动生成一个服务的WSDL文件，并在浏览器中以XML格式显示，如下图所示：

WSDL2Java:根据WSDL文件创建Stubs、Skeletons和数据类型

客户端绑定

Axis的WSDL-to-Java工具的类为org.apache.axis.wsdl.WSDL2Java，基本调用方式如下：

java org.apache.axis.wsdl.WSDL2Java (WSDL-file-URL)

这会为客户端生成必要的绑定，这个过程中Axis遵守JAX-RPC规范。假设执行以下命令：

cm %AXIS_HOME%/samples/addr

java org.apache.axis.wsdl.WSDL2Java AddressBook.wsdl

这会在%AXIS_HOME%/samples/addr/AddressFetcher2目录生成很多类。他们之所以在这里生成，是由于这是WSDL中声明的targetNamespace，并且是映射到Java的包名。名称空间会在下面进行说明：

类型

根据WSDL类型生成的Java类根据WSDL的类型进行命名。一般来说(不是绝对的),这个java类会是一个bean。例如下面的WSDL类型：

<xsd:complexType name="phone">

<xsd:all>

<xsd:element name="areaCode" type="xsd:int"/>

<xsd:element name="exchange" type="xsd:string"/>

<xsd:element name="number" type="xsd:string"/>

</xsd:all>

</xsd:complexType>

WSDL2Java会生成如下的Java类：

public class Phone implements java.io.Serializable {

public Phone() {...}

public int getAreaCode() {...}

public void setAreaCode(int areaCode) {...}

public java.lang.String getExchange() {...}

public void setExchange(java.lang.String exchange) {...}

public java.lang.String getNumber() {...}

public void setNumber(java.lang.String number) {...}

public boolean equals(Object obj) {...}

public int hashCode() {...}

}

XML-->Java的映射：元数据

上面例子中的XML类型名为phone，而生成的Java类名为Phone，第一个字母为大写，以适应Java编码规范。这种映射经常发生，因为对于XML的名称或者标志符的限制要比Java少得多。例如，如果phone的子元素的名字为new，那么由于new是Java中的保留字，所以不能生成这样的成员属性。为了支持这种类型的映射，同时支持XML属性的序列化与反序列化，通过类型元数据系统来关联Java数据类和描述符。

当WSDL2Java工具生成了一个数据bean，例如上面的Phone类，它会观察是否schema中包含一些没有直接映射到Java的成员变量的属性或者名字。如果有的话，就会生成一个静态的代码片断并为这个类提供一个类型描述符。类型描述符是一个变量描述符的集合，每一个变量描述符将Java的变量映射到XML元素或者属性。

// Type metadata

private static TypeDesc typeDesc;

static {

typeDesc = new TypeDesc(AttributeBean.class);

FieldDesc field;

// An attribute with a specified QName

field = new AttributeDesc();

field.setFieldName("name");

field.setXmlName(new QName("foo", "nameAttr"));

typeDesc.addFieldDesc(field);

// An attribute with a default QName

field = new AttributeDesc();

field.setFieldName("male");

typeDesc.addFieldDesc(field);

// An element with a specified QName

field = new ElementDesc();

field.setFieldName("age");

field.setXmlName(new QName("foo", "ageElement"));

typeDesc.addFieldDesc(field);

}

Holders

这种类型作为输入输出或者输出参数使用。Java没有输入输出/输出参数的概念。为了实现这种行为，JAX-RPC指定使用holder类。一个Holder类似一个简单的java类，包含了它的一个类型。例如上面例子中的Phone类的holder类如下：

package samples.addr.holders;

public final class PhoneHolder implements javax.xml.rpc.holders.Holder {

public samples.addr.Phone value;

public PhoneHolder()

{

}

public PhoneHolder(samples.addr.Phone value) {

this.value = value;

}

holder类只有在类型被作为输入输出或者输出参数的时候才被生成。Holder类实在类名后面加上后缀Holder来命名，并且生成到包名为holders下面。

PortTypes

服务定义接口(Service Definition Interface,SDI)是继承了WSDL的portType的接口，可以通过这个接口访问服务操作。例如下面的WSDL：

</message>

</operation>

</portType>

WSDL2Java会生成如下的接口：

public interface AddressBook extends java.rmi.Remote {

public void addEntry(String name, Address address) throws java.rmi.RemoteException;

}

SDI接口的名字就是portType得名字。为了构造SDI，WSDL2Java需要从portType何binding种同时获取信息。

JAX-RPC规范对这部分的说明是：

"The name of the Java interface is mapped from the name attribute of the wsdl:portType element. ... If the mapping to a service definition interface uses elements of the wsdl:binding ..., then the name of the service definition interface is mapped from the name of the wsdl:binding element."

这个规范是JAX-RPC，这意味着只适用于portType是一个RPC接口。如果绑定的信息不是RPC，那么将使用绑定的名称。

可以有一个portType—pt和两个绑定bRPC和bDoc，这样的话就不能为两个绑定使用一个接口，此时需要使用两个接口，一个叫pt，另一个叫bDoc，同时还要生成两个stubs，一个叫bRPCStub(实现了pt)，另一个叫bDocStub(实现了bDoc)。

document/literal改变了接口的形式。

绑定

Stub类实现了SDI，Stub的名字是绑定的名字+Stub。它包含将方法调用转换成SOAP调用的代码，通过使用Axis的Service和Call对象。它作为远程服务的代理，使调用时就像调用本地对象一样。也就是说，不需要处理endpoing的URL，名称空间或者参数数组，这些需要通过Service和Call对象动态调用。Stub隐藏了所有这些的具体实现。

根据下面的WSDL片段：

...

</binding>

WSDL2Java会生成如下的Stub：

public class AddressBookSOAPBindingStub extends org.apache.axis.client.Stub

implements AddressBook {

public AddressBookSOAPBindingStub() throws org.apache.axis.AxisFault

{...}

public AddressBookSOAPBindingStub(URL endpointURL,

javax.xml.rpc.Service service)

throws org.apache.axis.AxisFault

{...}

public AddressBookSOAPBindingStub(javax.xml.rpc.Service service)

throws org.apache.axis.AxisFault

{...}

public void addEntry(String name, Address address) throws RemoteException

{...}

}

Services服务

正常来讲，客户端应用程序不会直接实例化一个stub，而是实例化一个service locator，然后调用一个方法来返回stub。这个locator是根据WSDL中的服务元素来指定的。WSDL2Java根据service元素生成两个独享，例如：

<service name="AddressBookService">

<port name="AddressBook" binding="tns:AddressBookSOAPBinding">

<soap:address location="http://localhost:8080/axis/services/AddressBook"/>

</port>

</service>

WSDL2Java会生成如下接口和类：

public interface AddressBookService extends javax.xml.rpc.Service {

public String getAddressBookAddress();

public AddressBook getAddressBook() throws javax.xml.rpc.ServiceException;

public AddressBook getAddressBook(URL portAddress) throws javax.xml.rpc.ServiceException;

}

实现了AddressBookServie的类：

public class AddressBookServiceLocator extends org.apache.axis.client.Service

implements AddressBookService {

...

}

Service接口定义了WSDL中定义的每个接口的get方法。locator实现了service接口，也就是说它实现了get方法。它用来获取Stub实例。Service类会默认的创建一个指向endpoint URL的Stub，但是当请求PortType的时候，可能需要指定一个不同的URL。

一个典型的stub类的应用如下：

public class Tester

{

public static void main(String [] args) throws Exception {

// Make a service

AddressBookService service = new AddressBookServiceLocator();

// Now use the service to get a stub which implements the SDI.

AddressBook port = service.getAddressBook();

// Make the actual call

Address address = new Address(...);

port.addEntry("Russell Butek", address);

}

服务器端的绑定

就像在客户端有一个Web Service的Java stub一样，一个Java 框架的skeleton在服务器端使用。为了生成Skeleton类，需要使用WSDL2Java的—server-side –skeletonDeploy true选项。例如，仍旧使用AddressBook.wsdl文件：

java org.apache.axis.wsdl.WSDL2Java --server-side --skeletonDeploy true AddressBook.wsdl

可以看到WSDL2Java生成了所有在之前生成的client端的类，但是又声称了一些新的文件：

如果不指定—skeletonDeploy true选项，那么不会生成skeleton，而是生成的deploy.wsdd文件指示实现类已经直接部署了。在这种情况下，deploy.wsdd文件包含了额外的元数据来描述实现类的操作和参数。通过下面的方法可以直接部署服务：

java org.apache.axis.wsdl.WSDL2Java --server-side AddressBook.wsdl

下面是在服务器端生成的文件：

绑定

Skeleton描述

Skeleton类是介于Axis engine和实际的服务实现之间的类。它的名字就是绑定的名字+Skeleton。例如对于AddressBook绑定，WSDL2Java会生成如下的Skeleton：

public class AddressBookSOAPBindingSkeleton implements AddressBook,

org.apache.axis.wsdl.Skeleton {

private AddressBook impl;

public AddressBookSOAPBindingSkeleton() {

this.impl = new AddressBookSOAPBindingImpl();

}

public AddressBookSOAPBindingSkeleton(AddressBook impl) {

this.impl = impl;

}

public void addEntry(java.lang.String name, Address address)

throws java.rmi.RemoteException

{

impl.addEntry(name, address);

}

实际的Skeleton类可能内容还有很多，这里只拷贝了基本的框架。

skeleton类包含一个AddressBook服务的实现。这个实现要么通过构造器传递给skeleton，要么是一个生成的实现的实例。当Axis engine调用skeleton的addEntry的方法时，它只需要简单的将调用分配给实际的实现的addEntry方法。

实现模板描述

WSDL还根据绑定生成了一个实现模板：

public class AddressBookSOAPBindingImpl implements AddressBook {

public void addEntry(String name, Address address)

throws java.rmi.RemoteException {

}

这个类实际上只是一个实现的测试，并没有做任何事，它预想服务的编程人员来根据这个模板完成具体的实现。

服务

这个工具同时生成了deploy.wsdd和undeploy.wsdd文件，可以供AdminClient食用。这些文件只有当填充了实现类的具体方法后，编译类文件，然后将类文件放到Axis engine可以访问的位置后，才可以调用AdminClient方法来发布服务。

11.Java2WSDL

这个工具笔者就不介绍了

笔者认为使用WSDL2Java工具生成的代码中冗余的代码太多，并且编码规范有一些ApacheAxis-Specific，所以觉得还是自己手写代码比较好一些。

一旦写完了Java代码，可以通过Web浏览器访问，获取WSDL文件，没有必要使用Java2WSDL了。

12.公开的Axis接口

Axis公开的接口相对稳定，可以使用，即使Axis重构的话，这部分也应该不会修改。或者做一些兼容性的修改。

可以实现的一些Apache Axis的接口如下：

JAX-RPC的一些接口，这些接口是针对JAX-RPC规范1.0的，会根据新的规范进行修改。

Axis接口：这些相对不稳定。

12.重要的类

org.apache.axis.MessageContext

Axis所知道的关于请求/响应的所有的信息都是通过MessageContext来获取的。Axis将下面的内容存储在MessageContext中：

AxisEngine的引用

请求和响应的消息(org.apache.axis.Message对象可以通过Getter和Setter方法存取)

无状态以及服务范围的信息(服务是否维持session信息)

当前处理状态

认证信息(用户名和密码，可以由servlet服务器提供或者其他方式)

丰富的属性。几乎所有关于属性的信息都可以通过MessageContext.getProperty()方法获取。只需要知道属性的名称，通常是一个常量，定义在例如org.apache.axis.transport.http.HTTPConstants这样的类中。例如，可以获取Axis Servlet的ServletContext，通过(HttpServlet)msgC.getProperty(HTTPConstants.MC_HTTP_SERVLET).getServletContext()。

在服务中，当前的MessageContext总是可以通过静态的方法MessageContext.getCurrentContext()获取。

org.apache.axis.Message

org.apache.axis.Message对象是Axis对SOAP消息的一种表示。请求和响应消息可以从MessageContext中获取(如上所述)。Message包括：

MIME头(如果message本身包含MIME信息)

附件(如果message本身包含附件)

SOAPPart(快速获取SOAPPart的SOAPEnvelope)，可以通过SOAPPart访问SOAP的任意信息(<soap:Envelope>标签内的任意信息)

org.apache.axis.SOAPEnvelope

一个MessageContext有两个Message，每个都包含一个SOAPPart，SOAPPart包含SOAPEnvelope。SOAPEnvelope包含SOAP信封的所有内容。可以从SOAPEnvelope中获取SOAP Header和SAOP Body。