XML WebService完全实例详细解析

首先 我们必须了解什么是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 a *** x的文件 这就是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 DocumentElementXmlNodeList 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 先单独运行a *** x文件 执行GetSiteAData （string AssignName）方法 将提示你输入参数 你输入要搜索的内容 点确认 将返回给你一个xml数据 并在ie上显示出来 这就是你搜索到的内容拉

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

好了 回到正题 这里我介绍vs调用webservice的方法 其实其他平台的调用方法也是大同小异 首先我们介绍web引用方式 这种方式我强烈建议 调试时使用 非常方便 右击引用 点添加web引用 输入你的webservice地址 如 //localhost/aspxproject/WebServiceSolution/SiteBService/service a *** x 你必 须保证你输入的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) // 存储过程执行失败 returnxmlString =new StringBuilder(xmlNode OuterXml)if(xmlString ToString() Equals( )) return xd LoadXml(xmlString ToString())ds ReadXml(new XmlNodeReader(xd))DataGrid DataSource=ds Tables[ list ] DefaultViewDataGrid 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) // 存储过程执行失败 returnxmlString =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 ] DefaultViewDataGrid 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为代理类文件

lishixinzhi/Article/program/net/201311/13199

解析xml文件时首先获取到一个的实例是

在网络上传输的数据是格式化后的数据，这种数据会有一定的结构规格和语义，当另一方收到数据消息之后就可以按照相同的结构规格进行解析，从而取出他想要的那部分内容。

最常用的格式有两种:XML和JSON.

· 解析XML格式的数据有多种方式，这里介绍两种：Pull解析和SAX解析。

比起XML，JSON的主要优势在于它的体积更小，在网络上传输的时候更省流量。缺点在于，它的语义较差，看起来不如XML直观。（代码量更少）

· 解析JSON数据的方法有多种方法，可以使用官方提供的JSONObject，也可以使用谷歌的开源库GSON，另外，第三方开源库如Jackson,FastJson等也非常不错。

XML（eXtensible Markup Language可扩展标志语言）在近几年的信息类杂志 网站上可谓是最抢眼的一词 大大小小的信息产品都争相和它搭上关系 唯恐赶不及这辆快车 有着良好口碑的宝蓝（Borland)系列开发平台也不例外 从 版开始就集成了XML组件包 因其使用MSXMLDom解析器 相比于此前广泛应用的XMLParser解析器 MSXMLDom更显规范 中文兼容性更好（元素名 属性名均支持中文） 很受开发者青睐 为帮助初学者快速掌握Delphi中的XML编程 笔者特写此文 以供交流

笔者通过一个读写XML文件的实例来说明XML编程的各个步骤 只需读者有结点 元素 属性的基本概念就能容易的理解本文 笔者所要读入的XML文件结构如下所示 命名为Input xml

<学生花名册>

<学生 性别 = 男 >

<姓名>李华

<年龄>

<电话>

<学生 性别 = 男 >

<姓名>张三

<年龄>

<电话>

Input xml文件的第一行是XML的版本说明 属性encoding宣告使用何种字符集建立 默认以Unicode 编码（UTF 或UTF ） 这里用中文GB 码 第二行 <学生花名册>是根元素 下面定义了两个学生元素 学生下面嵌套了三个子元素 是对学生的进一步说明 与之相对应的 我们在Delphi中定义如下的学生数据结构 // 后面的文字是对变量或语句的说明 下同

TStudent = class {学生}

sex : string//学生性别

name : string//学生姓名

age : integer//学生年龄

phone: string//电话号码

end

为了读写 我们需要放置两个TXMLDocument控件 在Delphi VCL面板的Internet标签页里那个标有XML字样的控件就是 当然此控件也可以动态创建 但需要包含必要的文件 这里为简单起见 我们直接放置在窗体上 分别命名为InXMLDoc和OutXMLDoc InXMLDoc用于调入Input xml文件 OutXMLDoc用于暂存输出到Output xml的文档

在窗体上放个按钮 我们把测试代码直接放置在按钮的单击事件里 先定义几个变量 用来保存临时信息 如下所示

Root : IXMLNode//指向XML根结点

Parent_Node: IXMLNode//指向学生结点

Child_node : IXMLNode//指向学生的子结点

Student : TStudent//存单个学生信息

List : TList//存学生列表

i : integer//循环变量

我们先来读入XML文件 代码如下

List := TList Create//初始化列表

InXMLDoc LoadFromFile( Input xml )//调入Input xml文件

Root := InXMLDoc DocumentElement//取XML文件的根结点 即 <学生花名册>

Parent_Node := Root ChildNodes First//使Parent_Node指向学生结点

while (Parent_Node <>nil) do //循环取多个学生 可再多加几个学生信息测试

begin

if (Parent_Node NodeName = 学生 ) then //判断是否为学生结点

begin

Student := TStudent Create//新建一个学生的结构信息

Student sex := Parent_Node Attributes[ 性别 ]//取学生的性别属性

Child_Node := Parent_Node ChildNodes First

//使Child_Node指向该学生的第一个子结点信息

while (Child_Node <>nil) do //循环取学生的各个子各点

begin

if (Child_Node NodeName = 姓名 ) then //判断是否为姓名结点

Student name := Child_Node Text //取姓名结点的值 取于name字段中

else if (Child_Node NodeName = 年龄 ) then //此行起后四行与前两行类似

Student age := StrToInt(Child_Node Text)

else if (Child_Node NodeName = 电话 ) then

Student phone := Child_Node Text

Child_Node := Child_Node NextSibling//顺序取下一个学生的子结点信息

end

List Add(Student)//把一个学生信息加入列表

end

Parent_Node := Parent_Node NextSibling//顺序取下一个学生信息

end

到这儿 所有的学生信息都已存到List列表里面了 读者可以跟踪代码测试

下面我们把List里的临时学生信息存到Output xml文件里 代码如下

OutXMLDoc Active := true//激活OutXMLDoc 自动初始化空的XML文档

OutXMLDoc Encoding := GB //设置字符集

Root := OutXMLDoc AddChild( 学生花名册 )//建根结点

for i := to List Count do //循环取各个学生信息

begin

Student := List Items[i]//顺序取一个学生信息

if (Student <>nil) then

begin

Parent_Node := Root AddChild( 学生 )//根结点后添加一个学生结点

Parent_Node Attributes[ 性别 ] := Student sex//给学生结点设置性别属性

Child_Node := Parent_Node AddChild( 姓名 )//学生结点后添加一个姓名结点

Child_Node Text := Student name//设置姓名的文本值

Child_Node := Parent_Node AddChild( 年龄 )//此行起后四行与前两行类似

Child_Node Text := IntToStr(Student age)

Child_Node := Parent_Node AddChild( 电话 )

Child_Node Text := Student phone

end

end

OutXMLDoc SaveToFile( Output xml )//把组织好的XML文档存于Output xml文件中

OutXMLDoc Active := false//钝化（关闭）OutXMLDoc

List Free//最后释放保存临时学生信息的列表

lishixinzhi/Article/program/Delphi/201311/24984

---