Java编程中使用XFire框架调用WebService程序接口

时间：2021-11-11 05:49:55

 JAVA调用webservice，当你刚开始接触的时候你会觉得它是一个恶梦，特别是没有一个统一的标准实现，比起.net的那些几步就可以完成的webservice实现，我们看着JAVA的实现真是伤心啊。但就算是伤心，我们也还是要完成的。JAVA也不乏比较好的实现，如xfire,jersey,CXF。 这里我们就一起来看一下xfire的实现。

 1）首先，当然是要下包啦，这个普通人都知道。http://xfire.codehaus.org/Download可以到这里去下，可以下all也可以下distribution。但建议还是下all的，免得一堆奇怪的问题搞得你一点信心都没了。

 包弄下来了那么怎么办呢？放进项目里啊。貌似废话，但很多人就是不知道下下来要干什么用。

 建一个新项目，比较我的是xfireWebservice，这里当然是建web项目啦。

Java编程中使用XFire框架调用WebService程序接口Java编程中使用XFire框架调用WebService程序接口

我这里是把它所有的包都放到这里面了，毕竟我们写例子，就没必要挑三拣四了，随便点吧，如果想看看异常信息的朋友可以不把全部放进去，慢慢地加入，以后遇到错误也好排除，但我们这里就不那么做了，毕竟一般缺少什么类那些的异常没什么难看的，大家可以自己排除。

 2）我们首先来了解一下xfire与其他webservice框架的不同，它最大的不同之处在于它需要一个接口，而且如果需要用xfire来调用相应的webservice必须知道接口的定义，感觉这里有点限制了。但除了这点，xfire调用webservice，那是相当的方便，就跟调用本地方法一样。我们直接来看例子：

 首先是最重要的接口：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
public interface IReaderService {
  public Reader getReader(String name,String password);
  public List<Reader> getReaders();
}
 有接口，当然也要有实现类，不然接口就没什么意义了。
public class ReaderService implements IReaderService{
  public Reader getReader(String name,String password) {
    return new Reader(name,password);
  }
   
  public List<Reader> getReaders(){
    List<Reader> readerList = new ArrayList<Reader>();
    readerList.add(new Reader("shun1","123"));
    readerList.add(new Reader("shun2","123"));
    return readerList;
  }
}

  也看一下JAVABEAN，Reader类：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
public class Reader{
  private static final long serialVersionUID = 1L;
  private String name;
  private String password;
   
  public Reader(){}
  public Reader(String name,String password) {
    this.name = name;
    this.password = password;
  }
    //Get/Set方法省略
  public String toString(){
    return "Name:"+name+",Password:"+password;
  }
   
}

  注意，我们这里的Reader类实现了Serializable接口，为什么呢？这里，首先我们需要了解webservice的原理，对于JAVA来讲，如果我们需要在互联网上传对象，很多人当然会想到序列化，对了，这里就是序列化，因为我们需要把reader作为参数来传递。这在以前的版本中是需要强制实现，否则会报错，但现在的最新的版本（其实最新的也是07年的，因为xfire已经停止开发，被apache合并为CXF项目，这个我们之后再讲）已经不需要了，至于是用什么方式实现的，我们这里暂时不深究，因为它已经被合并到CXF中，我们如果要深入学习，应该学习CXF较好。

 3）当我们完成上面的接口和JAVABEAN的编写后，很多人会问，我看很多webservice都会有WSDL文件，那你这个怎么来的？在讲这个之前，我们来讨论一下什么是WSDL。也许很多公司提供的接口都还是只是一个HTTP地址，返回XML这样的格式，我们的也是。这有一个好处，也有一个坏处。好处是我们开发的难度小了，而坏处是我们需要提供给用户一堆说明文件，每个返回的XML标签是什么意思，这倒也没啥，但就是比较烦而已。而webservice呢，坏处就是我们开发的东西稍微多了点，而好处是我们不用再写那么多说明文件，因为有一个统一的说明，叫WSDL，这个是webservice的说明文档，是统一的，无论什么语言都一样，所以不存在谁看不懂的问题。

 而这里，当我们部署完成xfire后，它就可以帮我们生成WSDL文件。

 问题是怎么部署，这个其实也简单。我们在src目录下新建一个文件夹META-INF，再建它的一个字文件夹xfire，里面建立文件services.xml。之后的结构如下：
 

 有人会问为什么要建到src目录下，其实不是规定建到这里的，但因为我们需要让开发工具帮我们自己部署这几个文件，所以我们放到这里，eclipse就可以帮我们自己部署到tomcat或者其他的容器中。注意，这个文件所在文件夹层次是固定的，不可以修改。

 我们直接看一下servics.xml:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://xfire.codehaus.org/config/1.0">
  <service>
    <!-- webserviceq名称，调用时需要指定这个 -->
    <name>readerService</name>
    <!-- 这个一般是自己公司的网址，意义不大 -->
    <namespace>http://test/HelloService</namespace>
    <!-- 接口类 -->
    <serviceClass>com.xfire.servlet.IReaderService</serviceClass>
    <!-- 实现类 -->
    <implementationClass>com.xfire.servlet.ReaderService</implementationClass>
  </service>
</beans>


 看着注释一般都没问题的。

 4）很多人以为这样就行了，不，还没行，你指定了这个，那别人怎么访问呢。怎么把相应的请求转发到xfire那里，让它进行处理呢。这里又需要修改web.xml了。
 修改后如下：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
  xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"
  id="WebApp_ID" version="3.0">
  <servlet>
    <servlet-name>XFireServlet</servlet-name>
    <servlet-class>org.codehaus.xfire.transport.http.XFireConfigurableServlet</servlet-class>
  </servlet>
 
  <servlet-mapping>
    <servlet-name>XFireServlet</servlet-name>
    <url-pattern>/services/*</url-pattern>
  </servlet-mapping>
</web-app>

  其实也就是添加了一个servlet和对应的mapping。接下来，我们在浏览器上直接输入:

?
1
http://localhost:8080/xfireWebService/services/readerService?wsdl

 我们可以看到：

Java编程中使用XFire框架调用WebService程序接口

这里显示的就是wsdl，它会显示我们定义的方法，返回的类型。后面有对WSDL的讲解。
5）上面四步完成后，我们就完成了webservice的部署了。别人就可以调用相应的webservice来访问我们的方法了。下面我们就用xfire提供的client来访问一下我们刚才发布的webservice:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
public class ReaderClient {
  public static void main(String[] args) {
    //这里是创建一个service，需要传入一个接口类，因为我们后面必须调用相应的接口方法
    Service srcModel = new ObjectServiceFactory().create(IReaderService.class);
    //代理工厂，这里是为了后面创建相应的接口类
    XFireProxyFactory factory = new XFireProxyFactory(XFireFactory.newInstance().getXFire());
    //webservice地址，不需要加wsdl
    String readerServiceUrl = "http://localhost:8080/xfireWebService/services/readerService";
     
    try {
      //利用工厂返回相应的接口类
      IReaderService readerService = (IReaderService)factory.create(srcModel,readerServiceUrl);
 
      Reader reader = readerService.getReader("shun","123");
      System.out.println(reader);
    } catch (MalformedURLException e) {
      e.printStackTrace();
    }
  }
}

 这样，我们看到输出结果为：

Java编程中使用XFire框架调用WebService程序接口

 

wsdl文件结构分析


WSDL (Web Services Description Language,Web服务描述语言)是一种XML Application，他将Web服务描述定义为一组服务访问点，客户端可以通过这些服务访问点对包含面向文档信息或面向过程调用的服务进行访问(类似远程过程调用)。WSDL首先对访问的操作和访问时使用的请求/响应消息进行抽象描述，然后将其绑定到具体的传输协议和消息格式上以最终定义具体部署的服务访问点。相关的具体部署的服务访问点通过组合就成为抽象的Web服务。 本文将详细讲解WSDL文档的结构，并分析每个元素的作用。

一：WSDL定义

    WSDL是一个用于精确描述Web服务的文档，WSDL文档是一个遵循WSDL XML模式的XML文档。WSDL 文档将Web服务定义为服务访问点或端口的集合。在 WSDL 中，由于服务访问点和消息的抽象定义已从具体的服务部署或数据格式绑定中分离出来，因此可以对抽象定义进行再次使用：消息，指对交换数据的抽象描述；而端口类型，指操作的抽象集合。用于特定端口类型的具体协议和数据格式规范构成了可以再次使用的绑定。将Web访问地址与可再次使用的绑定相关联，可以定义一个端口，而端口的集合则定义为服务。

   一个WSDL文档通常包含7个重要的元素，即types、import、message、portType、operation、binding、 service元素。这些元素嵌套在definitions元素中，definitions是WSDL文档的根元素。文章的下一部分将会详细介绍WSDL 的基本结构。

二：WSDL的基本结构--概述

如第一部分最后描述的那样，一个基本的WSDL文档包含7个重要的元素。下面将分别介绍这几个元素以及他们的作用。

WSDL 文档在Web服务的定义中使用下列元素：

·                Types - 数据类型定义的容器，它使用某种类型系统(一般地使用XML Schema中的类型系统)。

·                Message - 通信消息的数据结构的抽象类型化定义。使用Types所定义的类型来定义整个消息的数据结构。

·                Operation - 对服务中所支持的操作的抽象描述，一般单个Operation描述了一个访问入口的请求/响应消息对。

·                PortType - 对于某个访问入口点类型所支持的操作的抽象集合，这些操作可以由一个或多个服务访问点来支持。

·                Binding - 特定端口类型的具体协议和数据格式规范的绑定。

·                Port - 定义为协议/数据格式绑定与具体Web访问地址组合的单个服务访问点。

·                Service- 相关服务访问点的集合。

WSDL的xml schema可以参照如下网址：http://schemas.xmlsoap.org/wsdl/

三：WSDL的基本结构--详述

本节将通过一个例子详细描述WSDL文档每个元素的作用。下面一个例子是一个简单的WSDL文档的内容，该文档的产生可以参见我的另外一篇文章：xfire开发实例--HelloWorld篇 。

一个简单的Web Service的WSDL文档，该服务支持名为sayHello的唯一操作，该操作通过在http上运行SOAP协议来实现的。该请求接受一个字符串name，经过处理后返回一个简单的字符串。文档如下：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
<?xml version="1.0" encoding="UTF-8" ?>
<wsdl:definitions
  targetNamespace="http://com.liuxiang.xfireDemo/HelloService"
  xmlns:tns="http://com.liuxiang.xfireDemo/HelloService"
  xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/"
  xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:soapenc11="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:soapenc12="http://www.w3.org/2003/05/soap-encoding"
  xmlns:soap11="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
  <wsdl:types>
    <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
      attributeFormDefault="qualified" elementFormDefault="qualified"
      targetNamespace="http://com.liuxiang.xfireDemo/HelloService">
      <xsd:element name="sayHello">
        <xsd:complexType>
          <xsd:sequence>
            <xsd:element maxOccurs="1" minOccurs="1"
              name="name" nillable="true" type="xsd:string" />
          </xsd:sequence>
        </xsd:complexType>
      </xsd:element>
      <xsd:element name="sayHelloResponse">
        <xsd:complexType>
          <xsd:sequence>
            <xsd:element maxOccurs="1" minOccurs="1"
              name="out" nillable="true" type="xsd:string" />
          </xsd:sequence>
        </xsd:complexType>
      </xsd:element>
    </xsd:schema>
  </wsdl:types>
  <wsdl:message name="sayHelloResponse">
    <wsdl:part name="parameters" element="tns:sayHelloResponse" />
  </wsdl:message>
  <wsdl:message name="sayHelloRequest">
    <wsdl:part name="parameters" element="tns:sayHello" />
  </wsdl:message>
  <wsdl:portType name="HelloServicePortType">
    <wsdl:operation name="sayHello">
      <wsdl:input name="sayHelloRequest"
        message="tns:sayHelloRequest" />
      <wsdl:output name="sayHelloResponse"
        message="tns:sayHelloResponse" />
    </wsdl:operation>
  </wsdl:portType>
  <wsdl:binding name="HelloServiceHttpBinding"
    type="tns:HelloServicePortType">
    <wsdlsoap:binding style="document"
      transport="http://schemas.xmlsoap.org/soap/http" />
    <wsdl:operation name="sayHello">
      <wsdlsoap:operation soapAction="" />
      <wsdl:input name="sayHelloRequest">
        <wsdlsoap:body use="literal" />
      </wsdl:input>
      <wsdl:output name="sayHelloResponse">
        <wsdlsoap:body use="literal" />
      </wsdl:output>
    </wsdl:operation>
  </wsdl:binding>
  <wsdl:service name="HelloService">
    <wsdl:port name="HelloServiceHttpPort"
      binding="tns:HelloServiceHttpBinding">
      <wsdlsoap:address
        location="http://localhost:8080/xfire/services/HelloService" />
    </wsdl:port>
  </wsdl:service>
</wsdl:definitions>

types元素使用XML模式语言声明在WSDL文档中的其他位置使用的复杂数据类型与元素；

import元素类似于XML模式文档中的import元素，用于从其他WSDL文档中导入WSDL定义；
message元素使用在WSDL文档的type元素中定义或在import元素引用的外部WSDL文档中定义的XML模式的内置类型、复杂类型或元素描述了消息的有效负载；
portType元素和operation元素描述了Web服务的接口并定义了他的方法。portType元素和operation元素类似于java接口中定义的方法声明。operation元素使用一个或者多个message类型来定义他的输入和输出的有效负载；
Binding元素将portType元素和operation元素赋给一个特殊的协议和编码样式；
service元素负责将Internet地址赋给一个具体的绑定；

1、definitions元素

所有的WSDL文档的根元素均是definitions元素。该元素封装了整个文档，同时通过其name提供了一个WSDL文档。除了提供一个命名空间外，该元素没有其他作用，故不作详细描述。

下面的代码是一个definitions元素的结构：

?
1
2
3
4
5
6
7
8
9
10
11
<wsdl:definitions
  targetNamespace="http://com.liuxiang.xfireDemo/HelloService"
  xmlns:tns="http://com.liuxiang.xfireDemo/HelloService"
  xmlns:wsdlsoap="http://schemas.xmlsoap.org/wsdl/soap/"
  xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns:soapenc11="http://schemas.xmlsoap.org/soap/encoding/"
  xmlns:soapenc12="http://www.w3.org/2003/05/soap-encoding"
  xmlns:soap11="http://schemas.xmlsoap.org/soap/envelope/"
  xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/">
</wsdl:definitions>

2、types元素

WSDL采用了W3C XML模式内置类型作为其基本类型系统。types元素用作一个容器，用于定义XML模式内置类型中没有描述的各种数据类型。当声明消息部分的有效负载时，消息定义使用了在types元素中定义的数据类型和元素。在本文的WSDL文档中的types定义：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<wsdl:types>
    <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
      attributeFormDefault="qualified" elementFormDefault="qualified"
      targetNamespace="http://com.liuxiang.xfireDemo/HelloService">
      <xsd:element name="sayHello">
        <xsd:complexType>
          <xsd:sequence>
            <xsd:element maxOccurs="1" minOccurs="1"
              name="name" nillable="true" type="xsd:string" />
          </xsd:sequence>
        </xsd:complexType>
      </xsd:element>
      <xsd:element name="sayHelloResponse">
        <xsd:complexType>
          <xsd:sequence>
            <xsd:element maxOccurs="1" minOccurs="1"
              name="out" nillable="true" type="xsd:string" />
          </xsd:sequence>
        </xsd:complexType>
      </xsd:element>
    </xsd:schema>
  </wsdl:types>

上面是数据定义部分，该部分定义了两个元素，一个是sayHello，一个是sayHelloResponse：

sayHello：定义了一个复杂类型，仅仅包含一个简单的字符串，将来用来描述操作的参入传入部分；

sayHelloResponse：定义了一个复杂类型，仅仅包含一个简单的字符串，将来用来描述操作的返回值；

3、import元素

import元素使得可以在当前的WSDL文档中使用其他WSDL文档中指定的命名空间中的定义元素。本例子中没有使用import元素。通常在用户希望模块化WSDL文档的时候，该功能是非常有效果的。

import的格式如下：

?
1
<wsdl:import namespace="http://xxx.xxx.xxx/xxx/xxx" location="http://xxx.xxx.xxx/xxx/xxx.wsdl"/>

必须有namespace属性和location属性：

namespace属性：值必须与正导入的WSDL文档中声明的targetNamespace相匹配；

location属性：必须指向一个实际的WSDL文档，并且该文档不能为空。

4、message元素

message元素描述了Web服务使用消息的有效负载。message元素可以描述输出或者接受消息的有效负载；还可以描述SOAP文件头和错误detail元素的内容。定义message元素的方式取决于使用RPC样式还是文档样式的消息传递。在本文中的message元素的定义，本文档使用了采用文档样式的消息传递：

?
1
2
3
4
5
6
<wsdl:message name="sayHelloResponse">
    <wsdl:part name="parameters" element="tns:sayHelloResponse" />
  </wsdl:message>
  <wsdl:message name="sayHelloRequest">
    <wsdl:part name="parameters" element="tns:sayHello" />
  </wsdl:message>

该部分是消息格式的抽象定义：定义了两个消息sayHelloResponse和sayHelloRequest：

sayHelloRequest：sayHello操作的请求消息格式，由一个消息片断组成，名字为parameters,元素是我们前面定义的types中的元素；

sayHelloResponse：sayHello操作的响应消息格式，由一个消息片断组成，名字为parameters,元素是我们前面定义的types中的元素；

如果采用RPC样式的消息传递，只需要将文档中的element元素应以修改为type即可。

5、portType元素

portType元素定义了Web服务的抽象接口。该接口有点类似Java的接口，都是定义了一个抽象类型和方法，没有定义实现。在WSDL中， portType元素是由binding和service元素来实现的，这两个元素用来说明Web服务实现使用的Internet协议、编码方案以及 Internet地址。

一个portType中可以定义多个operation，一个operation可以看作是一个方法，本文中WSDL文档的定义：

?
1
2
3
4
5
6
7
8
<wsdl:portType name="HelloServicePortType">
  <wsdl:operation name="sayHello">
    <wsdl:input name="sayHelloRequest"
      message="tns:sayHelloRequest" />
    <wsdl:output name="sayHelloResponse"
      message="tns:sayHelloResponse" />
  </wsdl:operation>
</wsdl:portType>

portType定义了服务的调用模式的类型，这里包含一个操作sayHello方法，同时包含input和output表明该操作是一个请求／响应模式，请求消息是前面定义的sayHelloRequest，响应消息是前面定义的sayHelloResponse。input表示传递到Web服务的有效负载，output消息表示传递给客户的有效负载。

6、binding

binding元素将一个抽象portType映射到一组具体协议(SOAO和HTTP)、消息传递样式、编码样式。通常binding元素与协议专有的元素和在一起使用，本文中的例子：

?
1
2
3
4
5
6
7
8
9
10
11
12
<wsdl:binding name="HelloServiceHttpBinding"
  type="tns:HelloServicePortType">
  <wsdlsoap:binding style="document"
    transport="http://schemas.xmlsoap.org/soap/http" />
  <wsdl:operation name="sayHello">
    <wsdlsoap:operation soapAction="" />
    <wsdl:input name="sayHelloRequest">
      <wsdlsoap:body use="literal" />
    </wsdl:input>
    <wsdl:output name="sayHelloResponse">
      <wsdlsoap:body use="literal" />
    </wsdl:output>

 

标签：

相关文章