XML WebService实例详细解析

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

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

　　这里,我们将以一个简单的分布式课件搜索系统为例来讲解.使用VS2003为编译环境,C#为语言,SqlServcer2000为数据库.(这个例子来 源于一位网上朋友的文章的启发,觉得很能代表webService的特点,就按那个想法做了这么个系统来示例了)

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

　　写了这么多,算是简要的介绍了下有关XML webService的概念和我们这个例子的结构,下篇文章,我们将开始真正进入代码的设计阶段.

　　上篇文章介绍了些webService的基本特性和我们例子的结构,这篇文章我们将开始具体的代码编写工作.

　　这个专题主要讲述的是webService,因此这里我们的代码以webService相关为主,而其他工程,例如:ServiceGatherSite,webSiteA等,只将简略介绍.

　　在VS2003中,开发一个webService并不是件困难的事,首先,我们新建一个webService项目(文件->新建->项目->C#->web服务应用程序)

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

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

    以下是引用片段：

 

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

 

　　这个函数就是外部可调用的接口函数,对用户来说相当于一个API.如果某用户在引用了这个服务后,他调用HelloWorld()方法,他就将获得"HelloWorld"这个返回值.
　　看到这里,我们是不是发现,其实webService并不是那么的神秘,它也不过只是个接口,对我们而言,侧重点依然是接口函数的编写.下面,我将给出我们的例子所需要的接口函数.

 

 　 [webMethod(Description="查询以获取需要的课件信息")]　　public XMLDataDocument GetSiteAData(string AssignName)　　{　　XMLDataDocument xd=new XMLDataDocument(); //　　DataSet ds=new DataSet();　　CStoreProc cp=new CStoreProc("SearchAssign");　　cp.AddParIn("@keywords",SqlDbType.VarChar,30,AssignName);　　cp.AddParOut("@res",SqlDbType.Int);　　if(cp.SelectProc()) //如果执行成功,存储过程　　{　　cp.myData.EnforceConstraints=false; //不进行格式严格检查　　if((int)cp.GetReturnValue("@res")==-1)　　{　　string XML="";　　xd.LoadXML(XML);　　return xd;　　}　　xd=new XMLDataDocument(cp.myData);　　XMLNode root1=xd.DocumentElement;　　XMLNodeList roots=root1.SelectNodes("list");　　foreach(XMLNode roota in roots) //为所有元素加上站点名称标记　　{　　XMLElement Link=xd.CreateElement("SiteName");　　Link.InnerText=ConfigurationSettings.AppSettings["SiteName"].ToString();　　roota.AppendChild(Link);　　}　　return xd;　　}　　else return null;　　}

  这是获取资源站点信息的一个接口函数.里面大部分的代码,我想对于有一定asp.net基础的朋友来说,都应该是一看就明白,这里只说明下CStoreProc,这是我封装的一个存储过程类,主要功能是执行各种类型的存储过程.
　　细心的朋友可能会发现这个函数的返回类型似乎比较特殊,是个XML的文档.我们在前面已经说过,webService只能传输序列化数据,XML显然满足 条件,但比如hash表之类的非序列化数据,是不能传输的,XML使用最为广泛,而且考虑到跨平台应用,所以这里我们只以XML数据的传输来示例.

　　接上篇文章,我们先简单解释下GetSiteAData(string AssignName)函数.

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

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

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

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

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

    以下是引用片段：

 　　//绑定数据　　public void BindData()　　{　　ServiceA=new SiteA.Service1();　　DataSet ds=new DataSet();　　XMLNode XMLNode1;　　XMLDataDocument xd=new XMLDataDocument();　　StringBuilder XMLString1;　　XMLNode1=ServiceA.GetSiteAData(strSearch);　　if(XMLNode1==null) //--存储过程执行失败　　return;　　XMLString1=new StringBuilder(XMLNode1.OuterXML);　　if(XMLString1.ToString().Equals(""))　　return ;　　xd.LoadXML(XMLString1.ToString());　　ds.ReadXML(new XMLNodeReader(xd));　　DataGrid1.DataSource=ds.Tables["list"].DefaultView;　　DataGrid1.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(""))　　return ;　　xd.LoadXML(XMLString1.ToString());　　ds.ReadXML(new XMLNodeReader(xd));　　DataGrid1.DataSource=ds.Tables["list"].DefaultView;　　DataGrid1.DataBind();　　}　　//生成新XML　　public StringBuilder MakeNewXMLString(StringBuilder str1,StringBuilder str2)　　{　　str1=str1.Replace("","");　　str2=str2.Replace("","");　　str1.Append(str2.ToString());　　return str1;　　} 　　//绑定数据

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

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

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

　　　打开后,另存为xxx.wsdl

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

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

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

　　最后引用dll就可以了.