WCF快速入门

WCF简述

Windows Communication Foundation(WCF)是由微软发展的一组数据通信的应用程序开发接口，它是.NET框架的一部分，由 .NET Framework 3.0 开始引入，与 Windows Presentation Foundation 及 Windows Workflow Foundation 并行为新一代 Windows 操作系统以及 WinFX 的三个重大应用程序开发类库。在 .NET Framework 2.0 以及前版本中，微软发展了 Web Service (SOAP with HTTP communication)，.NET Remoting (TCP/HTTP/Pipeline communication) 以及基础的 Winsock 等通信支持，由于各个通信方法的设计方法不同，而且彼此之间也有相互的重叠性（例如 .NET Remoting 可以开发 SOAP, HTTP 通信），对于开发人员来说，不同的选择会有不同的程序设计模型，而且必须要重新学习，让开发人员在使用中有许多不便。同时，面向服务架构(Service-Oriented Architecture) 也开始盛行于软件工业中，因此微软重新查看了这些通信方法，并设计了一个统一的程序开发模型，对于数据通信提供了最基本最有弹性的支持，这就是 Windows Communication Foundation。

重要概念

　　WCF 由于集合了几乎由 .NET Framework 所提供的通信方法，因此学习曲线比较陡峭，开发人员必须要针对各个部份的内涵做深入的了解，才能够操控 WCF 来开发应用程序。

通信双方的沟通方式，由合约来订定。通信双方所遵循的通信方法，由协议绑定来订定。通信期间的安全性，由双方约定的安全性层次来订定。

合约（Contract）

WCF 的基本概念是以合约 (Contract) 来定义双方沟通的协议，合约必须要以接口的方式来体现，而实际的服务代码必须要由这些合约接口派生并实现。合约分成了四种：

数据合约(Data Contract)，订定双方沟通时的数据格式。

服务合约(Service Contract)，订定服务的定义。

操作合约(Operation Contract)，订定服务提供的方法。

消息合约(Message Contract)，订定在通信期间改写消息内容的规范。

一个 WCF 中的合约，就如同下列代码所示：

[ServiceContract(Namespace = "http://Microsoft.ServiceModel.Samples")]
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);

}

　　

协议绑定 (Binding)

由于 WCF 支持了HTTP，TCP，Named Pipe，MSMQ，Peer-To-Peer TCP 等协议，而 HTTP 又分为基本 HTTP 支持 (BasicHttpBinding) 以及 WS-HTTP 支持 (WsHttpBinding)，而 TCP 亦支持 NetTcpBinding，NetPeerTcpBinding 等通信方式，因此，双方必须要统一通信的协议，并且也要在编码以及格式上要有所一致。

一个设置通信协议绑定的示例如下：

<client>
<endpoint address="http://localhost:8000/ServiceModelSamples/Service/CalculatorService"
binding="wsHttpBinding" bindingConfiguration="WSHttpBinding_ICalculator"
contract="ICalculator" name="WSHttpBinding_ICalculator">
<identity>
<userPrincipalName value="WWW-E00E7DA5555\Administrator" />
</identity>
</endpoint>
</client>

　　 　　虽然 WCF 也可以使用SOAP做通信格式，但它和以往的ASP.NETXML Web Services不同，因此有部分技术文章中，会将 ASP.NET 的 XML Web Services 称为 ASMX Service。

WCF 的服务可以挂载于 Console Application，Windows Application，IIS (ASP.NET) Application，Windows Service 以及 Windows Activation Services 中，但大多都会挂在 Windows Service。

WCF的优势

　　概括地说，WCF具有如下的优势：

　　1、统一性

　　前面已经叙述，WCF是对于ASMX，.Net Remoting，Enterprise Service，WSE，MSMQ等技术的整合。由于WCF完全是由托管代码编写，因此开发WCF的应用程序与开发其它的.Net应用程序没有太大的区别，我们仍然可以像创建面向对象的应用程序那样，利用WCF来创建面向服务的应用程序。

　　2、互操作性

　　由于WCF最基本的通信机制是SOAP（Simple Object Access Protocol 简易对象访问协议），这就保证了系统之间的互操作性，即使是运行不同的上下文中。这种通信可以是基于.Net到.Net间的通信，如下图所示：

　　可以跨进程、跨机器甚至于跨平台的通信，只要支持标准的Web Service，例如J2EE应用服务器（如WebSphere，WebLogic）。应用程序可以运行在Windows操作系统下，也可以运行在其他的操作系统，如Sun Solaris，HP Unix，Linux等等。如下图所示：

　　3、安全与可信赖

　　WS-Security，WS-Trust和WS-SecureConversation均被添加到SOAP消息中，以用于用户认证，数据完整性验证，数据隐私等多种安全因素。

在SOAP 的header中增加了WS-ReliableMessaging允许可信赖的端对端通信。而建立在WS-Coordination和WS- AtomicTransaction之上的基于SOAP格式交换的信息，则支持两阶段的事务提交（two-phase commit transactions）

　　上述的多种WS-Policy在WCF中都给与了支持。对于Messaging而言，SOAP是Web Service的基本协议，它包含了消息头（header）和消息体(body)。在消息头中，定义了WS-Addressing用于定位SOAP消息的地址信息，同时还包含了MTOM（消息传输优化机制，Message Transmission Optimization Mechanism）。

　　4、兼容性

　　WCF充分的考虑到了与旧有系统的兼容性。安装WCF并不会影响原有的技术如ASMX和.Net Remoting。即使对于WCF和ASMX而言，虽然两者都使用了SOAP，但基于WCF开发的应用程序，仍然可以直接与ASMX进行交互。

安全性层次

　　WCF 实现上已经支持了传输层次安全性 (Transport-level security) 以及消息层次安全性 (Message-level security) 两种。

　　传输层次安全性：在数据传输时期加密，例如 SSL。消息层次安全性：在数据处理时就加密，例如使用数字签名，散列或是使用密钥加密法等。

这一系列文章的内容是从MSDN中COPY过来的，讲述的是最简单的WCF程序示例：如何在控制台应用程序实现和承载WCF服务，以及如何创建、配置和使用WCF客户端。

WCF服务层结构

定义WCF服务协定（任务一）

这是创建基本 Windows Communication Foundation (WCF) 服务和可以使用该服务的客户端所需的六项任务中的第一项任务。

创建基本 WCF 服务时，第一项任务是为与外界共享的服务创建协定，并在其中描述如何与该服务进行通信。

具体步骤为：

1、 创建新的控制台应用程序项目。 在“新建项目”对话框中，选中“Visual Basic”或“Visual C#”，并选择“控制台应用程序”模板，并命名为Service。 使用默认的位置。

2、将默认的Service命名空间更改为Microsoft.ServiceModel.Samples。

3、为项目提供对System.ServiceModel命名空间的引用：右击“解决方案资源管理器”中的“Service”项目，选择“添加引用”项，在弹出的对话框中的“.NET”选项卡里的“组件名称”中选择“System.ServiceModel”，然后单击“确定”。

下面是编程步骤：

1、为System.ServiceModel命名空间添加一个using语句。

using System.ServiceModel;

2、创建一个新的ICalculator接口，并将ServiceContractAttribute属性应用于该接口，并将Namespace值设置为“http://Microsoft.ServiceModel.Samples”。 此命名空间指定该服务在计算机上的路径，并构成该服务的基址部分。请注意，在通过采用方括号表示法的属性来批注接口或类时，该属性类可以从其名称中去掉“Attribute”部分。

[ServiceContract(Namespace = "http://Microsoft.ServiceModel.Samples")]

public interface ICalculator

3、在接口中创建方法声明，并将OperationContractAttribute属性应用于每个要作为公共 WCF 协定的一部分公开的方法。

[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);

下面是创建服务协定的完整代码段：

using System;

// Add the using statement for the Sytem.ServiceModel namespace

using System.ServiceModel;

namespace Microsoft.ServiceModel.Samples

{

// Define a service contract.

[ServiceContract(Namespace = "http://Microsoft.ServiceModel.Samples")]

public interface ICalculator

{

// Create the method declaration for the contract.

[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);

}

}

........（整个服务器端的代码未完，等讲完任务三时，再给出完整代码）

实现WCF服务协定（任务二）

1、创建一个新CalculatorService类，该类从用户定义的ICalculator接口继承而来并实现该接口定义的协定功能。

public class CalculatorService: ICalculator

2、实现每个算术运算符的功能。

publicdoubleAdd(double n1, double n2)

{

double result = n1 + n2;

Console.WriteLine("Received Add({0},{1})", n1, n2);

// Code added to write output to the console window.

Console.WriteLine("Return: {0}", result);

returnresult;

}

public double Subtract(double n1, double n2)

{

double result = n1 - n2;

Console.WriteLine("Received Subtract({0},{1})", n1, n2);

Console.WriteLine("Return: {0}", result);

return result;

}

public double Multiply(double n1, double n2)

{

double result = n1 * n2;

Console.WriteLine("Received Multiply({0},{1})", n1, n2);

Console.WriteLine("Return: {0}", result);

return result;

}

public double Divide(double n1, double n2)

{

double result = n1 / n2;

Console.WriteLine("Received Divide({0},{1})", n1, n2);

Console.WriteLine("Return: {0}", result);

return result;

}

在创建和实现了服务协定后，下一步是运行该服务。运行服务由三个步骤组成：配置、承载和打开服务。

配置、承载和运行服务（任务三）

• 为服务配置基址

为服务的基址创建Uri实例。 此 URI 指定 HTTP 方案、本地计算机、端口号 8000，以及服务协定中为服务命名空间指定的服务路径ServiceModelSample/Services。

Uri baseAddress = new Uri("http://localhost:8000/ServiceModelSamples/Service");

• 承载服务

1. 创建一个新的ServiceHost实例以承载服务。 必须指定实现服务协定和基址的类型。 对于此示例，我们将基址指定为http://localhost:8000/ServiceModelSamples/Services，并将CalculatorService指定为实现服务协定的类型。

ServiceHost selfHost = new ServiceHost(typeof(CalculatorService), baseAddress);

1. 添加一个捕获CommunicationException的try-catch语句，并在接下来的三个步骤中将该代码添加到 try 块中。
2. 添加公开服务的终结点。 为此，必须指定终结点公开的协议、绑定和终结点的地址。此例中，将ICalculator指定为协定，将WSHttpBinding指定为绑定，并将CalculatorService指定为地址。 在这里请注意，我们指定的是相对地址。 终结点的完整地址是基址和终结点地址的组合。 在此例中，完整地址是http://localhost:8000/ServiceModelSamples/Services/CalculatorService。

selfHost.AddServiceEndpoint( typeof(ICalculator), new WSHttpBinding(), "CalculatorService");

1. 启用元数据交换。 为此，必须添加服务元数据行为。 首先创建一个ServiceMetadataBehavior实例，将HttpGetEnabled属性设置为true，然后为服务添加新行为。

ServiceMetadataBehavior smb = new ServiceMetadataBehavior(); smb.HttpGetEnabled = true; selfHost.Description.Behaviors.Add(smb);

1. 打开ServiceHost并等待传入消息。 用户按 Enter 键时，关闭ServiceHost。

selfHost.Open();

Console.WriteLine("The service is ready.");

Console.WriteLine("Press <ENTER> to terminate service.");

Console.WriteLine();

Console.ReadLine();

// Close the ServiceHostBase to shutdown the service.

selfHost.Close();

下面是服务器端（即“Service”项目中program.cs文件中）的完整程序代码：

using System;

using System.ServiceModel;

using System.ServiceModel.Description;

namespace Microsoft.ServiceModel.Samples

{

// 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 that implements the service contract.

// Added code to write output to the console window.

public class CalculatorService : ICalculator

{

public double Add(double n1, double n2)

{

double result = n1 + n2;

Console.WriteLine("Received Add({0},{1})", n1, n2);

Console.WriteLine("Return: {0}", result);

return result;

}

public double Subtract(double n1, double n2)

{

double result = n1 - n2;

Console.WriteLine("Received Subtract({0},{1})", n1, n2);

Console.WriteLine("Return: {0}", result);

return result;

}

public double Multiply(double n1, double n2)

{

double result = n1 * n2;

Console.WriteLine("Received Multiply({0},{1})", n1, n2);

Console.WriteLine("Return: {0}", result);

return result;

}

public double Divide(double n1, double n2)

{

double result = n1 / n2;

Console.WriteLine("Received Divide({0},{1})", n1, n2);

Console.WriteLine("Return: {0}", result);

return result;

}

}

class Program

{

static voidMain(string[] args)

{

// Create a URI to serve as the base address.

Uri baseAddress = new Uri("http://localhost:8000/ServiceModelSamples/Service");

// Create ServiceHost

ServiceHost selfHost = new ServiceHost(typeof(CalculatorService), baseAddress);

try

{

// Add a service endpoint.

selfHost.AddServiceEndpoint(

typeof(ICalculator),

new WSHttpBinding(),

"CalculatorService");

// Enable metadata exchange.

ServiceMetadataBehavior smb = new ServiceMetadataBehavior();

smb.HttpGetEnabled = true;

selfHost.Description.Behaviors.Add(smb);

// Start (and then stop) the service.

selfHost.Open();

Console.WriteLine("The service is ready.");

Console.WriteLine("Press <ENTER> to terminate service.");

Console.WriteLine();

Console.ReadLine();

// Close the ServiceHostBase to shutdown the service.

selfHost.Close();

}

catch (CommunicationException ce)

{

Console.WriteLine("An exception occurred: {0}", ce.Message);

selfHost.Abort();

}

}

}

}

若要运行服务，启动项目文件夹下bin目录中的 Service.exe即可。

前面三篇文章是讲服务器端的部署和运行，下面讲讲客户端如何配置和使用。

WCF客户端结构

创建WCF客户端（任务四）

1. 通过执行以下步骤，在 Visual Studio 2005 中为客户端创建新项目：
   1. 在包含该服务（之前文章所述的服务）的同一解决方案中的“解决方案资源管理器”（位于右上角）中，右击当前解决方案，然后选择“添加新项目”。
   2. 在“添加新项目”对话框中，选择“Visual Basic”或“Visual C#”，选择“控制台应用程序”模板，然后将其命名为Client。 使用默认的位置。
   3. 单击“确定”。
2. 为项目提供对System.ServiceModel命名空间的引用：在“解决方案资源管理器”中右击“Service”项目，从“.NET”选项卡上的“组件名称”列中选择“System.ServiceModel”，然后单击“确定”。
3. 为System.ServiceModel命名空间添加using语句：using System.ServiceModel;
4. 启动在前面的步骤中创建的服务。（即打开在服务器项目中生成的Service.exe可执行文件）
5. 通过执行以下步骤，使用适当的开关运行Service Model Metadata Utility Tool (SvcUtil.exe)以创建客户端代码和配置文件：
   1. 通过选择“开始”菜单中的“Microsoft Windows SDK”项下的“CMD Shell”，启动 Windows SDK 控制台会话。
   2. 导航到要放置客户端代码的目录。 如果使用默认设置创建 Client 项目，则目录为 C:\Documents and Settings\<用户名>\Documents\Visual Studio 2008\Projects\Service\Client。
   3. 将命令行工具Service Model Metadata Utility Tool (SvcUtil.exe)与适当的开关一起使用以创建客户端代码。下面的示例生成服务的代码文件和配置文件。

svcutil.exe /language:cs /out:generatedProxy.cs /config:app.config http://localhost:8000/ServiceModelSamples/service

1. 在 Visual Studio 中将生成的代理添加到 Client 项目中，方法是在“解决方案资源管理器”中右击“Client”并选择“添加现有项”。 然后选择在上一步中生成的generatedProxy.cs文件。

配置WCF客户端（任务五）

在 Visual Studio 中，将在前一过程中生成的App.config配置文件添加到客户端项目中。 在“解决方案资源管理器”中右击该客户端，选择“添加现有项”，然后从 C:\Documents and Settings\<用户名>\Documents\Visual Studio 2008\Projects\Service\Client\bin 目录中选择 App.config配置文件。

将app.config添加到项目中后，就算是完成了wcf客户端的配置。因为具体的配置信息，我们在使用svcutil.exe工具时，它就帮我们配置好并写入了app.config文件。

使用WCF客户端（任务六）

1、为要调用的服务的基址创建EndpointAddress实例，然后创建 WCFClient对象。

//Create an endpoint address and an instance of the WCF Client.

EndpointAddress epAddress = new EndpointAddress("http://localhost:8000/ServiceModelSamples/Service/CalculatorService");

CalculatorClient client = new CalculatorClient(new WSHttpBinding(), epAddress);

2、从Client内调用客户端操作。

// Call the service operations.

// 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);

3、在 WCF 客户端上调用Close。

// Closing the client gracefully closes the connection and cleans up resources.

client.Close();

下面是客户端的完整代码：

using System;

using System.Collections.Generic;

using System.Text;

using System.ServiceModel;

namespace ServiceModelSamples

{

class Client

{

static voidMain()

{

//Step 1: Create an endpoint address and an instance of the WCF Client.

EndpointAddress epAddress = new EndpointAddress("http://localhost:8000/ServiceModelSamples/Service/CalculatorService");

CalculatorClient client = new CalculatorClient(new WSHttpBinding(), epAddress);

// Step 2: Call the service operations.

// 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);

//Step 3: Closing the client gracefully closes the connection and cleans up resources.

client.Close();

Console.WriteLine();

Console.WriteLine("Press <ENTER> to terminate client.");

Console.ReadLine();

}

}

}

若要启动客户端，请在“开始”菜单中的“Microsoft Windows SDK”项下选择“CMD Shell”，从而启动 Windows SDK 控制台会话。 定位至 C:\Documents and Settings\<用户名>\Documents\Visual Studio 2008\Projects\Service\Client\obj\Debug 目录，键入client，然后按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.