webservice实例

首先,我们必须了解什么是webservice.就概念上来说,可能比较复杂,不过我们可以有个宏观的了解:webservice就是个对外的接口,里面有函数可供外部客户调用(注意:里面同样有客户不可调用的函数).假若我们是服务端,我们写好了个webservice,然后把它给了客户(同时我们给了他们调用规则),客户就可以在从服务端获取信息时处于一个相对透明的状态.即是客户不了解(也不需要)其过程,他们只获取数据.

Web Service 最适合网络的分布式运算环境，它采用公开的标准，以 HTTP 为通迅协定，可以跨平台，穿越网络管制，加上提供公布与查询 Web Service 的 UDDI 机制，免除用戶端必须事先注册 COM+/Remote Components 的困扰，虽然牺牲一点效能，但可以得到最大的弹性。

实际上，WebService的主要目标是跨平台的可互操作性。为了达到这一目标，WebService完全基于XML（可扩展标记语言）、XSD（XMLSchema）等独立于平台、独立于软件供应商的标准，是创建可互操作的、分布式应用程序的新平台。由此可以看出，在以下三种情况下，使用WebService会带来极大的好处。

长项一：跨防火墙的通信

如果应用程序有成千上万的用户，而且分布在世界各地，那么客户端和服务器之间的通信将是一个棘手的问题。因为客户端和服务器之间通常会有防火墙或者代理服务器。在这种情况下，使用DCOM就不是那么简单，通常也不便于把客户端程序发布到数量如此庞大的每一个用户手中。传统的做法是，选择用浏览器作为客户端，写下一大堆ASP页面，把应用程序的中间层暴露给最终用户。这样做的结果是开发难度大，程序很难维护。

举个例子，在应用程序里加入一个新页面，必须先建立好用户界面(Web页面)，并在这个页面后面，包含相应商业逻辑的中间层组件，还要再建立至少一个ASP页面，用来接受用户输入的信息，调用中间层组件，把结果格式化为HTML形式，最后还要把“结果页”送回浏览器。要是客户端代码不再如此依赖于HTML表单，客户端的编程就简单多了。如果中间层组件换成WebService的话，就可以从用户界面直接调用中间层组件，从而省掉建立ASP页面的那一步。要调用WebService，可以直接使用MicrosoftSOAPToolkit或.NET这样的SOAP客户端，也可以使用自己开发的SOAP客户端，然后把它和应用程序连接起来。不仅缩短了开发周期，还减少了代码复杂度，并能够增强应用程序的可维护性。同时，应用程序也不再需要在每次调用中间层组件时，都跳转到相应的“结果页”。

从经验来看，在一个用户界面和中间层有较多交互的应用程序中，使用WebService这种结构，可以节省花在用户界面编程上20%的开发时间。另外，这样一个由WebService组成的中间层，完全可以在应用程序集成或其它场合下重用。最后，通过WebService把应用程序的逻辑和数据“暴露”出来，还可以让其它平台上的客户重用这些应用程序。

长项二：应用程序集成

企业级的应用程序开发者都知道，企业里经常都要把用不同语言写成的、在不同平台上运行的各种程序集成起来，而这种集成将花费很大的开发力量。应用程序经常需要从运行在IBM主机上的程序中获取数据；或者把数据发送到主机或UNIX应用程序中去。即使在同一个平台上，不同软件厂商生产的各种软件也常常需要集成起来。通过WebService，应用程序可以用标准的方法把功能和数据“暴露”出来，供其它应用程序使用。

例如，有一个订单登录程序，用于登录从客户来的新订单，包括客户信息、发货地址、数量、价格和付款方式等内容；还有一个订单执行程序，用于实际货物发送的管理。这两个程序来自不同软件厂商。一份新订单进来之后，订单登录程序需要通知订单执行程序发送货物。通过在订单执行程序上面增加一层WebService，订单执行程序可以把“AddOrder”函数“暴露”出来。这样，每当有新订单到来时，订单登录程序就可以调用这个函数来发送货物了。

长项三：B2B的集成

用WebService集成应用程序，可以使公司内部的商务处理更加自动化。但当交易跨越供应商和客户、突破公司的界限时会怎么样呢？跨公司的商务交易集成通常叫做B2B集成。

WebService是B2B集成成功的关键。通过WebService，公司可以把关键的商务应用“暴露”给指定的供应商和客户。例如，把电子下单系统和电子发票系统“暴露”出来，客户就可以以电子的方式发送订单，供应商则可以以电子的方式发送原料采购发票。当然，这并不是一个新的概念，EDI(电子文档交换)早就是这样了。但是，WebService的实现要比EDI简单得多，而且WebService运行在Internet上，在世界任何地方都可轻易实现，其运行成本就相对较低。不过，WebService并不像EDI那样，是文档交换或B2B集成的完整解决方案。WebService只是B2B集成的一个关键部分，还需要许多其它的部分才能实现集成。

　　用WebService来实现B2B集成的最大好处在于可以轻易实现互操作性。只要把商务逻辑“暴露”出来，成为WebService，就可以让任何指定的合作伙伴调用这些商务逻辑，而不管他们的系统在什么平台上运行，使用什么开发语言。这样就大大减少了花在B2B集成上的时间和成本，让许多原本无法承受EDI的中小企业也能实现B2B集成。

长项四：软件和数据重用

软件重用是一个很大的主题，重用的形式很多，重用的程度有大有小。最基本的形式是源代码模块或者类一级的重用，另一种形式是二进制形式的组件重用。

当前，像表格控件或用户界面控件这样的可重用软件组件，在市场上都占有很大的份额。但这类软件的重用有一个很大的限制，就是重用仅限于代码，数据不能重用。原因在于，发布组件甚至源代码都比较容易，但要发布数据就没那么容易，除非是不会经常变化的静态数据。

WebService在允许重用代码的同时，可以重用代码背后的数据。使用WebService，再也不必像以前那样，要先从第三方购买、安装软件组件，再从应用程序中调用这些组件；只需要直接调用远端的WebService就可以了。举个例子，要在应用程序中确认用户输入的地址，只需把这个地址直接发送给相应的WebService，这个WebService就会帮你查阅街道地址、城市、省区和邮政编码等信息，确认这个地址是否在相应的邮政编码区域。WebService的提供商可以按时间或使用次数来对这项服务进行收费。这样的服务要通过组件重用来实现是不可能的，那样的话你必须下载并安装好包含街道地址、城市、省区和邮政编码等信息的数据库，而且这个数据库还是不能实时更新的。

另一种软件重用的情况是，把好几个应用程序的功能集成起来。例如，要建立一个局域网上的门户站点应用，让用户既可以查询联邦快递包裹，查看股市行情，又可以管理自己的日程安排，还可以在线购买电影票。现在Web上有很多应用程序供应商，都在其应用中实现了这些功能。一旦他们把这些功能都通过WebService“暴露”出来，就可以非常容易地把所有这些功能都集成到你的门户站点中，为用户提供一个统一的、友好的界面。

将来，许多应用程序都会利用WebService，把当前基于组件的应用程序结构扩展为组件/WebService的混合结构，可以在应用程序中使用第三方的WebService提供的功能，也可以把自己的应用程序功能通过WebService提供给别人。两种情况下，都可以重用代码和代码背后的数据。

从以上论述可以看出，WebService在通过Web进行互操作或远程调用的时候是最有用的。不过，也有一些情况，WebService根本不能带来任何好处。

短处一：单机应用程序

　　目前，企业和个人还使用着很多桌面应用程序。其中一些只需要与本机上的其它程序通信。在这种情况下，最好就不要用WebService，只要用本地的API就可以了。COM非常适合于在这种情况下工作，因为它既小又快。运行在同一台服务器上的服务器软件也是这样。最好直接用COM或其它本地的API来进行应用程序间的调用。当然WebService也能用在这些场合，但那样不仅消耗太大，而且不会带来任何好处。

短处二：局域网的同构应用程序

在许多应用中，所有的程序都是用VB或VC开发的，都在Windows平台下使用COM，都运行在同一个局域网上。例如，有两个服务器应用程序需要相互通信，或者有一个Win32或WinForm的客户程序要连接局域网上另一个服务器的程序。在这些程序里，使用DCOM会比SOAP/HTTP有效得多。与此相类似，如果一个.NET程序要连接到局域网上的另一个.NET程序，应该使用.NETremoting。有趣的是，在.NETremoting中，也可以指定使用SOAP/HTTP来进行WebService调用。不过最好还是直接通过TCP进行RPC调用，那样会有效得多。

webservice传递的数据只能是序列化的数据,典型的就是xml数据,这里我们也只讨论xml数据的传输。

有了一些对xml webservice的初步了解后,我们将切入正题,即是用一个具体的webservice事例的形式来讲解具体的webservice用法,用具体的事例来讲解一个概念我想怎么也要比单纯的说理能让人容易理解吧.

      这里,我们将以一个简单的分布式课件搜索系统为例来讲解.使用VS2005为编译环境,C#为语言,SqlServcer2000为数据库.

      首先,明确我们要做什么.我们需要一个对客户的接口,也就是个站点,我们把它称做usewebserviceA,它是何种形式都无所谓,甚至它本身并不需要数据库,它只是提供给用户一个查询的接口,真正的服务,普通用户是不接触到的.然后,这里我们还需要若干个提供服务的站点,我们可以称它们为资源站,这里为简单起见,假设有两个资源站,分别叫webserviceA,webserviceB,它们可以是不对外公布的,只是为了丰富查询数据而存在.最后,是我们最需要关注的东西---资源站提供给usewebserviceA的服务.两个资源站,就有两个服务,我们称为webserviceA和webserviceB.两个服务间没有任何关系,内部提供的方法也完全没关联,只是需要把方法如何使用告诉usewebservicA,意思是,服务只提供查询接口,返回的数据如何处理,服务本身并不管,全由使用服务的站点分配.

       写了这么多,算是简要的介绍了下有关xml webservice

 在VS2005中,开发一个webservice并不是件困难的事,首先,我们新建一个webservice项目(文件->新建->网站->ASP.NET WEB服务)

      建完这个工程,我们将看到一个叫Service.asmx的文件,这就是webservice的标准文件,它也有UI的概念,不过我们一般不关注,因此,我们查看其cs代码文件.如果你什么都还没做的话,将看见一个被注释掉的helloworld的WebMethod,把注释去掉,在运行,你就可以得到最简单的webservice运行实例了.点击"helloworld"将执行其方法.显然,这个函数对我们的意义只在于宏观的了解了下web服务的写法.

     下面,我们将开始具体介绍webservice的写法.在代码文件里,如果我们写了一个函数后,希望此函数成为外部可调用的接口函数,我们必须在函数上面添上一行代码[WebMethod(Description="函数的描述信息")],如果你的函数没有这个申明,它将不能被用户引用.如:

[WebMethod(Description="最简单的方法")]
public string HelloWorld()
{
   return "Hello World";
}

     这个函数就是外部可调用的接口函数,对用户来说相当于一个API.如果某用户在引用了这个服务后,他调用HelloWorld()方法,他就将获得"HelloWorld"这个返回值.

API (Application Programming Interface)

所谓API本来是为C和C++程序员写的。API说来说去，就是一种函数，他们包含在一个附加名为DLL的动态连接库文件中。用标准的定义来讲，API就是Windows的32位应用程序编程接口，是一系列很复杂的函数，消息和结构，它使编程人员可以用不同类型的编程语言编制出的运行在Windows95 和Windows NT操作系统上的应用程序。

       看到这里,我们是不是发现,其实webservice并不是那么的神秘,它也不过只是个接口,对我们而言,侧重点依然是接口函数的编写.下面,我将给出我们的例子所需要的接口函数.

public class Service : System.Web.Services.WebService

{

AdoNetCon anc = new AdoNetCon(ConfigurationSettings.AppSettings["ZWOAConnectionString"]);

//这是我写的一个类，用来操作数据库

    public Service () {

        //如果使用设计的组件，请取消注释以下行

        //InitializeComponent();

    }

 

    [WebMethod(Description="hello method")]

    public string HelloWorld() {

        return "Hello World";

    }

 

    [WebMethod(Description = "获取需要的信息")]

    public XmlDataDocument GetSiteAData()

    {

        DataSet ds = new DataSet();

        try

        {

            ds = anc.RunProc("select car_id,car_chePai,car_trademark from [zw_db].[dbo].tb_car",ds);

            XmlDataDocument xd = new XmlDataDocument(ds);

            return xd;

        }

        catch

        {

            //System.Web.HttpContext.Current.Response.Write("Error!");

            return null;

        }

    }

 

    [WebMethod(Description = "查询获取需要的信息")]

    public XmlDataDocument getCar(string car_id,string car_chePai)

    {

        DataSet ds = new DataSet();

        try

        {

            string sql;

            sql = "select car_id,car_chePai,car_trademark from [zw_db].[dbo].tb_car where 1=1";

            if ((car_id == null) || (car_id.Length == 0))

                ;

            else

                sql = sql +" and car_id =" + "'" + car_id + "'";

            if ((car_chePai == null) || (car_chePai.Length == 0))

                ;

            else

                sql = sql + " and car_chePai like " + "'%" + car_chePai + "%'";

            ds = anc.RunProc(sql, ds);

            XmlDataDocument xd = new XmlDataDocument(ds);

            return xd;

        }

        catch

        {

            //System.Web.HttpContext.Current.Response.Write("Error!");

            return null;

        }

    }

 

    [WebMethod(Description = "insert")]

    public bool addCar(string car_chePai)

    {

        try

         {

            string sql;

            sql = "insert into [zw_db].[dbo].tb_car(car_chePai) values(" + "'" + car_chePai + "'" + ")";

            if ((car_chePai == null) || (car_chePai.Length == 0))

                return false;

            else

             {

                anc.RunProc(sql);

                return true;

            }

        }

        catch

        {

            //System.Web.HttpContext.Current.Response.Write("Error!");

            return false;

        }

    }

 

}

这是获取资源站点信息的一个接口函数.里面大部分的代码,我想对于有一定asp.net基础的朋友来说,都应该是一看就明白。

细心的朋友可能会发现这个函数的返回类型似乎比较特殊,是个xml的文档.我们在前面已经说过,webservice只能传输序列化数据,xml显然满足条件,但比如hash表之类的非序列化数据,是不能传输的,xml使用最为广泛,而且考虑到跨平台应用,所以这里我们只以xml数据的传输来示例.

我们先简单解释下GetSiteAData()函数.

      函数功能很简单,只是要返回查询结果,其数据格式是XmlDataDocument.当查询失败时(无匹配查询结果)，返回一个空记录.否则,我们把查询后的dataset生成一个XmlDataDocument,接下来,由于该项目的需要,我加入了一个循环,添加dataset里所没有的节点,站点名称.在这之后,算是完成了一个符合我们期望格式的xml数据文档,我们把它返回.

       好了,webservice的方法函数介绍完了(这里还有个web服务方法,稍后介绍),接下来我们的任务是怎么调用它了.首先把webservice的项目编译完成,假定我们这个服务是针对资源站点A的,我们不妨称其为ServiceA.先单独运行asmx文件,执行GetSiteAData()方法,将提示你输入参数,你输入要搜索的内容,点确认,将返回给你一个xml数据,并在ie上显示出来,这就是你搜索到的内容拉.

        这里对ServiceA的工作再做点介绍,在我们这个项目里,它是资源站点A提供的服务,意思是,它查询的数据将全来源于站点A,而站点A资源添加在本项目也有专门的工程实现.

        好了,回到正题.这里我介绍vs调用webservice的方法,其实其他平台的调用方法也是大同小异.首先我们介绍web引用方式,这种方式我强烈建议调试时使用,非常方便.右击引用,点添加web引用,输入你的webservice地址,你必须保证你输入的webservice存在.然后引用即可,注意:web引用名将作为你加入的webservice的名字空间.比如你输入了: localhost,那服务的实例化将是这样: localhost.Service1 serviceA=new localhost.Service1();(Service1是服务的类名).

      完成了这一步,service的调用似乎变的那么简单,我们已经实现了远程实例化,接下来的远程调用也是一样的容易.下面给出资源采集站ServiceGatherSite的绑定代码(只采集A站点的信息)

XmlDataDocument xd = new XmlDataDocument();

    DataSet ds = new DataSet();

    protected void Page_Load(object sender, EventArgs e)

    {

        localhost.Service ge = new localhost.Service();

        XmlNode xmlNode1;

        XmlDataDocument xd = new XmlDataDocument();

        StringBuilder xmlString1;

        xmlNode1 = ge.GetSiteAData();

        if (xmlNode1 == null) //--存储过程执行失败

            return;

        xmlString1 = new StringBuilder(xmlNode1.OuterXml);

        if (xmlString1.ToString().Equals("<NewDataSet xmlns=\"\"></NewDataSet>"))

            return;

        xd.LoadXml(xmlString1.ToString());

        ds.ReadXml(new XmlNodeReader(xd));

        GridView1.DataSource = ds.Tables[0].DefaultView;

        GridView1.DataBind()；}

此段代码给出了xml转化成dataset的解决方案,虽然这不是必须的,但毕竟在asp.net里,dataset占的作用之重,谁都知道的.其他的请朋友们先看(呵呵,个中高手就免了)

接上篇文章,我们先简单说明下绑定函数.首先实例化ServiceA,这个和一般类的实例化并没有不同.接下来用xmlNode1来接受函数的返回值,接下来是构造xml,并将其转化为dataset,这是通用的方法,如果是刚接触不久的朋友,最好能记下这种方法.

      接下来给出异步调用两个服务的代码(这个我也没有做，呵呵，就全用前人的代码了)

//绑定数据
   public void BindData()
   {
    IAsyncResult ar1;
    IAsyncResult ar2;
    serviceA=new SiteA.Service1();
    serviceB=new SiteB.Service1();
    DataSet ds=new DataSet();
    XmlNode xmlNode1,xmlNode2;
    XmlDataDocument xd=new XmlDataDocument();
    StringBuilder xmlString1,xmlString2;
    //--简单的异步调用
    ar1=serviceA.BeginGetSiteAData(strSearch,null,null);
    ar2=serviceB.BeginGetSiteAData(strSearch,null,null);　
    xmlNode1=serviceA.EndGetSiteAData(ar1);
    xmlNode2=serviceB.EndGetSiteAData(ar2);
    //----------
    if(xmlNode1==null&&xmlNode2==null) //--存储过程执行失败
     return;

    xmlString1=new StringBuilder(xmlNode1.OuterXml);
    xmlString2=new StringBuilder(xmlNode2.OuterXml);
   xmlString1=MakeNewXmlString(xmlString1,xmlString2); //生成新的xml
    if(xmlString1.ToString().Equals("<NewDataSet xmlns=\"\"></NewDataSet>"))
     return ;
    xd.LoadXml(xmlString1.ToString());
    ds.ReadXml(new XmlNodeReader(xd));
    DataGrid1.DataSource=ds.Tables[0].DefaultView;
    DataGrid1.DataBind();
   }

   //生成新XML
   public StringBuilder MakeNewXmlString(StringBuilder str1,StringBuilder str2)
   {
    str1=str1.Replace("</NewDataSet>","");
    str2=str2.Replace("<NewDataSet xmlns=\"\">","");
    str1.Append(str2.ToString());
    return str1;
   }

这有两个需要注意的地方,一个是xml构造,还有就是异步调用的实现,请读者,自己理解

下面讲下通过dll来引用webservice的方法,我只把流程介绍下.

首先,在ie输入服务的地址,如:http://www.xxx.com/service.asmx

然后写输入http://www.xxx.com/service.asmx?wsdl

打开后,另存为xxx.wsdl

然后用vs的命令提示符来编译:wsdl /namespace:SiteA ServiceA.ws

生成名字空间为sitea的代理类

最后csc /out:ServiceA.dll /t:library Service1.cs ,其中service1.cs为代理类文件

最后引用dll就可以了。