入门示例

2025-06-19

GettingStarted 示例演示如何使用 Windows Communication Foundation（WCF）实现典型服务和典型客户端。此示例是所有其他基本技术示例的基础。

注释

本示例的设置过程和生成说明位于本主题末尾。

该服务在服务协议中描述其执行的操作，并将其作为元数据公开。该服务还包含实现操作的代码。

客户端包含服务协定的定义和用于访问服务的代理类。代理代码是使用 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 通信以及用来进行寻址和实现安全性的标准 Web 服务协议。协定是由服务实现的 ICalculator。

正如所配置的，服务可以由同一计算机上的客户端在 http://localhost/servicemodelsamples/service.svc 访问。要使远程计算机上的客户端能够访问该服务，必须指定完全限定的域名，而不是 localhost。

默认情况下，框架不会公开元数据。因此，服务打开 ServiceMetadataBehavior 并在 http://localhost/servicemodelsamples/service.svc/mex 公开元数据交换 (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 示例中的说明执行操作。

通过

入门示例

设置、生成和运行示例

另请参阅

其他资源