你的位置:首页 > ASP.net教程

[ASP.net教程]搭建调用 WebService 的 ASP.NET 网站 (VS2010, C#)


【系统环境】Windows 7 / 2008r2

【软件环境】Visual Studio 2010

【开发语言】C#

【感谢】本文是在 《C#开发和调用Web Service》 一文的基础上做了少许修改及补充后整理所得。

1. WebService

1.1 基本概念

Web Service也叫


Soap:(Simple Object Access Protocol)简单对象存取协议。是
WSDL:(Web Services Description Language) WSDL 文件是一个
UDDI (Universal Description, Discovery, and Integration) 是一个主要针对Web服务供应商和使用者的新项目。在用户能够调用Web服务之前,必须确定这个服务内包含哪些商务方法,找到被调用的接口定义,还要在服务端来编制软件,UDDI是一种根据描述文档来引导系统查找相应服务的机制。UDDI利用SOAP消息机制(标准的

Web Service的工作原理:http://www.cnblogs.com/Jessy/p/3528341.html

1.2 特点

Web Service的主要目标是跨平台的可互操作性。为了实现这一目标,Web Service 完全基于

1.跨防火墙的通信

如果应用程序有成千上万的用户,而且分布在世界各地,那么客户端和服务器之间的通信将是一个棘手的问题。因为客户端和服务器之间通常会有防火墙或者代理服务器。传统的做法是,选择用浏览器作为客户端,写下一大堆ASP页面,把应用程序的中间层暴露给最终用户。这样做的结果是开发难度大,程序很难维护。要是客户端代码不再如此依赖于HTML表单,客户端的编程就简单多了。如果中间层组件换成Web Service的话,就可以从用户界面直接调用中间层组件,从而省掉建立ASP页面的那一步。要调用Web Service,可以直接使用Microsoft SOAP Toolkit或.net这样的SOAP客户端,也可以使用自己开发的SOAP客户端,然后把它和应用程序连接起来。不仅缩短了开发周期,还减少了代码复杂度,并能够增强应用程序的可维护性。同时,应用程序也不再需要在每次调用中间层组件时,都跳转到相应的“结果页”。

2.应用程序集成

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

3.B2B的集成

B2B 指的是Business to Business,as in businesses doing business with other businesses,商家(泛指企业)对商家的电子商务,即企业与企业之间通过互联网进行产品、服务及信息的交换。通俗的说法是指进行电子商务交易的供需双方都是商家(或企业、公司),她们使用了Internet的技术或各种商务网络平台,完成商务交易的过程。

Web Service是B2B集成成功的关键。通过Web Service,公司可以只需把关键的商务应用“暴露”给指定的供应商和客户,就可以了,Web Service运行在Internet上,在世界任何地方都可轻易实现,其运行成本就相对较低。Web Service只是B2B集成的一个关键部分,还需要许多其它的部分才能实现集成。用Web Service来实现B2B集成的最大好处在于可以轻易实现互操作性。只要把商务逻辑“暴露”出来,成为Web Service,就可以让任何指定的合作伙伴调用这些商务逻辑,而不管他们的系统在什么平台上运行,使用什么开发语言。这样就大大减少了花在B2B集成上的时间和成本。

4.软件和数据重用

Web Service在允许重用代码的同时,可以重用代码背后的数据。使用Web Service,再也不必像以前那样,要先从第三方购买、安装软件组件,再从应用程序中调用这些组件;只需要直接调用远端的Web Service就可以了。另一种软件重用的情况是,把好几个应用程序的功能集成起来,通过Web Service “暴露”出来,就可以非常容易地把所有这些功能都集成到你的门户站点中,为用户提供一个统一的、友好的界面。可以在应用程序中使用第三方的Web Service 提供的功能,也可以把自己的应用程序功能通过Web Service 提供给别人。两种情况下,都可以重用代码和代码背后的数据。


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

1.单机应用程序

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

2.局域网的一些应用程序

在许多应用中,所有的程序都是在Windows平台下使用COM,都运行在同一个局域网上。在这些程序里,使用DCOM会比SOAP/HTTP有效得多。与此相类似,如果一个.NET程序要连接到局域网上的另一个.NET程序,应该使用.NET Remoting。其实在.NET Remoting中,也可以指定使用SOAP/HTTP来进行Web Service 调用。不过最好还是直接通过TCP进行RPC调用,那样会有效得多。


1.3 WebService的应用

1.最初的

2.以

例如,用户可以开发一个采购应用程序,以自动获取来自不同供应商的价格信息,从而使用户可以选择供应商,提交订单,然后跟踪货物的运输,直至收到货物。而供应商的应用程序除了在Web上提供服务外,还可以使用

2. Web Service开发

.NET平台内建了对Web Service的支持,包括Web Service的构建和使用。与其它开发平台不同,使用.NET平台,你不需要其他的工具或者SDK就可以完成Web Service的开发了。.NET Framework本身就全面支持WebService,包括服务器端的请求处理器和对客户端发送和接受SOAP消息的支持。下来我们就一步一步的用Microsoft Visual Studio .NET 2010(后面简称VS.NET 2010)创建和使用一个简单的Web Service。

2.1 创建一个最简单的WebService

首先,打开VS2010,打开“文件-新建-网站”,选择“ASP.NET Web服务”。

1. 如果选用的 .NET Framework 4,选择 ASP.NET 空网站,如下图所示。

我们将项目文件夹命名为WebServiceTest,即上图中的WebSite1修改为WebServiceTest,新建生成的项目目录结构如下图所示。

查看Service.cs代码,你会发现VS.Net 2005已经为Web Service文件建立了缺省的框架。原始代码如下。

 1 using System; 2 using System.Collections.Generic; 3 using System.Linq; 4 using System.Web; 5 using System.Web.Services; 6  7 [WebService(Namespace = "http://tempuri.org/")] 8 [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)] 9 // 若要允许使用 ASP.NET AJAX 从脚本中调用此 Web 服务,请取消对下行的注释。 10 // [System.Web.Script.Services.ScriptService]11 12 public class Service : System.Web.Services.WebService13 {14   public Service () {15 16     //如果使用设计的组件,请取消注释以下行 17     //InitializeComponent(); 18   }19 20   [WebMethod]21   public string HelloWorld() {22     return "Hello World";23   }24   25 }

默认的工程文件已有了 HelloWorld 方法,直接运行效果如下图。

点击上面的 “HelloWorld” 超链接,转至如下页面。

再点击“调用”按钮,就可以看到用

2.2 创建一个附带简单功能的WebService

上面我们宏观的了解了Web Service,其实它就是个对外的接口,里面有函数可供外部客户调用(注意:里面同样有客户不可调用的函数)。假若我们是服务端,我们写好了一个WebService,然后把它给了客户(同时我们给了他们调用规则),客户就可以在从服务端获取信息时处于一个相对透明的状态.即是客户不了解(也不需要)其过程,他们只获取数据.在代码文件里,如果我们写了一个函数后,希望此函数成为外部可调用的接口函数,我们必须在函数上面添上一行代码[WebMethod(Description="函数的描述信息")],如果你的函数没有这个申明,它将不能被用户引用.下来我们开始编写一个简单的Web Service 的例子。

先把默认的HelloWorld方法注释掉,简单的写了求加减乘除运算的四个方法。

 1 using System; 2 using System.Collections.Generic; 3 using System.Linq; 4 using System.Web; 5 using System.Web.Services; 6  7 [WebService(Namespace = "http://tempuri.org/")] 8 [WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)] 9 // 若要允许使用 ASP.NET AJAX 从脚本中调用此 Web 服务,请取消对下行的注释。 10 // [System.Web.Script.Services.ScriptService]11 12 public class Service : System.Web.Services.WebService13 {14   public Service () {15 16     //如果使用设计的组件,请取消注释以下行 17     //InitializeComponent(); 18   }19 20   //[WebMethod]21   //public string HelloWorld() {22   //  return "Hello World";23   //}24   [WebMethod(Description = "求和的方法")]25   public double addition(double i, double j)26   {27     return i + j;28   }29   [WebMethod(Description = "求差的方法")]30   public double subtract(double i, double j)31   {32     return i - j;33   }34   [WebMethod(Description = "求积的方法")]35   public double multiplication(double i, double j)36   {37     return i*j;38   }39   [WebMethod(Description = "求商的方法")]40   public double division(double i, double j)41   {42     if (j != 0)43     {44       return i / j;45     }46     else {47       return 0;48     }49   }50 }

 启动调试可以看到我们自己写的可以被调用的方法,如下图。

在上图参数 i,j的值中分别输入有效数值,比如3和6,单击“调用”,会得到如下结果。

到这里,我们会发现,其实WebService并不是那么的神秘,它也不过只是个接口,对我们而言,侧重点就是是接口函数的编写。

2.2 用 ASP.NET 调用 WebService

首先,打开VS2010,打开“文件-新建-网站”,选择“ASP.NET网站”。

在URL中填入前面写好的WebService运行后浏览器上面显示的地址,点击“前往”按钮,如上图,就会显示出所引用的WebService中可以调用的方法,然后点击“添加引用”,就将webservice引用到了当前的工程里面,如下图,解决方案中会出现引进来的WebService文件。


在这个例子里面,动态的创建了一个button控件来触发WebService的调用,然后再修改后台 Default.aspx.cs 中的代码,处理背后的运算逻辑,如下。调用WebService之前和使用其它的对象一样,要先实例化,实例化的方法是localhost.Service a =new localhost.Service(),然后就可以通过a来访问WebService里面提供的方法了。

 1 using System; 2 using System.Data; 3 using System.Configuration; 4 using System.Collections.Generic; 5 using System.Linq; 6 using System.Web; 7 using System.Web.Security; 8 using System.Web.UI; 9 using System.Web.UI.WebControls;10 using System.Web.UI.WebControls.WebParts;11 using System.Web.UI.HtmlControls;12 13 public partial class _Default : System.Web.UI.Page14 {15   protected void Page_Load(object sender, EventArgs e)16   {17     //在页面加载的时候动态创建一个按钮,在它的事件里调用Websercie18     Button btn = new Button();19     btn.Width = 24;20     btn.Text = "=";21     btn.Click += new EventHandler(btn_Click);22     E.Controls.Add(btn);23   }24 25   /// <summary>26   /// 定义动态创建Button的Click事件,在这个事件中调用Webservice27   /// </summary>28   /// <param name="sender"></param>29   /// <param name="e"></param>30   void btn_Click(object sender, EventArgs e)31   {32     if (Num1.Text != "" && Num2.Text != "")33     { 34       //实例化引用的webservice对象35       localhost.Service webserviceInstance = new localhost.Service();36       int Oper = selectOper.SelectedIndex;37       switch (Oper) { 38         //通过实例化的webservice对象来调用Webservice暴露的方法39         case 0:40           Result.Text = webserviceInstance.addition(double.Parse(Num1.Text), double.Parse(Num2.Text)).ToString();41           break;42         case 1:43           Result.Text = webserviceInstance.subtract(double.Parse(Num1.Text), double.Parse(Num2.Text)).ToString();44           break;45         case 2:46           Result.Text = webserviceInstance.multiplication(double.Parse(Num1.Text), double.Parse(Num2.Text)).ToString();47           break;48         case 3:49           Result.Text = webserviceInstance.division(double.Parse(Num1.Text), double.Parse(Num2.Text)).ToString();50           break;51       }52     }53   }54 }

运行后可以看到效果,如下图所示,在前面两个Textbox里面输入两个操作数,在中间的下拉列表中选择操作符,然后点击“=”号,将计算的结果输出到第三个Textbox里面。

而此时整个计算并不是在本地进行的,是在Web服务端进行计算的然后将结果通过

http://static.oschina.net/uploads/img/201411/08113031_2Dud.jpg

到此一个一个简单的WebService的开发和调用就已经完成了,在实际应用中可以根据自己的需要,写一些功能强大、复杂的WebService。无论多复杂,整个流程都是如此。

2.3 在 IIS 上搭建 ASP.NET 并调用 WebService

上述操作是在 Visual Studio 2010 的调试环境下进行的。为了保证WebService能够提供可持续的服务,以及建立一个(本地)可持续访问的站点,需要将网站搭建在 IIS 上。关于 IIS 的配置以及如何搭建网站不是本文的研究内容,读者可以自行搜索相关教程。

此节主要讲述搭建过程中的注意事项、会遇到的问题以及解决方法。

在 IIS 网站的默认 localhost 站点下,添加虚拟目录

1. WebServiceTest:其物理路径即为2.1提到的WebServiceTest目录。(WebService)

2. WebSiteForServiceTest:其物理路径即为2.1提到的WebSite1目录。(ASP.NET站点)

注意,需要将所添加的两个虚拟目录均转换为应用程序。将虚拟目录装换为转换为应用程序后,虚拟目录将以程序的形式运行,有自己独立的应用程序池,保存自己独立的数据,而不是继承主网站的数据配置。如果在 IIS 中没有将虚拟目录配置为应用程序,则可能导致错误:"分析器错误消息: 在应用程序级别之外使用注册allowDefinition='MachineToApplication' 的节是错误的"。

   

关于 .NET Framework

1. WebServiceTest 的应用程序池选择 DefaultAppPool,如下图所示,不然会报错。关于原因,由于笔者才接触 ASP.NET 不久,在web.config中还没看出道道来,需要摸索…… 若有高人知晓,还望指点迷津。

2. WebSiteForServiceTest 的应用程序选择 ASP.NET v4.0 (管道模式:集成),如下图所示,不然也会报错。关于原因,笔者只在 web.config 中找到如下代码。

<compilation debug="true" targetFramework="4.0"/>

修改配置

前面两部设置完成后,可以通过本地浏览器访问 WebService,如下图所示。

而在访问 ASP.NET 网站之前还需要修改 web.config 中的相关属性,如下图所示。之前调试状态下 localhost 之后有端口号,现在搭建在本地 IIS 之后,端口号依默认站点确定(本环境下默认 80 端口)。

上述配置成功后,即可在浏览器中访问站点,并调用 WebService,如下图所示。


3. 结语

至此完成了最简单的调用 WebService 的 ASP.NET 站点,并对 WebService 有了初步认识。

【参考文献】

[1] C#开发和调用Web Service

[2] IIS7中的站点、应用程序和虚拟目录详细介绍