搭建調用 WebService 的 ASP.NET 網站 （VS2010, C#）

【系統環境】Windows 7 / 2008r2

【軟件環境】Visual Studio 2010

【開發語言】C#

【感謝】本文是在 《C#開發和調用Web Service》 一文的基礎上做了少許修改及補充后整理所得。

1. WebService

1.1 基本概念

Web Service也叫XML Web Service Web Service是一種可以接收從Internet或者Intranet上的其它系統中傳遞過來的請求，輕量級的獨立的通訊技術。是:通過SOAP在Web上提供的軟件服務，使用WSDL文件進行說明，並通過UDDI進行注冊。

XML：(Extensible Markup Language)擴展型可標記語言。面向短期的臨時數據處理、面向萬維網絡，是Soap的基礎。

Soap：(Simple Object Access Protocol)簡單對象存取協議。是XML Web Service 的通信協議。當用戶通過UDDI找到你的WSDL描述文檔后，他通過可以SOAP調用你建立的Web服務中的一個或多個操作。SOAP是XML文檔形式的調用方法的規范，它可以支持不同的底層接口，像HTTP(S)或者SMTP。

WSDL：(Web Services Description Language) WSDL 文件是一個 XML 文檔，用於說明一組 SOAP 消息以及如何交換這些消息。大多數情況下由軟件自動生成和使用。

UDDI (Universal Description, Discovery, and Integration) 是一個主要針對Web服務供應商和使用者的新項目。在用戶能夠調用Web服務之前，必須確定這個服務內包含哪些商務方法，找到被調用的接口定義，還要在服務端來編制軟件，UDDI是一種根據描述文檔來引導系統查找相應服務的機制。UDDI利用SOAP消息機制（標准的XML/HTTP）來發布，編輯，瀏覽以及查找注冊信息。它采用XML格式來封裝各種不同類型的數據，並且發送到注冊中心或者由注冊中心來返回需要的數據。

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

1.2 特點

Web Service的主要目標是跨平台的可互操作性。為了實現這一目標，Web Service 完全基於XML（可擴展標記語言）、XSD（XML Schema）等獨立於平台、獨立於軟件供應商的標准，是創建可互操作的、分布式應用程序的新平台。因此使用Web Service有許多優點:

1.跨防火牆的通信

如果應用程序有成千上萬的用戶，而且分布在世界各地，那么客戶端和服務器之間的通信將是一個棘手的問題。因為客戶端和服務器之間通常會有防火牆或者代理服務器。傳統的做法是，選擇用瀏覽器作為客戶端，寫下一大堆ASP頁面，把應用程序的中間層暴露給最終用戶。這樣做的結果是開發難度大，程序很難維護。要是客戶端代碼不再如此依賴於HTML表單，客戶端的編程就簡單多了。如果中間層組件換成Web Service的話，就可以從用戶界面直接調用中間層組件，從而省掉建立ASP頁面的那一步。要調用Web Service，可以直接使用Microsoft SOAP Toolkit或.net這樣的SOAP客戶端，也可以使用自己開發的SOAP客戶端，然后把它和應用程序連接起來。不僅縮短了開發周期，還減少了代碼復雜度，並能夠增強應用程序的可維護性。同時，應用程序也不再需要在每次調用中間層組件時，都跳轉到相應的“結果頁”。

2.應用程序集成

企業級的應用程序開發者都知道，企業里經常都要把用不同語言寫成的、在不同平台上運行的各種程序集成起來，而這種集成將花費很大的開發力量。應用程序經常需要從運行的一台主機上的程序中獲取數據；或者把數據發送到主機或其它平台應用程序中去。即使在同一個平台上，不同軟件廠商生產的各種軟件也常常需要集成起來。通過Web Service，應用程序可以用標准的方法把功能和數據“暴露”出來，供其它應用程序使用。

XML Web services 提供了在松耦合環境中使用標准協議（HTTP、XML、SOAP 和 WSDL）交換消息的能力。消息可以是結構化的、帶類型的，也可以是松散定義的。

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.最初的 XML Web Service 通常是可以方便地並入應用程序的信息來源，如股票價格、天氣預報、體育成績等等。

2.以 XML Web Service 方式提供現有應用程序，可以構建新的、更強大的應用程序，並利用 XML Web Service 作為構造塊。

例如，用戶可以開發一個采購應用程序，以自動獲取來自不同供應商的價格信息，從而使用戶可以選擇供應商，提交訂單，然后跟蹤貨物的運輸，直至收到貨物。而供應商的應用程序除了在Web上提供服務外，還可以使用XML Web Service檢查客戶的信用、收取貨款，並與貨運公司辦理貨運手續。

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 空網站，如下圖所示。

2. 也可改用 .NET Framework 3.5，選擇 ASP.NET Web 服務，如下圖所示。

我們將項目文件夾命名為WebServiceTest，即上圖中的WebSite1修改為WebServiceTest，新建生成的項目目錄結構如下圖所示。

查看Service.cs代碼，你會發現VS.Net 2010已經為Web Service文件建立了缺省的框架。原始代碼如下。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Services;

[WebService(Namespace = "http://tempuri.org/")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
// 若要允許使用 ASP.NET AJAX 從腳本中調用此 Web 服務，請取消對下行的注釋。 
// [System.Web.Script.Services.ScriptService]

public class Service : System.Web.Services.WebService
{
    public Service () {

        //如果使用設計的組件，請取消注釋以下行 
        //InitializeComponent(); 
    }

    [WebMethod]
    public string HelloWorld() {
        return "Hello World";
    }
    
}

默認的工程文件已有了 HelloWorld 方法，直接運行效果如下圖。

點擊上面的 “HelloWorld” 超鏈接，轉至如下頁面。

再點擊“調用”按鈕，就可以看到用XML格式返回的Web Service結果下圖。說明我們的Web Service環境沒有問題，而且還初步接觸了一下最簡單的Web Service。

2.2 創建一個附帶簡單功能的WebService

上面我們宏觀的了解了Web Service，其實它就是個對外的接口,里面有函數可供外部客戶調用(注意:里面同樣有客戶不可調用的函數)。假若我們是服務端,我們寫好了一個WebService，然后把它給了客戶(同時我們給了他們調用規則),客戶就可以在從服務端獲取信息時處於一個相對透明的狀態.即是客戶不了解(也不需要)其過程,他們只獲取數據.在代碼文件里,如果我們寫了一個函數后,希望此函數成為外部可調用的接口函數,我們必須在函數上面添上一行代碼[WebMethod(Description="函數的描述信息")],如果你的函數沒有這個申明,它將不能被用戶引用.下來我們開始編寫一個簡單的Web Service 的例子。

先把默認的HelloWorld方法注釋掉，簡單的寫了求加減乘除運算的四個方法。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Services;

[WebService(Namespace = "http://tempuri.org/")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
// 若要允許使用 ASP.NET AJAX 從腳本中調用此 Web 服務，請取消對下行的注釋。 
// [System.Web.Script.Services.ScriptService]

public class Service : System.Web.Services.WebService
{
    public Service () {

        //如果使用設計的組件，請取消注釋以下行 
        //InitializeComponent(); 
    }

    //[WebMethod]
    //public string HelloWorld() {
    //    return "Hello World";
    //}
    [WebMethod(Description = "求和的方法")]
    public double addition(double i, double j)
    {
        return i + j;
    }
    [WebMethod(Description = "求差的方法")]
    public double subtract(double i, double j)
    {
        return i - j;
    }
    [WebMethod(Description = "求積的方法")]
    public double multiplication(double i, double j)
    {
        return i*j;
    }
    [WebMethod(Description = "求商的方法")]
    public double division(double i, double j)
    {
        if (j != 0)
        {
            return i / j;
        }
        else {
            return 0;
        }
    }
}

 啟動調試可以看到我們自己寫的可以被調用的方法，如下圖。

點擊“addition”方法，進入其調用頁面，如下圖所示。

在上圖參數 i，j的值中分別輸入有效數值，比如3和6，單擊“調用”，會得到如下結果。

到這里,我們會發現,其實WebService並不是那么的神秘,它也不過只是個接口，對我們而言，側重點就是是接口函數的編寫。

2.2 用 ASP.NET 調用 WebService

首先，打開VS2010，打開“文件-新建-網站”，選擇“ASP.NET網站”。

在此將項目文件夾命名為WebSite1，即修改上圖中 Web位置下目錄最后的 “WebSite4”為“WebSite1”。（讀者可根據自己的需求命名）

選好存儲位置，語言后點擊確定，進入默認頁面。然后先添加Web引用（注意不是添加服務引用，方法是：在資源管理器中點擊右鍵，選擇【添加服務引用】，點擊 【高級】，【添加WEB引用】，調出對話框），把WebService引到當前的工程里面。方法是：在資源管理器中點擊右鍵，選擇添加Web 引用，調出對話框，如下圖所示。

在URL中填入前面寫好的WebService運行后瀏覽器上面顯示的地址，點擊“前往”按鈕，如上圖，就會顯示出所引用的WebService中可以調用的方法，然后點擊“添加引用”，就將webservice引用到了當前的工程里面，如下圖，解決方案中會出現引進來的WebService文件。

我們在這就練習調用webservice的四個方法，做一個簡單的調用的例子，先在網站的前台添加幾個控件，修改 Default.aspx 中的代碼，如下。

<%@ Page Title="主頁" Language="C#"  AutoEventWireup="true" MasterPageFile="~/Site.master" CodeFile="Default.aspx.cs" Inherits="_Default" %>
<asp:Content ID="Content1" runat="server" ContentPlaceHolderID="HeadContent">
</asp:Content>
<asp:Content ID="BodyContent" runat="server" ContentPlaceHolderID="MainContent">
    <div>
        <asp:TextBox ID="Num1" runat="server"></asp:TextBox>
        <select id="selectOper" runat="server">
            <option>+</option>
            <option>-</option>
            <option>*</option>
            <option>/</option>
        </select>
        <asp:TextBox ID="Num2" runat="server"></asp:TextBox>
        <span id = "E" runat="server"></span>
        <asp:TextBox ID="Result" runat="server"></asp:TextBox>
    </div>
</asp:Content>

在這個例子里面，動態的創建了一個button控件來觸發WebService的調用，然后再修改后台 Default.aspx.cs 中的代碼，處理背后的運算邏輯，如下。調用WebService之前和使用其它的對象一樣，要先實例化，實例化的方法是localhost.Service a =new localhost.Service()，然后就可以通過a來訪問WebService里面提供的方法了。

using System;
using System.Data;
using System.Configuration;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;
using System.Web.UI.HtmlControls;

public partial class _Default : System.Web.UI.Page
{
    protected void Page_Load(object sender, EventArgs e)
    {
        //在頁面加載的時候動態創建一個按鈕，在它的事件里調用Websercie
        Button btn = new Button();
        btn.Width = 24;
        btn.Text = "=";
        btn.Click += new EventHandler(btn_Click);
        E.Controls.Add(btn);
    }

    /// <summary>
    /// 定義動態創建Button的Click事件，在這個事件中調用Webservice
    /// </summary>
    /// <param name="sender"></param>
    /// <param name="e"></param>
    void btn_Click(object sender, EventArgs e)
    {
        if (Num1.Text != "" && Num2.Text != "")
        { 
            //實例化引用的webservice對象
            localhost.Service webserviceInstance = new localhost.Service();
            int Oper = selectOper.SelectedIndex;
            switch (Oper) { 
                //通過實例化的webservice對象來調用Webservice暴露的方法
                case 0:
                    Result.Text = webserviceInstance.addition(double.Parse(Num1.Text), double.Parse(Num2.Text)).ToString();
                    break;
                case 1:
                    Result.Text = webserviceInstance.subtract(double.Parse(Num1.Text), double.Parse(Num2.Text)).ToString();
                    break;
                case 2:
                    Result.Text = webserviceInstance.multiplication(double.Parse(Num1.Text), double.Parse(Num2.Text)).ToString();
                    break;
                case 3:
                    Result.Text = webserviceInstance.division(double.Parse(Num1.Text), double.Parse(Num2.Text)).ToString();
                    break;
            }
        }
    }
}

運行后可以看到效果，如下圖所示，在前面兩個Textbox里面輸入兩個操作數，在中間的下拉列表中選擇操作符，然后點擊“=”號，將計算的結果輸出到第三個Textbox里面。

而此時整個計算並不是在本地進行的，是在Web服務端進行計算的然后將結果通過XML返還給了調用方的，所以，在調試運行該程序的時候，WebService程序還必須啟動，否則會報無法連接遠程服務器的異常，如下圖。

到此一個一個簡單的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中還沒看出道道來，需要摸索…… 若有高人知曉，還望指點迷津。（參考文獻：C# 配置錯誤定義了重復的“system.web.extensions/scripting/scriptResourceHandler”節）

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中的站點、應用程序和虛擬目錄詳細介紹