知识大全 XML WebService完全实例详细解析

Posted 2022-07-17 函数

篇首语：最是人间留不住，朱颜辞镜花辞树。本文由小常识网(cha138.com)小编为大家整理，主要介绍了知识大全 XML WebService完全实例详细解析相关的知识，希望对你有一定的参考价值。

XML WebService完全实例详细解析 以下文字资料是由(全榜网网www.cha138.com)小编为大家搜集整理后发布的内容，让我们赶快一起来看一下吧！

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

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

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

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

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

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

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

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

　　在VS 中开发一个webservice并不是件困难的事首先我们新建一个webservice项目（文件 >新建 >项目 >C# >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 这个返回值

　　看到这里我们是不是发现其实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 AssignName); 　　cp AddParOut( @res SqlDbType Int); 　　if(cp SelectProc()) //如果执行成功存储过程　　　　cp myData EnforceConstraints=false; //不进行格式严格检查　　if((int)cp GetReturnValue( @res )== ) 　　　　string xml= ; 　　xd LoadXml(xml); 　　return xd; 　　　　xd=new XmlDataDocument(cp myData); 　　XmlNode root =xd DocumentElement; 　　XmlNodeList roots=root 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; 　　

　　这是获取资源站点信息的一个接口函数里面大部分的代码我想对于有一定基础的朋友来说都应该是一看就明白这里只说明下CStoreProc 这是我封装的一个存储过程类主要功能是执行各种类型的存储过程

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

　　[NextPage]

　　接上篇文章我们先简单解释下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地址如 //localhost/aspxproject/WebServiceSolution/SiteBService/service asmx 你必须保证你输入的webservice存在然后引用即可注意 web引用名将作为你加入的webservice的名字空间比如你输入了 SiteA 那服务的实例化将是这样 SiteA Service serviceA=new SiteA Service （）（Service 是服务的类名）

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

　　//绑定数据　　public void BindData() 　　　　serviceA=new SiteA Service (); 　　DataSet ds=new DataSet(); 　　XmlNode xmlNode ; 　　XmlDataDocument xd=new XmlDataDocument(); 　　StringBuilder xmlString ; 　　xmlNode =serviceA GetSiteAData(strSearch); 　　if(xmlNode ==null) // 存储过程执行失败　　return; 　　xmlString =new StringBuilder(xmlNode OuterXml); 　　if(xmlString ToString() Equals( )) 　　return ; 　　xd LoadXml(xmlString ToString()); 　　ds ReadXml(new XmlNodeReader(xd)); 　　DataGrid DataSource=ds Tables[ list ] DefaultView; 　　DataGrid DataBind(); 　　

　　此段代码给出了xml转化成dataset的解决方案虽然这不是必须的但毕竟在里 dataset占的作用之重谁都知道的其他的请朋友们先看（呵呵个中高手就免了）在下篇文章中将会有对它的一些解释与及多服务分布调用的解决方案写了三篇了发现似乎还是有些朋友看的那我就献丑继续写下去好了大家有什么意见也希望提出在下的理解存在偏驳也再所难免希望谅解）

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

　　接下来给出异步调用两个服务的代码

　　//绑定数据　　public void BindData() 　　　　IAsyncResult ar ; 　　IAsyncResult ar ; 　　serviceA=new SiteA Service (); 　　serviceB=new SiteB Service (); 　　DataSet ds=new DataSet(); 　　XmlNode xmlNode xmlNode ; 　　XmlDataDocument xd=new XmlDataDocument(); 　　StringBuilder xmlString xmlString ; 　　// 简单的异步调用　　ar =serviceA BeginGetSiteAData(strSearch null null); 　　ar =serviceB BeginGetSiteAData(strSearch null null); 　　xmlNode =serviceA EndGetSiteAData(ar ); 　　xmlNode =serviceB EndGetSiteAData(ar ); 　　// 　　if(xmlNode ==null&&xmlNode ==null) // 存储过程执行失败　　return; 　　xmlString =new StringBuilder(xmlNode OuterXml); 　　xmlString =new StringBuilder(xmlNode OuterXml); 　　xmlString =MakeNewXmlString(xmlString xmlString ); //生成新的xml 　　if(xmlString ToString() Equals( )) 　　return ; 　　xd LoadXml(xmlString ToString()); 　　ds ReadXml(new XmlNodeReader(xd)); 　　DataGrid DataSource=ds Tables[ list ] DefaultView; 　　DataGrid DataBind(); 　　　　//生成新XML 　　public StringBuilder MakeNewXmlString(StringBuilder str StringBuilder str ) 　　　　str =str Replace( ); 　　str =str Replace( ); 　　str Append(str ToString()); 　　return str ; 　　

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

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

　　首先在ie输入服务的地址如

　　然后写输入？wsdl

　　打开后另存为xxx wsdl

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

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

　　最后csc /out ServiceA dll /t library Service cs 其中service cs为代理类文件

cha138/Article/program/net/201311/13199