Windows Communication Foundation (WCF) 允许开发人员使用代码或配置文件配置服务。 当部署之后需要对服务进行配置时,配置文件十分有用。 在使用配置文件时,IT 专业人员只需要更新配置文件,无需重新编译。 不过,配置文件可能十分复杂,难以维护。 不支持对配置文件进行调试,并且将按名称来引用配置元素,这使得配置文件的创作易于出错且较为困难。 WCF 还允许您在代码中配置服务。 在早期版本的代码中的 WCF (4.0 及更早版本) 配置服务很容易在自承载方案中,xref:System.ServiceModel.ServiceHost类允许您配置终结点和调用 ServiceHost.Open 之前的行为。 但是,在 Web 承载方案中,你不具备针对 xref:System.ServiceModel.ServiceHost 类的直接访问权限。 若要配置 Web 承载的服务,你需要创建 System.ServiceModel.ServiceHostFactory,后者会创建 xref:System.ServiceModel.Activation.ServiceHostFactory 并执行任何所需的配置。 从.NET 4.5 开始,WCF 提供了更简单的方法同时配置两者自托管,web 托管代码中的服务。
Configure 方法
只需在您的服务实现类中使用以下签名定义名为 Configure 的公共静态方法:
public static void Configure(ServiceConfiguration config)
Configure 方法采用 xref:System.ServiceModel.ServiceConfiguration 实例,使开发者可以添加终结点和行为。 打开服务主机之前,将由 WCF 调用此方法。 定义后,将忽略 app.config 或 web.config 文件中指定的任何服务配置设置。
下面的代码段阐释如何定义 Configure 方法和添加服务终结点、终结点行为以及服务行为:
public class Service1 : IService1
{
public static void Configure(ServiceConfiguration config)
{
ServiceEndpoint se = new ServiceEndpoint(new ContractDescription("IService1"), new BasicHttpBinding(), new EndpointAddress("basic"));
se.Behaviors.Add(new MyEndpointBehavior());
config.AddServiceEndpoint(se);
config.Description.Behaviors.Add(new ServiceMetadataBehavior { HttpGetEnabled = true });
config.Description.Behaviors.Add(new ServiceDebugBehavior { IncludeExceptionDetailInFaults = true });
}
public string GetData(int value)
{
return $"You entered: {value}";
}
public CompositeType GetDataUsingDataContract(CompositeType composite)
{
if (composite == null)
{
throw new ArgumentNullException("composite");
}
if (composite.BoolValue)
{
composite.StringValue += "Suffix";
}
return composite;
}
}
要为服务启用协议(如 https),可以显式添加使用协议的终结点,也可以通过调用 ServiceConfiguration.EnableProtocol(Binding) 自动添加终结点,这样可为与协议兼容的每个基址和定义的每个服务协定添加终结点。 下面的代码演示如何使用 ServiceConfiguration.EnableProtocol 方法:
public class Service1 : IService1
{
public string GetData(int value);
public static void Configure(ServiceConfiguration config)
{
// Enable "Add Service Reference" support
config.Description.Behaviors.Add( new ServiceMetadataBehavior { HttpGetEnabled = true });
// set up support for http, https, net.tcp, net.pipe
config.EnableProtocol(new BasicHttpBinding());
config.EnableProtocol(new BasicHttpBinding());
config.EnableProtocol(new NetTcpBinding());
config.EnableProtocol(new NetNamedPipeBinding());
// add an extra BasicHttpBinding endpoint at http:///basic
config.AddServiceEndpoint(typeof(IService1), new BasicHttpBinding(),"basic");
}
}
中的设置 <protocolMappings> 部分才使用任何应用程序终结点添加到xref:System.ServiceModel.ServiceConfiguration以编程方式。您可以根据需要加载服务配置从默认应用程序配置文件通过调用xref:System.ServiceModel.ServiceConfiguration.LoadFromConfiguration*然后更改设置。 xref:System.ServiceModel.ServiceConfiguration.LoadFromConfiguration 类还允许您从集中式配置加载配置。 下面的代码演示如何实现这一点:
public class Service1 : IService1
{
public void DoWork();
public static void Configure(ServiceConfiguration config)
{
config.LoadFromConfiguration(ConfigurationManager.OpenMappedExeConfiguration(new ExeConfigurationFileMap { ExeConfigFilename = @"c:\sharedConfig\MyConfig.config" }, ConfigurationUserLevel.None));
}
}
Important: 请注意,xref:System.ServiceModel.ServiceConfiguration.LoadFromConfiguration*忽略 <
host> 中的设置 <service> 标记 <system.serviceModel>。 从概念上讲,<host> 是有关主机配置、 不服务配置,以及它在 Configure 方法执行之前进行加载。
请参阅
- 使用配置文件配置服务
- 配置客户端行为
- 简化配置
- 配置
- IIS 和 WAS 中的基于配置的激活
- 配置和元数据支持
- 配置
- 如何:在配置中指定服务绑定
- 如何:在配置中创建的服务终结点
- 如何:发布使用配置文件服务的元数据
- 如何:在配置中指定客户端绑定
历史资料。此文对应 2019-08-18 的中文文档快照,适用产品版本和命令行为以原文为准。
来源与署名:Microsoft 和文档贡献者。固定版本原文。文档采用 CC BY 4.0,示例代码采用 MIT 授权。本站将 Markdown 转为 HTML,规范化链接,移除外部媒体和导航标记。
