關於什麼是Web Service,相信在很多地方都會有介紹。簡單的講,Web Service就是爲Web應用程序之間彼此共享資源提供了一種可能。採取的方式是將相應的類及其中的方法暴露出來,然後調用者就可以直接調用這些類中的方法,達到訪問遠程資源的目的。本文只是想告訴,如果去使用Web Service。我主要從服務器端訪問Web Service、客戶端訪問Web Service兩方面來介紹。如果你還不會使用Web Service,希望對你有所幫助。
一、服務器端訪問Web Service
這也是Web Service最適宜的調用環境。我們只需知道一個遠程Web Service的URL,然後我們就可以直接使用Wsdl工具或更方便的添加Web 引用的方法,將遠程Web Service(指.asmx文件)中對應類生成一個強類型的本地化代理。通過這個代理,我們就可以像使用本地方法一樣,去調用這個遠程類中的方法。使用的過程是非常的簡單。下面讓我們看看具體的操作。
1、新建一個Web Service
選擇asp.net Web服務模板,然後你會看到VS已經自動爲我們生成了一個Web Service的示例代碼。
using System;
using System.Web;
using System.Web.Services;
using System.Web.Services.Protocols;
[WebService(Namespace = "http://tempuri.org/")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
public class Service : System.Web.Services.WebService
{
public Service()
{
//如果使用設計的組件,請取消註釋以下行
//InitializeComponent();
}
[WebMethod]
public string HelloWorld()
{
return "Hello World";
}
}
一個Web Service的主要部分VS已經幫我們寫好了。這裏有幾個地方,我大概說一下。[WebService(Namespace = http://tempuri.org/)]特性部分,它聲明瞭Web Service所對應的XMl文件的命名空間,如果你直接瀏覽Web Service文件,它會出現在XML文件的命名空間聲明中。還是建議修改一下Namespace,雖然它只是一個URI。比如你可以把它改爲Namespace=http://ruihua.cnblogs.com/。[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]特性聲稱的是本Web Service所應符合的Web服務互操作性規範,一般情況下我們無需考慮這個,只有某些操作與這個規範不相符的時候,我們就需要修改ConformsTo = WsiProfiles.None。(比如BasicProfile1_1規範並不支持方法的重載,如果你有重載方法的話,就需要修改它。)需要特別說明的是,通常一個web Service文件對應的只有一個類,當然並不是說你不可以在一個.asmx文件中寫多個類,但只有與WebService指令中的className值對應的那個類纔會被公開。而對於類中的方法,我們必須顯式加上[WebMthod]特性,才能被公開,這點與類不同。讓我們看一下WebMethod特性的一些其它屬性:
屬性 | 功能 | 示例 |
BufferResponse | 設置爲True時,XML Web服務的響應就保存在內存中,併發送爲一個完整的包。如果該屬性設置爲False,則響應在服務器上構造的同時,會發送給客戶機。 | [WebMethod(BufferResponse=true)] |
CacheDuration | 指定響應在系統的高速緩存中的保存時間(秒),默認值爲0,表示禁用高速緩存。把XML Web服務的響應放在高速緩存中,會提高Web服務的性能。 | [WebMethod(BufferResponse=true,CacheDuration=30)] |
Description | 對在XML Web服務的測試頁面上顯示的Web Method應用文本的描述。 | [WebMethod(Description="該方法用於獲取一個簡單的字符串")] |
EnableSession | 設置爲True時,會激活Web Method的會話狀態,其默認值爲False。 | [WebMethod(EnableSession=true)] |
MessageName | 給Method指定一個唯一的名稱,如果要使用重載的Web Method,則必須指定。 | [WebMethod(MessageName="Method1")] |
TransactionOption | 爲Web Method指定事務的支持,其默認值爲Disbled。如果Web Method是啓動事務的根對象,Web服務就可以用另一個需要事務處理的WebMethod參與事務處理。其值可以是NotSupported、Supported、Required和RequiresNew。 | [WebMethod(TransactionOption=System.EnterpriseServices.TransactionOption.Supported)] |
我們修改一下上述代碼。
using System;
using System.Web;
using System.Web.Services;
using System.Web.Services.Protocols;
[WebService(Namespace = "http://tempuri.org/")]
[WebServiceBinding(ConformsTo = WsiProfiles.None)]
public class Service : System.Web.Services.WebService
{
public Service()
{
}
[WebMethod]
public string Hello(string name)
{
return string.Format("Hello,{0}!Current Time is :{1}", name, DateTime.Now.ToString());
}
}
程序很簡單,傳進去一個姓名,返回一串提供信息,下面我們來看一下如何使用這個Web Service.
2、訪問Web Service
首先需要說明一下,爲何我們能夠在本地服務器上訪問到遠程服務器的Web Service?無論是使用添加Web引用的方式還是使用Wsdl工具,最終的結果都是生成了一個遠程Web Service中類的強類型化本地代理。然後我們是通過這個代理來實現訪問遠程資源訪問的。下面我們看看怎麼通過這兩種方式來實現。
首先我們新建一個新的Web應用程序
方式一:使用添加Web 引用。在解決方案資源管理器中單擊右鍵,選擇添加Web 引用...,如下所示:
在URL部分你可以直接輸入遠程Web Service的URL,當然如果引用的Web Service來自本地,你可以單擊相應的鏈接,然後進行選擇。在Web引用名中,填入你自定義的名稱。注意,這個名稱就代指Web Service的命名空間。在訪問的時候,我們必須通過這個名稱才能引用到Web Service中的類。填好後,單擊添加引用即可。
爲了保證本地測試方便,請將Web Service所在網站設爲Web 共享,這樣我們就不必考慮在Web引用中加入端口號才能訪問的問題。添加Web引用對話框中查找的實際是WSDL文件,Microsoft的XML Web服務會根據.asmx文件自動生成wdsl文件。當然,我們也可以根據.asmx文件在瀏覽器中打開wsdl文件,按如下路徑:
http://localhost/WebService/Service.asmx?wsdl
接下來,你會看到VS已經爲我們添加好了Web 引用。
同時在Web.Config文件中也包含了對Web服務的引用,如下所示:
<appSettings> <add key="ServiceNamespace.Service" value="http://localhost/WebService/Service.asmx"/> </appSettings>
接下來,讓我們看一下如何使用這個Web Service,請看代碼:
public partial class _Default : System.Web.UI.Page
{
protected void Page_Load(object sender, EventArgs e)
{
ServiceNamespace.Service ws = new ServiceNamespace.Service();
Response.Write(ws.Hello("Ruihua"));
}
}
你會看到,使用遠程方法就像使用本地方法一樣簡單,下面是運行結果:
原因是:Web Service不允許我們以匿名的方式訪問。你可以在IIS信息服務中Web Service所在站點開啓這項功能。然後,你就可以看到正確結果了:
方式二:使用WSDL工具。
我們也可以使用VS自帶的wsdl工具來實現相同的功能,這個工具可以將wsdl文件生成在本地生成一個強類型的類文件,然後我們可以就可以直接在項目中使用這個類文件,來訪問遠程資源。打開VS命令提供,輸入以下命令,如下圖所示:
同時在C:/Program Files/Microsoft Visual Studio 8/VC下會自動生成一個Service.cs的文件。我們將這個文件置於我們的項目中,就可以直接使用了。
[Microsoft (R) .NET Framework, Version 2.0.50727.42]
Copyright (C) Microsoft Corporation. All rights reserv
wsdl.exe -
使用 ASP.NET,根據 WSDL 協定文件、XSD 架構和 .disc
發現文檔,爲 Xml Web Services 客戶端和 Xml Web Ser
代碼的實用工具。此工具可以與 disco.exe 一起使用。
wsdl.exe <選項> <URL 或路徑> <URL 或路徑>
- 選項 -
<URL 或路徑> -
指向 WSDL 協定、XSD 架構或 .discomap 文檔的 URL 或
/nologo
取消顯示版權標誌。
/language:<language>
用於生成的代理類的語言。請從“CS”、“VB”、“JS”
“CPP”中選擇,或者爲實現 System.CodeDom.Compiler.
的類提供一個完全限定的名稱。默認語言爲“CS”(CShar
縮寫形式爲“/l:”。
/sharetypes
打開類型共享功能。此功能針對不同服務之間共享
的相同類型(命名空間、名稱和網絡簽名必須相同)
創建一個具有單一類型定義的代碼文件。
請使用 http:// URLs 作爲命令行參數來引用
服務,或爲本地文件創建一個 discomap 文檔。
/verbose
指定 /sharetypes 開關時顯示額外信息。
縮寫形式爲“/v”。
/fields
生成字段而非屬性。縮寫形式爲“/f”。
/order
爲粒子成員生成顯式順序標識符。
/enableDataBinding
在所有生成的類型上實現 INotifyPropertyChanged 接口
以啓用數據綁定。縮寫形式爲“/edb”。
/namespace:<namespace>
生成的代理或模板的命名空間。默認命名空間
爲全局命名空間。縮寫形式爲“/n:”。
/out:<fileName|directoryPath>
生成的代理代碼的文件名或目錄路徑。默認文件名是從
服務名派生的。縮寫形式爲“/o:”。
/protocol:<protocol>
重寫要實現的默認協議。請從“SOAP”、“SOAP12”、
“HttpGet”、“HttpPost”中選擇。
/username:<username>
/password:<password>
/domain:<domain>
連接到要求身份驗證的服務器時使用的憑據。
縮寫形式爲“/u:”、“/p:”和“/d:”。
/proxy:<url>
用來處理 HTTP 請求的代理服務器的 URL。
默認爲使用系統代理服務器設置。
/proxyusername:<username>
/proxypassword:<password>
/proxydomain:<domain>
連接到要求身份驗證的代理服務器時使用的憑據。
縮寫形式爲“/pu:”、“/pp:”和“/pd:”。
/appsettingurlkey:<key>
在代碼生成中用來讀取 URL 屬性的
默認值的配置項。默認爲不從配置
文件中讀取。縮寫形式爲“/urlkey:”。
/appsettingbaseurl:<baseurl>
計算 URL 段時使用的基 URL。
還必須指定 appsettingurlkey 選項。URL 段是
從 appsettingbaseurl 計算
WSDL 文檔中的 URL 的相對 URL 的結果。縮寫形式爲“
/parsableerrors
輸出錯誤,其格式與編譯器報告的格式類似。
- 高級 -
/server
服務器開關已被否決。請改用 /serverInterface。
使用基於協定的 ASP.NET,爲 Xml Web Services 實現生成抽象類。默認情況下,生成
客戶端代理類。
/serverInterface
爲 ASP.Net Web 服務的服務器端實現生成接口。將爲 wsdl 文檔中的每個綁定生成
一個接口。wsdl 單獨實現 wsdl 協定(實現接口的類在類方法上不應包括下列任意一項:
更改 wsdl 協定的 Web 服務屬性或序列化屬性)。縮寫形式爲“/si”。
/parameters:<file>
從指定的 xml 文件讀取命令行選項。這樣可以指定命令行中無法使用的選項,例如選擇
生成的異步編程模型類型。有關詳細信息,請參閱工具文檔。縮寫形式爲“/par:”。
//------------------------------------------------------------------------------
// <auto-generated>
// 此代碼由工具生成。
// 運行庫版本:2.0.50727.42
//
// 對此文件的更改可能會導致不正確的行爲,並且如果
// 重新生成代碼,這些更改將會丟失。
// </auto-generated>
//------------------------------------------------------------------------------
using System;
using System.ComponentModel;
using System.Diagnostics;
using System.Web.Services;
using System.Web.Services.Protocols;
using System.Xml.Serialization;
//
// 此源代碼由 wsdl 自動生成, Version=2.0.50727.42。
//
/// <remarks/>
[System.CodeDom.Compiler.GeneratedCodeAttribute("wsdl", "2.0.50727.42")]
[System.Diagnostics.DebuggerStepThroughAttribute()]
[System.ComponentModel.DesignerCategoryAttribute("code")]
[System.Web.Services.WebServiceBindingAttribute(Name = "ServiceSoap", Namespace = "http://ruihua.cnblogs.com/")]
public partial class Service : System.Web.Services.Protocols.SoapHttpClientProtocol
{
private System.Threading.SendOrPostCallback HelloOperationCompleted;
/// <remarks/>
public Service()
{
this.Url = "http://localhost/WebService/Service.asmx";
}
/// <remarks/>
public event HelloCompletedEventHandler HelloCompleted;
/// <remarks/>
[System.Web.Services.Protocols.SoapDocumentMethodAttribute("http://ruihua.cnblogs.com/Hello", RequestNamespace = "http://ruihua.cnblogs.com/", ResponseNamespace = "http://ruihua.cnblogs.com/", Use = System.Web.Services.Description.SoapBindingUse.Literal, ParameterStyle = System.Web.Services.Protocols.SoapParameterStyle.Wrapped)]
public string Hello(string name)
{
object[] results = this.Invoke("Hello", new object[] {
name});
return ((string) (results[0]));
}
/// <remarks/>
public System.IAsyncResult BeginHello(string name, System.AsyncCallback callback, object asyncState)
{
return this.BeginInvoke("Hello", new object[] {
name}, callback, asyncState);
}
/// <remarks/>
public string EndHello(System.IAsyncResult asyncResult)
{
object[] results = this.EndInvoke(asyncResult);
return ((string) (results[0]));
}
/// <remarks/>
public void HelloAsync(string name)
{
this.HelloAsync(name, null);
}
/// <remarks/>
public void HelloAsync(string name, object userState)
{
if ((this.HelloOperationCompleted == null))
{
this.HelloOperationCompleted = new System.Threading.SendOrPostCallback(this.OnHelloOperationCompleted);
}
this.InvokeAsync("Hello", new object[] {
name}, this.HelloOperationCompleted, userState);
}
private void OnHelloOperationCompleted(object arg)
{
if ((this.HelloCompleted != null))
{
System.Web.Services.Protocols.InvokeCompletedEventArgs invokeArgs = ((System.Web.Services.Protocols.InvokeCompletedEventArgs) (arg));
this.HelloCompleted(this, new HelloCompletedEventArgs(invokeArgs.Results, invokeArgs.Error, invokeArgs.Cancelled, invokeArgs.UserState));
}
}
/// <remarks/>
public new void CancelAsync(object userState)
{
base.CancelAsync(userState);
}
}
/**/
/// <remarks/>
[System.CodeDom.Compiler.GeneratedCodeAttribute("wsdl", "2.0.50727.42")]
public delegate void HelloCompletedEventHandler(object sender, HelloCompletedEventArgs e);
/// <remarks/>
[System.CodeDom.Compiler.GeneratedCodeAttribute("wsdl", "2.0.50727.42")]
[System.Diagnostics.DebuggerStepThroughAttribute()]
[System.ComponentModel.DesignerCategoryAttribute("code")]
public partial class HelloCompletedEventArgs : System.ComponentModel.AsyncCompletedEventArgs
{
private object[] results;
internal HelloCompletedEventArgs(object[] results, System.Exception exception, bool cancelled, object userState)
:
base(exception, cancelled, userState)
{
this.results = results;
}
/// <remarks/>
public string Result
{
get
{
this.RaiseExceptionIfNecessary();
return ((string) (this.results[0]));
}
}
}
至此,服務器端訪問Web Service就到這裏,下面讓我們來看看客戶端如何該問Web Service。