简介：WCF（Windows Communication Foundation）是.NET框架下一种用于构建分布式应用的服务通信架构。本示例源码通过控制台应用，详细展示了WCF服务的创建、部署、以及客户端与服务的交互过程。源码中包含服务端与客户端项目的结构，服务接口和服务实现的定义，服务宿主与客户端通道的创建，以及WCF服务在IIS和Windows服务中的部署。通过学习这些代码，开发者可以全面了解WCF服务的设计和客户端的调用，掌握WCF服务的生命周期管理和客户端消费服务的关键概念。 
1. WCF概念和框架介绍
1.1 WCF概述
Windows Communication Foundation（WCF）是.NET框架下的一个开发库，旨在简化企业级分布式应用程序的开发。通过WCF，开发者能够构建安全、可靠、可互操作的服务。
1.2 WCF框架核心组件
WCF框架的核心由服务合约（Service Contract）、消息合约（Message Contract）、数据合约（Data Contract）以及宿主（Host）等组成，允许以统一方式处理各种通信协议和消息格式。
1.3 WCF框架的优势
WCF提供了丰富的特性集，例如支持多种传输协议（如HTTP、TCP等）、多种编码方式（如XML、JSON等）和消息交换模式（如请求/响应、单向消息等）。这使得WCF成为构建跨平台分布式应用程序的首选框架。
2. WCF服务的创建与实现
在本章中，我们将深入探讨如何创建WCF服务以及实现服务的具体步骤。首先从一个基本的控制台应用程序开始，逐步展示如何构建一个功能完整的WCF服务。
2.1 控制台应用中的WCF服务实现
2.1.1 创建控制台应用
在创建WCF服务之前，你需要具备一个基础的控制台应用程序。这个控制台应用程序将作为我们的起点。请按照以下步骤操作：
- 打开Visual Studio。
- 选择 "File" > "New" > "Project..." 以打开 "New Project" 对话框。
- 在 "Templates" 列表中，选择 "Visual C#" > "Windows" > "Console Application"。
- 命名你的项目，例如 "WCFConsoleApp"，然后点击 "OK"。
这样你就成功创建了一个基本的控制台应用程序，我们可以在此基础上添加WCF服务。
2.1.2 引入必要的WCF命名空间
创建了控制台应用之后，接下来需要引入WCF服务所需的命名空间。打开 Program.cs 文件，并确保项目中包含以下using指令：
using System.ServiceModel;
这一命名空间包含了WCF编程模型的主要类和接口，是实现WCF服务的基石。
2.2 服务接口和服务实现文件定义
2.2.1 定义服务接口
WCF服务的核心是定义一个服务接口。这个接口是服务与客户端通信的契约。创建一个名为 IService.cs 的新文件，并定义一个服务接口：
[ServiceContract]
public interface IService
{
[OperationContract]
string SayHello(string name);
}
这里 [ServiceContract] 属性标记了类为一个服务契约，而 [OperationContract] 标记了 SayHello 方法为一个可供外部调用的操作。
2.2.2 实现服务接口
现在我们需要实现接口定义的服务。创建一个名为 Service.cs 的新文件，并实现我们的服务接口：
public class Service : IService
{
public string SayHello(string name)
{
return $"Hello, {name}!";
}
}
这个简单的方法会返回一个问候信息，其中包含传入的 name 参数。
以上步骤，我们完成了WCF服务的基本创建和实现，为后续的服务契约定义和业务逻辑实现奠定了基础。在下一小节中，我们将探讨服务契约与业务逻辑的具体实现，进一步深入WCF服务的开发过程。
3. WCF服务契约与业务逻辑
WCF服务的核心在于服务契约和服务业务逻辑的实现。服务契约定义了服务对外暴露的接口，是服务通信的蓝图，它描述了服务支持的操作以及如何与服务进行交互。在这一章节中，我们将深入探讨如何编写服务契约，以及如何实现服务的业务逻辑。
3.1 服务契约和服务业务逻辑实现
3.1.1 编写服务契约
服务契约通常通过定义一个或多个接口来实现，这些接口使用WCF提供的 ServiceContract 属性进行标记。每个服务操作则通过 OperationContract 属性标记。这样的接口和操作定义了服务的边界，并为客户端提供了可以调用的操作。
using System.ServiceModel;
// 定义服务契约接口
[ServiceContract]
public interface ICalculatorService
{
// 定义服务操作契约
[OperationContract]
int Add(int a, int b);
[OperationContract]
int Subtract(int a, int b);
[OperationContract]
int Multiply(int a, int b);
[OperationContract]
double Divide(double a, double b);
}
在上述代码中， ICalculatorService 接口定义了一个计算器服务契约，包含了四个数学运算操作。每个操作都被 [OperationContract] 属性标记，表明这些操作可以被客户端调用。
3.1.2 实现服务业务逻辑
实现服务业务逻辑意味着创建一个类，它实现了契约接口并提供了每个操作的具体逻辑。
using System;
public class CalculatorService : ICalculatorService
{
public int Add(int a, int b)
{
return a + b;
}
public int Subtract(int a, int b)
{
return a - b;
}
public int Multiply(int a, int b)
{
return a * b;
}
public double Divide(double a, double b)
{
if(b == 0)
throw new DivideByZeroException("Cannot divide by zero.");
return a / b;
}
}
在这个示例中， CalculatorService 类实现了 ICalculatorService 接口。每个方法都按照数学运算的逻辑进行了实现。对于除法，如果除数为零，方法抛出 DivideByZeroException 异常，以确保服务的健壮性。
3.2 使用ServiceHost类运行测试WCF服务
3.2.1 配置ServiceHost类
要运行和测试WCF服务，通常会使用 ServiceHost 类。它允许开发者配置和启动WCF服务，包括定义服务地址、绑定和契约。
using System.ServiceModel;
// 创建服务主机实例
using(ServiceHost host = new ServiceHost(typeof(CalculatorService)))
{
try
{
// 配置端点
host.AddServiceEndpoint(
typeof(ICalculatorService),
new BasicHttpBinding(),
"***");
// 打开服务主机，允许通信
host.Open();
Console.WriteLine("服务已经启动...");
// 持续运行，直到用户选择停止
Console.WriteLine("按任意键停止服务...");
Console.ReadKey();
// 关闭服务主机
host.Close();
}
catch(Exception ex)
{
// 处理异常
Console.WriteLine("服务启动失败: " + ex.Message);
}
}
上述代码片段创建了一个 ServiceHost 实例，指定了服务实现类 CalculatorService 。接着，我们添加了一个服务端点，其中指定了服务契约 ICalculatorService ，绑定使用的是 BasicHttpBinding ，这是最简单的绑定方式之一，适合测试。我们还定义了服务的地址。然后，通过调用 host.Open() 启动服务。
3.2.2 运行和测试服务
在实际应用中，运行WCF服务后，我们需要测试该服务是否按照预期工作。可以通过创建一个客户端程序来测试服务。在WCF中，这通常通过 ChannelFactory 来完成。
using System.ServiceModel;
// 创建ChannelFactory实例
ChannelFactory<ICalculatorService> factory = new ChannelFactory<ICalculatorService>(
new BasicHttpBinding(),
new EndpointAddress("***"));
// 创建服务的代理
ICalculatorService proxy = factory.CreateChannel();
try
{
// 调用服务操作
int additionResult = proxy.Add(5, 3);
Console.WriteLine("5 + 3 = {0}", additionResult);
// 调用其他操作...
// 关闭代理
((IClientChannel)proxy).Close();
}
catch (Exception ex)
{
// 处理异常
Console.WriteLine("服务调用失败: " + ex.Message);
}
// 关闭ChannelFactory
factory.Close();
在这个测试客户端代码中，我们首先创建了一个 ChannelFactory 实例，用与服务端相同的绑定和地址配置。然后，通过 factory.CreateChannel() 创建了一个服务的代理对象。通过这个代理对象，我们可以像调用本地方法一样调用远程服务的方法。当测试完成，我们关闭了服务代理和 ChannelFactory 实例。
通过上述章节内容，我们不仅学习了如何编写和实现WCF服务契约，还展示了如何使用 ServiceHost 类来运行和测试WCF服务。在实际开发中，这些知识是构建和测试WCF服务的基础，对5年以上的IT专业人员同样具有实践价值。
4. WCF服务与客户端通信
4.1 客户端应用通过ChannelFactory与服务通信
4.1.1 创建客户端应用
在WCF的客户端通信中，ChannelFactory是用来创建通道的工厂类，它能够根据所提供的服务契约接口动态创建通道。创建客户端应用程序是为了连接到WCF服务，并与之交换消息。
步骤
- 创建客户端项目： 在Visual Studio中，创建一个新的控制台应用程序或Windows窗体应用程序，用来承载客户端代码。
- 添加服务引用： 可以通过Visual Studio的“添加服务引用”功能，将WCF服务引用到客户端项目中，这样能够自动生成服务的代理类和相关配置。
- 使用ChannelFactory： 如果需要更灵活的配置或自定义通信过程，可以通过代码直接使用ChannelFactory创建通道。
4.1.2 使用ChannelFactory与服务端通信
使用ChannelFactory与WCF服务端通信涉及到几个关键步骤，包括通道的创建、操作的调用以及通信的管理。
步骤
- 添加服务引用： 在客户端项目中，添加对WCF服务的引用，Visual Studio会自动生成服务的代理类。
- 配置服务终结点： 如果没有使用Visual Studio的“添加服务引用”功能，需要在客户端配置服务终结点，指定服务的地址、绑定类型和契约。
- 实例化ChannelFactory： 创建一个ChannelFactory实例，传入服务契约接口，可选地传入绑定配置。
- 打开通道： 调用ChannelFactory的CreateChannel方法创建服务通道，并确保通道处于打开状态。
- 调用服务操作： 通过创建的服务通道实例调用服务端的操作方法。
- 关闭通道： 通信完成后，应关闭通道以释放资源。
示例代码
// 假设有一个名为IService1的服务契约接口和对应的通道接口IService1Channel
ChannelFactory<IService1Channel> factory = new ChannelFactory<IService1Channel>("MyEndpointConfiguration");
IService1Channel channel = factory.CreateChannel();
try
{
// 调用服务端操作
string response = channel.DoWork();
Console.WriteLine("Service response: " + response);
}
catch (CommunicationException commEx)
{
// 处理通信异常
Console.WriteLine("Communication error: " + commEx.Message);
}
finally
{
// 确保通道被关闭
if (channel != null && channel.State == CommunicationState.Opened)
{
channel.Close();
}
}
// 关闭Factory
factory.Close();
表格：使用ChannelFactory与服务端通信的对比
| 特性 | 使用服务代理类 | 使用ChannelFactory | | --- | --- | --- | | 配置复杂度 | 低 | 高 | | 灵活性 | 低 | 高 | | 代码编写量 | 少 | 多 | | 性能 | 较高 | 较低 | | 适用场景 | 大部分标准通信 | 需要自定义绑定或行为 |
Mermaid流程图：客户端使用ChannelFactory与服务通信的流程
graph LR
A[开始] --> B[创建ChannelFactory]
B --> C[打开通道]
C --> D[调用服务操作]
D --> E[关闭通道]
E --> F[结束]
4.2 WCF服务部署到IIS 6和IIS 7
4.2.1 准备IIS环境
在部署WCF服务到IIS之前，需要确保IIS环境已经安装好，并且具备必要的配置。无论是IIS 6还是IIS 7，都需要确保安装了.NET Framework以及WCF服务主机模块。
步骤
- 安装.NET Framework： 确保目标服务器上安装了与服务兼容的.NET Framework版本。
- 安装WCF服务主机模块： 对于IIS 6, 可能需要安装WAS (Windows Activation Services)。对于IIS 7及以上版本，WCF服务宿主功能已经集成。
- 配置IIS角色服务： 在IIS管理器中，确保已启用适当的IIS角色服务，如"Web服务器(IIS)"和"应用程序开发"下的"WCF服务"。
4.2.2 部署WCF服务到IIS
部署WCF服务到IIS涉及到将服务程序集放置到正确的应用程序池，并进行必要的配置。
步骤
- 创建应用程序池： 在IIS管理器中，创建一个新的应用程序池，指定.NET Framework版本和托管管道模式。
- 创建网站： 在IIS中创建一个新的网站，并将应用程序池设置为上面创建的池。
- 上传服务程序集： 将WCF服务的程序集上传到网站的bin目录下。
- 配置服务文件(.svc)： 创建一个.svc文件，指定服务类和任何必要的服务配置。
- 配置Web.config： 如果需要额外的绑定或行为配置，修改或添加Web.config文件。
- 启动网站： 部署完成之后，启动IIS中的网站。
代码块：配置IIS中的WCF服务绑定
在 Web.config 文件中，可以配置自定义绑定，例如：
<system.serviceModel>
<bindings>
<basicHttpBinding>
<binding name="CustomBasicHttpBinding" ... />
</basicHttpBinding>
</bindings>
<services>
<service name="MyNamespace.ServiceClass">
<endpoint address="" binding="basicHttpBinding" bindingConfiguration="CustomBasicHttpBinding" contract="MyNamespace.IServiceContract"/>
<host>
<baseAddresses>
<add baseAddress="***"/>
</baseAddresses>
</host>
</service>
</services>
</system.serviceModel>
参数说明
- name : 服务类的名称。
- contract : 服务契约接口的名称。
- binding : 使用的绑定类型。
- bindingConfiguration : 指定绑定的配置名称。
- baseAddress : 服务的基础地址。
通过以上步骤，客户端应用可以通过ChannelFactory与WCF服务进行通信，同时也可以将WCF服务部署到IIS环境中，从而支持更多类型的客户端访问。接下来的章节，我们将探讨WCF服务的高级特性和客户端消费WCF服务的其他方式。
5. WCF服务的高级特性与客户端消费
WCF（Windows Communication Foundation）不仅仅是一个基础框架，它还提供了许多高级特性，允许开发者构建更灵活、更强大的分布式系统。这一章节将深入探讨WCF服务的高级用法，包括如何在Windows服务中宿主WCF服务，如何管理WCF服务的生命周期，以及客户端消费服务的不同方式。
5.1 Windows服务中宿主WCF服务
5.1.1 创建Windows服务宿主
在Windows服务中宿主WCF服务是一种常见的部署方式，尤其是在需要将WCF服务作为系统服务运行时。以下是创建Windows服务宿主的基本步骤：
- 创建Windows服务项目 ：在Visual Studio中选择创建新的Windows服务项目。
- 添加WCF服务引用 ：在服务项目中添加对WCF服务的引用。
- 编写服务宿主代码 ：在Windows服务的
OnStart方法中编写代码，以配置和启动服务宿主。
示例代码如下：
using System.ServiceProcess;
using System.ServiceModel;
using System.ServiceModel.Description;
public partial class WindowsService1 : ServiceBase
{
ServiceHost serviceHost;
public WindowsService1()
{
InitializeComponent();
}
protected override void OnStart(string[] args)
{
// 创建服务宿主
serviceHost = new ServiceHost(typeof(MyWcfService));
serviceHost.AddServiceEndpoint(typeof(IMyServiceContract), new BasicHttpBinding(), "MyWcfService");
// 打开服务宿主
serviceHost.Open();
}
protected override void OnStop()
{
if (serviceHost != null)
{
serviceHost.Close();
serviceHost = null;
}
}
}
5.1.2 配置和运行Windows服务中的WCF
在宿主WCF服务之前，需要对服务进行适当的配置。这可以通过直接在代码中进行设置，也可以通过外部配置文件来实现。以下是通过代码配置WCF服务的示例：
// 配置服务行为
ServiceBehaviorAttribute serviceBehavior = new ServiceBehaviorAttribute();
serviceBehavior.InstanceContextMode = InstanceContextMode.PerCall;
serviceHost.Description.Behaviors.Add(serviceBehavior);
// 添加服务元数据
ServiceMetadataBehavior metadataBehavior = new ServiceMetadataBehavior();
metadataBehavior.HttpGetEnabled = true;
serviceHost.Description.Behaviors.Add(metadataBehavior);
在配置完成后，可以将服务安装为Windows服务，并在Windows服务控制面板中启动服务。
5.2 WCF服务生命周期管理
5.2.1 生命周期事件处理
WCF服务的生命周期包括打开、关闭、关闭、故障和故障恢复等状态变化。通过实现服务生命周期接口（如 IContractBehavior 、 IEndpointBehavior 、 IOperationBehavior ），可以在服务的生命周期的不同阶段插入自定义行为。
示例代码展示如何处理服务关闭事件：
public class MyServiceBehavior : IContractBehavior
{
public void ApplyDispatchBehavior(ContractDescription contractDescription, ServiceEndpoint endpoint, DispatchRuntime dispatchRuntime)
{
dispatchRuntime.ServiceHostClosed += OnServiceHostClosed;
}
private void OnServiceHostClosed(object sender, EventArgs e)
{
Console.WriteLine("服务已关闭！");
}
}
5.2.2 自定义服务行为以管理生命周期
可以通过实现自定义服务行为来管理和扩展WCF服务的生命周期。例如，创建一个自定义行为来在服务关闭时释放资源。
public class MyServiceBehaviorAttribute : Attribute, IServiceBehavior
{
public void ApplyDispatchBehavior(ContractDescription contractDescription, ServiceEndpoint endpoint, DispatchRuntime dispatchRuntime)
{
// 实现资源清理逻辑
}
public void AddBindingParameters(ContractDescription contractDescription, ServiceEndpoint endpoint, BindingParameterCollection bindingParameters)
{
// 可以添加额外的绑定参数
}
public void ApplyClientBehavior(ContractDescription contractDescription, ServiceEndpoint endpoint, ClientRuntime clientRuntime)
{
// 可以添加客户端行为
}
public void Validate(ContractDescription contractDescription, ServiceEndpoint endpoint)
{
// 可以在这里进行服务契约的验证
}
}
5.3 客户端消费服务的方式
5.3.1 使用Add Service Reference添加服务引用
客户端通常通过Visual Studio中的"Add Service Reference"功能来添加服务引用，从而生成服务的客户端代理类。
- 在Visual Studio中打开项目 。
- 选择项目菜单中的"Add Service Reference" 。
- 输入WCF服务的地址 ，Visual Studio将自动发现服务并提供添加引用的选项。
5.3.2 动态客户端代理的创建与使用
虽然添加服务引用的方式是最常见的，但在某些情况下可能需要动态地创建客户端代理，例如在运行时确定服务地址或创建通用客户端。动态客户端代理可以通过 ChannelFactory 来创建。
示例代码如下：
ChannelFactory<IMyServiceContract> factory = new ChannelFactory<IMyServiceContract>(new BasicHttpBinding(), new EndpointAddress("***"));
IMyServiceContract proxy = factory.CreateChannel();
// 使用代理调用服务操作
proxy.MyServiceOperation();
// 注意：调用完成后需要关闭代理
((IClientChannel)proxy).Close();
这种方法提供更大的灵活性，允许在运行时构建和配置客户端代理。
在本章中，我们探讨了WCF服务在Windows服务中的宿主、服务生命周期的管理以及客户端如何消费WCF服务的高级方式。这些高级特性为开发者提供了更多的灵活性和控制力，使得WCF服务可以更好地适应各种复杂的应用场景。在实际应用中，选择合适的服务部署方式和生命周期管理策略是确保服务稳定性和可维护性的关键。而动态客户端代理的使用，则为服务消费提供了更多的灵活性和扩展能力。
简介：WCF（Windows Communication Foundation）是.NET框架下一种用于构建分布式应用的服务通信架构。本示例源码通过控制台应用，详细展示了WCF服务的创建、部署、以及客户端与服务的交互过程。源码中包含服务端与客户端项目的结构，服务接口和服务实现的定义，服务宿主与客户端通道的创建，以及WCF服务在IIS和Windows服务中的部署。通过学习这些代码，开发者可以全面了解WCF服务的设计和客户端的调用，掌握WCF服务的生命周期管理和客户端消费服务的关键概念。
664
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
