基于Java的WebService(XFire)

一.了解WebService.

1.什么是WebService?

　　对这个问题，我们至少有两种答案。从表面上看，Web service 就是一个应用程序，它向外界暴露出一个能够通过Web进行调用的API。这就是说，你能够用编程的方法通过Web来调用这个应用程序。我们把调用这个Web service 的应用程序叫做客户。例如，你想创建一个Web service ，它的作用是返回当前的天气情况。那么你可以建立一个ASP页面，它接受邮政编码作为查询字符串，然后返回一个由逗号隔开的字符串，包含了当前的气温和天气。

      下面是对Web service 更精确的解释： Web services是建立可互操作的分布式应用程序的新平台。作为一个Windows程序员，你可能已经用COM或DCOM建立过基于组件的分布式应用程序。COM是一个非常好的组件技术，但是我们也很容易举出COM并不能满足要求的情况。

　　Web service平台是一套标准，它定义了应用程序如何在Web上实现互操作性。你可以用任何你喜欢的语言，在任何你喜欢的平台上写Web service ，只要我们可以通过Web service标准对这些服务进行查询和访问。

      新平台

　　Web service平台需要一套协议来实现分布式应用程序的创建。任何平台都有它的数据表示方法和类型系统。要实现互操作性，Web service平台必须提供一套标准的类型系统，用于沟通不同平台、编程语言和组件模型中的不同类型系统。在传统的分布式系统 中，基于界面(interface)的平台提供了一些方法来描述界面、方法和参数（译注：如COM和COBAR中的IDL语言）。同样的，Web service平台也必须提供一种标准来描述Web service，让客户可以得到足够的信息来调用这个Web service。最后，我们还必须有一种方法来对这个Web service进行远程调用。这种方法实际是一种远程过程调用协议(RPC)。为了达到互操作性，这种RPC协议还必须与平台和编程语言无关。下面几个小节就简要介绍了组成Web service平台的这三个技术。 　　

      XML和XSD 　　

      可扩展的标记语言(XML)是Web service平台中表示数据的基本格式。除了易于建立和易于分析外，XML主要的优点在于它既是平台无关的，又是厂商无关的。无关性是比技术优越性更重要的：软件厂商是不会选择一个由竞争对手所发明的技术的。 　　

      XML解决了数据表示的问题，但它没有定义一套标准的数据类型，更没有说怎么去扩展这套数据类型。例如，整形数到底代表什么？16位，32位，还是64位？这些细节对实现互操作性都是很重要的。W3C制定的XML Schema(XSD)就是专门解决这个问题的一套标准。它定义了一套标准的数据类型，并给出了一种语言来扩展这套数据类型。Web service平台就是用XSD来作为其数据类型系统的。当你用某种语言(如VB. NET或C#)来构造一个Web service时，为了符合Web service标准，所有你使用的数据类型都必须被转换为XSD类型。你用的工具可能已经自动帮你完成了这个转换，但你很可能会根据你的需要修改一下转换过程。在第二章中，我们将深入XSD，学习怎样转换自定义的数据类型(例如类)到XSD的类型。 　　

      SOAP 　　

      Web service建好以后，你或者其他人就会去调用它。简单对象访问协议(SOAP)提供了标准的RPC方法来调用Web service。实际上，SOAP在这里有点用词不当：它意味着下面的Web service是以对象的方式表示的，但事实并不一定如此：你完全可以把你的Web service写成一系列的C函数，并仍然使用SOAP进行调用。SOAP规范定义了SOAP消息的格式，以及怎样通过HTTP协议来使用SOAP。SOAP也是基于XML和XSD的，XML是SOAP的数据编码方式。第三章我们会讨论SOAP，并结识SOAP消息的各种元素。 　　

      WSDL 　　

      你会怎样向别人介绍你的Web service有什么功能，以及每个函数调用时的参数呢？你可能会自己写一套文档，你甚至可能会口头上告诉需要使用你的Web service的人。这些非正式的方法至少都有一个严重的问题：当程序员坐到电脑前，想要使用你的Web service的时候，他们的工具(如Visual Studio)无法给他们提供任何帮助，因为这些工具根本就不了解你的Web 　　

      service。解决方法是：用机器能阅读的方式提供一个正式的描述文档。Web service描述语言(WSDL)就是这样一个基于XML的语言，用于描述Web service及其函数、参数和返回值。因为是基于XML的，所以WSDL既是机器可阅读的，又是人可阅读的，这将是一个很大的好处。一些最新的开发工具既能根据你的Web service生成WSDL文档，又能导入WSDL文档，生成调用相应Web service的代码。 　　

      UDDI 　　

      Universal Description, Discovery and Integration 　　为加速Web Service的推广、加强Web Service的互操作能力而推出的一个计划,基于标准的服务描述和发现的规范(specification)。 　　

      以资源共享的方式由多个运作者一起以Web Service的形式运作UDDI商业注册中心。 　　

      UDDI计划的核心组件是UDDI商业注册，它使用XML文档来描述企业及其提供的Web Service。 　　

      UDDI商业注册提供三种信息： 　　

            White Page包含地址、联系方法、已知的企业标识。 　　

            Yellow Page包含基于标准分类法的行业类别。 　　

            Green Page包含关于该企业所提供的Web Service的技术信息，其形式可能是指向文件或URL的指针，而这些文件或URL是为服务发现机制服务的。

 

二.用XFire实现简单的WebService应用.

1.下载支持XFire的Jar包.

      如果使用MyEclipse的话则不用下载,因为MyEclipse已经集成.在工程上右键选择MyEclipse->add WebService...进行添加,此处不做介绍.

      可以访问xfire.codehaus.org下载XFire框架的安装包，下载时请选择“全部二进制发布包（BinaryDistributioninzippackage）”，而不仅仅是“XFirejar文件（JarofallXFiremodules）”。下载完毕后解压,把根据目录下的xfire-all-1.2.6.jar和lib文件夹中的所有文件都拷贝到工程的WEB-INF/lib中.

2.配置XFire的运行环境.

      修改工程中的WEB-INF/web.xml文件,如下:

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.4" 
	xmlns="http://java.sun.com/xml/ns/j2ee" 
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
	xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee 
	http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
  
  <servlet>
    <servlet-name>XFireServlet</servlet-name>
    <servlet-class>org.codehaus.xfire.transport.http.XFireConfigurableServlet</servlet-class>
    <load-on-startup>0</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>XFireServlet</servlet-name>
    <url-pattern>/services/*</url-pattern>
  </servlet-mapping>
  
  
  <welcome-file-list>
    <welcome-file>index.jsp</welcome-file>
  </welcome-file-list>
</web-app>

注意:此处可以在原来Web.xml文件上进行修改,只需求添加<servlet>和<servlet-mapping>标签即可,引入了XFireServlet类,以处理Web Service请求,并且负责提供Web Service的WSDL(Web服务描述语言)

3.在WEB-INF/classes下创建文件夹:/META-INF/xfire,并在其中创建services.xml文件,文件中内容如下:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://xfire.codehaus.org/config/1.0">

</beans>

4.此时WebService的环境已经搭建完毕.

      在地址栏中输入http://localhost:8888/TestXFire/services,如果不报错说明配置成功.因为没有创建任何WebService所以显示如下信息:

          Generated by XFire ( http://xfire.codehaus.org )

5.创建WebService.

ISayHelloService.java文件如下:

package com.study;

public interface ISayHelloService
{
    public String sayHello(String name) ;
}

      这个接口告诉服务器,你的WebService哪些方法是可以被用户调用的.下面再来写一个ISayHelloService的实现类,以完成业务逻辑.

SayHelloServiceImpl.java文件如下:

package com.study;

public class SayHelloServiceImpl implements ISayHelloService
{

    public String sayHello(String name)
    {
        if(name==null || "".equals(name)){
            return "为什么不告诉我你的名字?" ;
        }
        return ",你妈喊你回家吃饭啦!";
    }

    public String noSay(String name){
        return name+",不告诉你" ;
    }
}

这个类实现了sayHello方法,这个方法是可以通过WebService访问到的.另外一个方法noSay(),该方法没有在接口ISayHelloService中定义,所以不能被WebService调用到.

6.发布WebService.

修改WEB-INF/classes/META-INF/xfire/services.xml文件,修改后的文件如下:

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://xfire.codehaus.org/config/1.0">
    <service>
        <name>SayHelloService</name>
        <serviceClass>com.study.ISayHelloService</serviceClass>
        <implementationClass>com.study.SayHelloServiceImpl</implementationClass>
    </service>
</beans>

这个文件定义了一个WebService：SayHelloService,并且同时定义了接口和实现类

7.启动Tomcat。

启动Tomcat，在浏览器地址栏中输入http://localhost:8888/TestXFire/services，会显示如下信息：

Available Services:

• HelloWebService [wsdl]

 

Generated by XFire ( http://xfire.codehaus.org )

点击[wsdl]，会显示相应的WSDL信息。

8.测试WebService。

编写一个具有main函数的类，用于测试WebService.

package com.main;

import java.net.MalformedURLException;

import org.codehaus.xfire.client.Client;
import org.codehaus.xfire.client.XFireProxyFactory;
import org.codehaus.xfire.service.Service;
import org.codehaus.xfire.service.binding.ObjectServiceFactory;

import com.study.ISayHelloService;

public class SayHello
{
    /**
     * <p>Description:[方法功能描述]</p>
     * @param args
     * @author:{ysj}
     * @update:[日期YYYY-MM-DD][更改人姓名][变更描述]
     */

    public static void main(String[] args)
    {
        String serviceURL = "http://localhost:8888/TestXFire3/services/SayHelloService" ;//SayHelloService是在services.xml中配置的name标签的值
        Service serviceModel = new ObjectServiceFactory().create(ISayHelloService.class, null, "http://localhost:8888/TestXFire3/services/SayHelloService?wsdl", null) ;//此处的URL为WSDL所在URL
        XFireProxyFactory serviceFactory = new XFireProxyFactory() ;//通过代理工厂创建一个service工厂
        try
        {
            ISayHelloService service = (ISayHelloService)serviceFactory.create(serviceModel, serviceURL) ;
            Client client = Client.getInstance(service) ;
            String hello = service.sayHello(null) ;
            System.out.println("服务器对无名氏说:"+hello) ;
            hello = service.sayHello("张三") ;
            System.out.println("服务器对[张三]说:"+hello) ;
        }
        catch (MalformedURLException e)
        {
            e.printStackTrace();
        }
    }
}

输出结果为：

 

服务器对无名氏说:为什么不告诉我你的名字?
服务器对[张三]说:,你妈喊你回家吃饭啦!