GettingStarted 範例示範如何使用 Windows Communication Foundation (WCF) 實作一般服務和一般用戶端。 此範例是所有其他基本技術範例的基礎。
備註
此範例的安裝程式和建置指示位於本主題結尾。
服務在其公開的服務契約中描述它執行的作業,並將此合約公開為可供公開的元數據。 服務也包含實作作業的程序代碼。
用戶端包含服務合約的定義,以及存取服務的 Proxy 類別。 Proxy 程式代碼是使用 ServiceModel 元數據公用程式工具 (Svcutil.exe) 從服務元數據產生。
在 Windows Vista 上,服務裝載於 Windows 啟用服務 (WAS)。 在 Windows XP 和 Windows Server 2003 上,它是由 Internet Information Services (IIS) 和 ASP.NET 所裝載。 在 IIS 或 WAS 中裝載服務可讓服務在第一次存取時自動啟動。
備註
如果您想要開始使用在主控台應用程式中裝載服務的範例,而不是 IIS,請參閱 自我裝載 範例。
服務和用戶端會在組態檔設定中指定存取詳細數據,以在部署時提供彈性。 這包括指定位址、系結和合約的端點定義。 系結會指定如何存取服務的傳輸和安全性詳細數據。
服務配置一個運行時行為來發佈其元數據。
服務會實作定義要求-回復通訊模式的合約。 合約是由 ICalculator
介面所定義,其會公開數學運算(加、減、乘和除)。 用戶端會向指定的數學運算提出要求,而服務會以結果回復。 服務會實作由以下程式碼定義的ICalculator
合約。
' Define a service contract.
<ServiceContract(Namespace:="http://Microsoft.Samples.GettingStarted")>
Public Interface ICalculator
<OperationContract()>
Function Add(ByVal n1 As Double, ByVal n2 As Double) As Double
<OperationContract()>
Function Subtract(ByVal n1 As Double, ByVal n2 As Double) As Double
<OperationContract()>
Function Multiply(ByVal n1 As Double, ByVal n2 As Double) As Double
<OperationContract()>
Function Divide(ByVal n1 As Double, ByVal n2 As Double) As Double
End Interface
// Define a service contract.
[ServiceContract(Namespace="http://Microsoft.ServiceModel.Samples")]
public interface ICalculator
{
[OperationContract]
double Add(double n1, double n2);
[OperationContract]
double Subtract(double n1, double n2);
[OperationContract]
double Multiply(double n1, double n2);
[OperationContract]
double Divide(double n1, double n2);
}
服務實作會計算並傳回適當的結果,如下列範例程式代碼所示。
' Service class which implements the service contract.
Public Class CalculatorService
Implements ICalculator
Public Function Add(ByVal n1 As Double, ByVal n2 As Double) As Double Implements ICalculator.Add
Return n1 + n2
End Function
Public Function Subtract(ByVal n1 As Double, ByVal n2 As Double) As Double Implements ICalculator.Subtract
Return n1 - n2
End Function
Public Function Multiply(ByVal n1 As Double, ByVal n2 As Double) As Double Implements ICalculator.Multiply
Return n1 * n2
End Function
Public Function Divide(ByVal n1 As Double, ByVal n2 As Double) As Double Implements ICalculator.Divide
Return n1 / n2
End Function
End Class
// Service class that implements the service contract.
public class CalculatorService : ICalculator
{
public double Add(double n1, double n2)
{
return n1 + n2;
}
public double Subtract(double n1, double n2)
{
return n1 - n2;
}
public double Multiply(double n1, double n2)
{
return n1 * n2;
}
public double Divide(double n1, double n2)
{
return n1 / n2;
}
}
此服務會公開端點,以便與使用組態檔 (Web.config) 定義的服務進行通訊,如下列範例組態所示。
<services>
<service
name="Microsoft.ServiceModel.Samples.CalculatorService"
behaviorConfiguration="CalculatorServiceBehavior">
<!-- ICalculator is exposed at the base address provided by
host: http://localhost/servicemodelsamples/service.svc. -->
<endpoint address=""
binding="wsHttpBinding"
contract="Microsoft.ServiceModel.Samples.ICalculator" />
...
</service>
</services>
服務會在 IIS 或 WAS 主機所提供的基地址公開端點。 繫結被配置為標準的 WSHttpBinding,它提供了 HTTP 通訊以及標準網路服務的通訊協議用於尋址和安全性。 合約是由服務 ICalculator
實作。
如設定,服務可由同一部計算機上的用戶端存取 http://localhost/servicemodelsamples/service.svc
。 為了讓遠端電腦上的客戶端能夠存取服務,必須提供完整域名,而不是localhost。
架構預設不會公開元數據。 因此,該服務將啟動 ServiceMetadataBehavior 並開放元數據交換(MEX)端點於 http://localhost/servicemodelsamples/service.svc/mex
。 下列組態示範這一點。
<system.serviceModel>
<services>
<service
name="Microsoft.ServiceModel.Samples.CalculatorService"
behaviorConfiguration="CalculatorServiceBehavior">
...
<!-- the mex endpoint is exposed at
http://localhost/servicemodelsamples/service.svc/mex -->
<endpoint address="mex"
binding="mexHttpBinding"
contract="IMetadataExchange" />
</service>
</services>
<!--For debugging purposes set the includeExceptionDetailInFaults
attribute to true-->
<behaviors>
<serviceBehaviors>
<behavior name="CalculatorServiceBehavior">
<serviceMetadata httpGetEnabled="True"/>
<serviceDebug includeExceptionDetailInFaults="False" />
</behavior>
</serviceBehaviors>
</behaviors>
</system.serviceModel>
用戶端會使用 ServiceModel 元數據公用程式工具 (Svcutil.exe) 所產生的用戶端類別,使用指定的合約類型進行通訊。 這個產生的用戶端包含在檔案generatedClient.cs或generatedClient.vb中。 此公用程式會擷取指定服務的元數據,併產生用戶端供用戶端應用程式使用指定的合約類型進行通訊。 託管服務必須可供產生用戶端程式代碼,因為服務是用來擷取更新的元數據。
在客戶端目錄中的 SDK 命令提示字元下,執行下列命令以生成具類型代理。
svcutil.exe /n:"http://Microsoft.ServiceModel.Samples,Microsoft.ServiceModel.Samples" http://localhost/servicemodelsamples/service.svc/mex /out:generatedClient.cs
若要在 Visual Basic 中產生用戶端,請從 SDK 命令提示字元輸入下列命令:
Svcutil.exe /n:"http://Microsoft.ServiceModel.Samples,Microsoft.ServiceModel.Samples" http://localhost/servicemodelsamples/service.svc/mex /l:vb /out:generatedClient.vb
藉由使用產生的用戶端,用戶端可以藉由設定適當的位址和系結來存取指定的服務端點。 如同服務,用戶端會使用組態檔 (App.config) 來指定其想要通訊的端點。 用戶端端點組態是由服務端點、系結和合約的絕對位址所組成,如下列範例所示。
<client>
<endpoint
address="http://localhost/servicemodelsamples/service.svc"
binding="wsHttpBinding"
contract=" Microsoft.ServiceModel.Samples.ICalculator" />
</client>
用戶端實作會具現化用戶端,並使用具型別介面開始與服務通訊,如下列範例程式代碼所示。
' Create a client
Dim client As New CalculatorClient()
' Call the Add service operation.
Dim value1 = 100.0R
Dim value2 = 15.99R
Dim result = client.Add(value1, value2)
Console.WriteLine("Add({0},{1}) = {2}", value1, value2, result)
' Call the Subtract service operation.
value1 = 145.00R
value2 = 76.54R
result = client.Subtract(value1, value2)
Console.WriteLine("Subtract({0},{1}) = {2}", value1, value2, result)
' Call the Multiply service operation.
value1 = 9.00R
value2 = 81.25R
result = client.Multiply(value1, value2)
Console.WriteLine("Multiply({0},{1}) = {2}", value1, value2, result)
' Call the Divide service operation.
value1 = 22.00R
value2 = 7.00R
result = client.Divide(value1, value2)
Console.WriteLine("Divide({0},{1}) = {2}", value1, value2, result)
'Closing the client gracefully closes the connection and cleans up resources
// Create a client.
CalculatorClient client = new CalculatorClient();
// Call the Add service operation.
double value1 = 100.00D;
double value2 = 15.99D;
double result = client.Add(value1, value2);
Console.WriteLine("Add({0},{1}) = {2}", value1, value2, result);
// Call the Subtract service operation.
value1 = 145.00D;
value2 = 76.54D;
result = client.Subtract(value1, value2);
Console.WriteLine("Subtract({0},{1}) = {2}", value1, value2, result);
// Call the Multiply service operation.
value1 = 9.00D;
value2 = 81.25D;
result = client.Multiply(value1, value2);
Console.WriteLine("Multiply({0},{1}) = {2}", value1, value2, result);
// Call the Divide service operation.
value1 = 22.00D;
value2 = 7.00D;
result = client.Divide(value1, value2);
Console.WriteLine("Divide({0},{1}) = {2}", value1, value2, result);
//Closing the client releases all communication resources.
client.Close();
當您執行範例時,作業要求和回應會顯示在用戶端控制台視窗中。 在客戶端視窗中按 ENTER 鍵以關閉用戶端。
Add(100,15.99) = 115.99
Subtract(145,76.54) = 68.46
Multiply(9,81.25) = 731.25
Divide(22,7) = 3.14285714285714
Press <ENTER> to terminate client.
用戶入門範例會顯示建立服務和客戶端的標準方式。 其他的 基本 組建版本基於此範例來示範特定的產品功能。
要設定、建置和執行範例,請執行以下步驟:
請確定您已針對 Windows Communication Foundation 範例 執行One-Time 安裝程式。
若要建置解決方案的 C# 或 Visual Basic .NET 版本,請遵循建置 Windows Communication Foundation 範例 中中的指示。
若要在單一或跨計算機組態中執行範例,請遵循 執行 Windows Communication Foundation 範例中的指示。