IServiceBehavior接口

描述：提供一种在整个服务内修改或插入自定义拓展机制；

命名空间： System.ServiceModel.Description
程序集： System.ServiceModel（在 System.ServiceModel.dll 中）

IServiceBehavior接口中有3个方法：

1.AddBindingParameters：该方法可以向绑定元素传递服务的自定义信息，这样绑定元素就可向服务提供正确的支持。

2.ApplyDispatchBehavior：该方法可以更改运行时属性值或插入自定义扩展对象，例如错误处理程序、消息或参数拦截器、安全扩展以及其他自定义扩展对象。

3.Validate：该方法可以在 WCF构造执行服务前检查说明，从而确认该执行服务是否可正确执行。

在上面的3个中最常用到的就是2和3，1本人还没有用过这里也就不使用了！！

方法：ApplyDispatchBehavior

该方法应该说是这个接口最主要的方法，我们要对服务进行自定义拓展也是通过它进行注入，下面我们举个例子使用IServiceBehavior对WCF服务异常的处理

大家都知道WCF一般是使用SAOP进行传输的，如果服务端出现异常客户端是只能够接收到FaultException异常，这里我们通过IServiceBehavior来解决使客户端可以接收到所有异常信息。

代码：

/// <summary>

/// WCF服务异常处理机制，服务的行为将默认的异常处理添加到所有通信的调度程序中

/// </summary>

[AttributeUsage(AttributeTargets.Class, AllowMultiple = true)]

public sealed class ServiceErrorHandlerBehavior

: Attribute, IServiceBehavior

{

/// <summary>

/// 用于更改运行时属性值或插入自定义扩展对象（例如错误处理程序、消息或参数拦截器、安全扩展以及其他自定义扩展对象）。

/// </summary>

/// <param name="serviceDescription"> 服务说明</param>

/// <param name="serviceHostBase"> 当前正在生成的宿主 </param>

public void ApplyDispatchBehavior( ServiceDescription serviceDescription, ServiceHostBase serviceHostBase)

{

if (serviceHostBase != null && serviceHostBase.ChannelDispatchers.Any())

{

foreach ( ChannelDispatcher dispatcher in serviceHostBase.ChannelDispatchers)

dispatcher.ErrorHandlers.Add( new InstallErrorHandler());

}

public void AddBindingParameters( ServiceDescription serviceDescription, ServiceHostBase serviceHostBase, Collection<ServiceEndpoint> endpoints, BindingParameterCollection bindingParameters)

{

//当前拓展机制不适用

}

public void Validate(ServiceDescription serviceDescription, ServiceHostBase serviceHostBase)

{

//当前拓展机制不适用

}

从ServiceHostBase宿主中遍历通道调度程序集ChannellDispatchers合并在每个ChannelDispatcher中的ErrorHandlers插入自定义异常ServiceErrorHandler,这样的话当WCF服务出现异常时就会转交给ServiceErrorHandler处理；

下面是InstallErrorHandler代码：

public class ServiceErrorHandler

: IErrorHandler

{

/// <summary>

/// 启用错误相关处理并返回一个值，该值指示调度程序在某些情况下是否中止会话和实例上下文。

/// </summary>

/// <param name="error">处理过程中引发的异常</param>

/// <returns></returns>

public bool HandleError(Exception error)

{

//不终止会话和实例上下文

return true;

}

/// <summary>

/// 启用创建从服务方法过程中的异常返回的自定义SOAP错误

/// </summary>

/// <param name="error">服务操作过程中引发的异常 </param>

/// <param name="version">消息的 SOAP 版本</param>

/// <param name="fault">双工情况下，返回到客户端或服务的通信单元对象 </param>

public void ProvideFault( Exception error, MessageVersion version, ref Message fault)

{

var faultException = error is FaultException ?

( FaultException)error : new FaultException(error.Message);

MessageFault messageFault = faultException.CreateMessageFault();

fault = Message.CreateMessage(version, messageFault, faultException.Action);

}

下面是使用方法，非常的简单，只需要在WCF服务类上打上ServiceErrorHandlerBehavior标记就可以了：

代码：

[ServiceErrorHandlerBehavior ]

public class Service1 : IService1

{

public string GetData(int value)

{

throw new Exception( "我的测试");

}

测试代码：

protected void Page_Load(object sender, EventArgs e)

{

WcfWrapper<ServiceReference1. Service1Client> wrapper = new WcfWrapper<ServiceReference1. Service1Client>();

wrapper.Using(client =>

{

xtResult.Text = client.GetData(1);

});

}

输出结果：

“/”应用程序中的服务器错误。

我的测试

说明: 执行当前 Web 请求期间，出现未经处理的异常。请检查堆栈跟踪信息，以了解有关该错误以及代码中导致错误的出处的详细信息。

异常详细信息: System.ServiceModel.FaultException: 我的测试

源错误:

行 114:
行 115:        public string GetData(int value) {
行 116:            return base.Channel.GetData(value);
行 117:        }
行 118:

源文件: f:\ZcyProject\Bulrush.Library\WebTest\Service References\ServiceReference1\Reference.cs 行: 116

当然除了使用Attribute特性也可以在WebConfig中配置，配置也非常的简单；

首先为ServiceErrorHandlerBehavior创建一个Behavior的拓展配置节点，代码如下：

public class ServiceErrorHandlerBehaviorExtension

: BehaviorExtensionElement

{

public override Type BehaviorType

{

get { return typeof( ServiceErrorHandlerBehavior); }

}

protected override object CreateBehavior()

{

return new ServiceErrorHandlerBehavior();

}

配置如下：

<system.serviceModel>

< service name =" WcfServiceTest.Service1" behaviorConfiguration="defaultBehavior" >

< endpoint address ="" binding =" basicHttpBinding" contract="WcfServiceTest.IService1" >

</ endpoint>

< host>

< baseAddresses>

< add baseAddress="http://localhost:2708/Service1.svc" />

</ baseAddresses>

</ host>

</ service>

</services>

< serviceBehaviors>

< behavior name =" defaultBehavior" >

< serviceMetadata httpGetEnabled =" true" httpsGetEnabled="true"/>

< serviceDebug includeExceptionDetailInFaults =" false" />

< ErrorBehavior />

</ behavior>

</ serviceBehaviors>

</behaviors>

< behaviorExtensions>

< add name= "ErrorBehavior "

type="Bulrush.WCF.Behaviors.Errors.ServiceErrorHandlerBehaviorExtension, Bulrush.WCF, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"

</ behaviorExtensions>

</extensions>

</system.serviceModel>

到这里自定义异常处理机制就已经完成了！

方法：Validate

该方法主要是对当前的拓展机制进行检查，主要检测两个东西ServiceDescription服务说明和ServiceHostBase服务宿主，它的返回值并不是bool类型而是void类型，所以标识它是否通用验证的方式就是是否抛出异常，抛出异常代表验证不通过。

为了演示这个方法，我们把上面的ServiceErrorHandler中的ProvideFault方法简单的修改下，修改如下：

public void ProvideFault( Exception error, MessageVersion version, ref Message fault)

{

var faultException = error is FaultException<ServiceError> ?

( FaultException< ServiceError>)error :

new FaultException< ServiceError>( new ServiceError { Message = "此操作不能在这个时刻处理。请稍后尝试。如果问题仍然存在与您的系统管理员联系"});

MessageFault messageFault = faultException.CreateMessageFault();

fault = Message.CreateMessage(version, messageFault, faultException.Action);

}

这里ServiceError只是一个SOAP的传输对象，里面只有一个Message属性就不贴代码了，改成这个方式后呢，假设业务上必须让该服务的每个方法建立错误契约[FaultContract(typeof(ServiceError))]，虽然不建立这个服务契约服务可以正常运行，但是所有的错误信息都是“此操作不能在这个时刻处理....”，那么就变的没有意义了，所以我们强制要求每Coder在编写服务方法是必须建立这个错误契约，这个时候我们就可以实现Validate来检查了，具体代码如下：

public void Validate( ServiceDescription serviceDescription, System.ServiceModel.ServiceHostBase serviceHostBase)

{

bool flag = false;

foreach ( var point in serviceDescription.Endpoints)

{

foreach ( var operation in point.Contract.Operations)

{

if (operation.Faults.Count == 0)

throw new InvalidOperationException (string .Format("使用SeriveErrorHandlerBehavior机制，必须为服务方法{0}标识 FaultContractAttribute(typeof(ServiceError)) 错误契约", operation.Name));

flag = false;

foreach ( var fault in operation.Faults)

{

if (fault.DetailType.Equals(typeof(ServiceError )))

{

flag = true;

break;

}

if (!flag)

{

throw new InvalidOperationException(string .Format("使用SeriveErrorHandlerBehavior机制，必须为服务方法{0}标识 FaultContractAttribute(typeof(ServiceError)) 错误契约", operation.Name));

}

这个时候如果服务标识了ServiceErrorHandlerBehavior拓展机制，那么下边的所有方法都必须建立错误契约，只要有一个方法没有建立错误契约这个服务就无法被链接！

[ ServiceContract]

public interface IService1

{

//[FaultContract(typeof(ServiceError))]

[ OperationContract]

string GetData( int value);

}

运行服务http://localhost:2708/Service1.svc运行服务则会出现异常：

“/”应用程序中的服务器错误。

使用SeriveErrorHandlerBehavior机制，必须为服务方法GetData标识 FaultContractAttribute(typeof(ServiceError)) 错误契约

说明: 执行当前 Web 请求期间，出现未经处理的异常。请检查堆栈跟踪信息，以了解有关该错误以及代码中导致错误的出处的详细信息。

异常详细信息: System.InvalidOperationException: 使用SeriveErrorHandlerBehavior机制，必须为服务方法GetData标识 FaultContractAttribute(typeof(ServiceError)) 错误契约

好了，就写到这里了，写博客真心不容易，感谢那些为我们提供帮助的博主们！！！！

转载于:https://www.cnblogs.com/zcylife/p/3652805.html

Wcf实现IServiceBehavior拓展机制相关推荐

服务端增加WCF服务全局异常处理机制
转自:http://www.csframework.com/archive/1/arc-1-20150109-2193.htm 服务端增加WCF服务全局异常处理机制,任一WCF服务或接口方式出现异常, ...
Eclipse Theia 揭秘之拓展机制篇
前言 VS Code 之所以是最流行的开发者工具,与其强大的插件生态是分不开的,VS Code 生态内有各种增强功能的 VS Code Extensions,Theia 在 VS Code 拓展机制上 ...
WCF分布式开发步步为赢(12):WCF事务机制（Transaction）和分布式事务编程
今天我们继续学习WCF分布式开发步步为赢系列的12节:WCF事务机制(Transaction)和分布式事务编程.众所周知,应用系统开发过程中,事务是一个重要的概念.它是保证数据与服务可靠性的重要机制. ...
WCF技术剖析之二十七: 如何将一个服务发布成WSDL[基于HTTP-GET的实现]（提供模拟程序）...
WCF技术剖析之二十七: 如何将一个服务发布成WSDL[基于HTTP-GET的实现](提供模拟程序) 原文:WCF技术剖析之二十七: 如何将一个服务发布成WSDL[基于HTTP-GET的实现](提供模 ...
WCF4.0进阶系列--第四章保护企业内部的WCF服务（转）
http://www.cnblogs.com/yang_sy/archive/2011/05/24/2054834.html [摘要] 安全是任何系统至关重要的一个方面,尤其当该系统由分布式的程序和服 ...
十五天精通WCF——第十四天一起聊聊FaultException
原文:十五天精通WCF--第十四天一起聊聊FaultException 我们在玩web编程的时候,可能你会不经意的见到一些http500的错误,我想你应该不会陌生的,原因你应该也知道,服务器异常嘛 ...
Dubbo源码分析（三）Dubbo中的SPI和自适应扩展机制
前言我们在往期文章中,曾经深入分析过Java的SPI机制,它是一种服务发现机制.具体详见:深入理解JDK的SPI机制在继续深入Dubbo之前,我们必须先要明白Dubbo中的SPI机制.因为有位大神 ...
【转】x.509证书在WCF中的应用(CS篇)
[转自]x.509证书在WCF中的应用(CS篇) 为什么要用x.509证书? WCF的服务端和客户端之间,如果不作任何安全处理(即服务端的<security mode="None&q ...
细说WCF中的会话模式
大家都知道WCF会话模式有几个要求:1.会话契约:2.绑定支持:3.实例模式为PerSession.这几个要素是WCF支持的必要条件. 会话契约:由服务端提供实现,客户端调用时只持有契约定义,所以需要 ...

Wcf实现IServiceBehavior拓展机制

“/”应用程序中的服务器错误。

我的测试

“/”应用程序中的服务器错误。

使用SeriveErrorHandlerBehavior机制，必须为服务方法GetData标识 FaultContractAttribute(typeof(ServiceError)) 错误契约

Wcf实现IServiceBehavior拓展机制相关推荐

最新文章

热门文章