WCF技术剖析之三十一: WCF事务编程[下篇]

2022-06-23 03:25:48

在WCF事务编程模型下，通过服务契约确定事务流转的策略（参阅《上篇》），通过事务绑定实施事务的流转（参阅《中篇》）。但是，对于事务绑定接收到并成功创建的事务来说，服务操作的执行是否需要自动登记到该事务之中，以及服务操作采用怎样的提交方式，这就是服务端自己说了算了。正因为如此，WCF通过服务（操作）行为的形式定义事务的登记和提交（完成）方式。

一、事务的自动登记（Enlistment）与提交（完成）

在OperationBehaviorAttribute特性（其本身是一个操作行为）中定了两个与事务管理相关的属性：TransactionAutoComplete和TransactionScopeRequired。

[AttributeUsage(AttributeTargets.Method)]
public sealed class OperationBehaviorAttribute : Attribute, IOperationBehavior
{
    //其他成员
    public bool TransactionScopeRequired { get; set; }
    public bool TransactionAutoComplete { get; set; }
}

如上面的代码所示，这两个属性均为布尔类型，它们代表的含义如下：

TransactionScopeRequired：表示相应的操作的整个执行是否自动登记到一个事务中。具体来讲，如果客户端流程成功地流入服务端，并被服务端事务绑定成功接收，将该属性设为True以为着整个操作的执行将自动被纳入到流入的事务之中，服务操作将会成为客户端事务的一部分。如果服务端不曾成功接收流入的事务，将该属性设为True意味着操作的执行将会被纳入到一个新创建的事务中。TransactionScopeRequired的默认值为False；
TransactionAutoComplete：表示如果操作执行过程中没有抛出异常，完成后将自动提交事务（对于最外层的事务）或者向被依赖的事情进行投票（对于嵌套的依赖事务）。TransactionAutoComplete的默认值为True。

如果我们需要将整个操作（而不是操作的一部分）纳入到事务中执行，我们只需要将OperationBehaviorAttribute特性应用到服务类型中的相应的方法之上，并将TransactionScopeRequired属性设为True即可。相面的代码中，我通过应用OperationBehaviorAttribute特性将服务BankingService的Transfer方法定义成事务型操作方法。

public class BankingService : IBankingService
{
    [OperationBehavior(TransactionScopeRequired = true)]
    public void Transfer(string accountFrom, string accountTo, double amount)
    {
         //省略实现
    }
}

将TransactionAutoComplete属性设为True（默认就是True）可以使我们需要考虑对本地事务的提交问题。只要执行完最后一句代码尚无异常抛出，则会提交（或完成）事务。但是有时候，我们需要不同的事务提交（完成）策略，比如服务方法中包含一些非事务型操作（比如日记记录），只要保证正常的业务逻辑正常执行就可以提交（完成）事务。在这种情况下，我们可以将该属性设为False，通过调用当前OperationContext的SetTransactionComplete方法即可实现对本地事务的提交。

public sealed class OperationContext : IExtensibleObject<OperationContext>
{
    //其他成员
    public void SetTransactionComplete();
}

除了定义在OperationBehaviorAttribute特性中的基于操作的行为，还有一些与事务相关的服务行为，它们定义在我们熟悉的ServiceBehaviorAttribute特性中。

二、事务相关的服务行为

如下面的代码所示, ServiceBehaviorAttribute特性定义了四个与事务相关的属性。其中TransactionIsolationLevel指定事务的隔离级别，默认值为IsolationLevel.Serializable；TransactionTimeout以字符串定义事务的超市时限，WCF运行时会根据指定的字符串创建TimeSpan对象；TransactionAutoCompleteOnSessionClose表示在会话正常结束（没有出现异常）之后是否自动提交或为完成开启的事务，默认值为False；ReleaseServiceInstanceOnTransactionComplete则表示当事务完成之后是否需要将服务实例释放掉，默认为False。

[AttributeUsage(AttributeTargets.Class)]
public sealed class ServiceBehaviorAttribute : Attribute, IServiceBehavior
{
    //其他成员
    public IsolationLevel TransactionIsolationLevel { get; set; }
    public string TransactionTimeout { get; set; }
    public bool TransactionAutoCompleteOnSessionClose { get; set; }
    public bool ReleaseServiceInstanceOnTransactionComplete { get; set; }
}

在下面的代码中，通过在BankingService上应用ServiceBehaviorAttribute特性将隔离级别设置成ReadCommitted，超时时限设置成5分钟，并将TransactionAutoCompleteOnSessionClose设置成True。

[ServiceBehavior(TransactionIsolationLevel = IsolationLevel.ReadCommitted,
                 TransactionTimeout = "00:05:00",
                 TransactionAutoCompleteOnSessionClose = true)]
public class BankingService : IBankingService
{
    //省略成员
}

当你通过ServiceBehaviorAttribute特性对上述的四个属性的任一个进行的设置，即使是设置成默认值，如果服务中并不存在一个TransactionScopeRequired属性为True的操作，在进行服务寄宿的时候将会抛出异常。就以上面的设置为例，在BankingService中的唯一的Transfer方法上，并没有通过OperationBehaviorAttribute将TransactionScopeRequired属性为True，在对服务进行寄宿的时候，就会抛出如图1所示的InvalidOperationException异常。

[ServiceBehavior(TransactionIsolationLevel = IsolationLevel.ReadCommitted,
                 TransactionTimeout = "00:05:00",
                 TransactionAutoCompleteOnSessionClose = true)]
public class BankingService : IBankingService
{
    public void Transfer(string accountFrom, string accountTo, double amount)
    {
        //省略实现
    }
}

图1 为不存TransactionScopeRequired操作的服设置在事务相关服务行为导致的异常

通过TransactionTimeout设置的事务超时时限最终会被赋予ChannelDispatcher的同名属性。该属性的默认值为TimeSpan.Zero，在这种情况下，运行时将会采用System.Transactions的默认超时设置。如果设置的TransactionTimeout的值超过了System.Transactions设置的最大超时时限，后者将会自动作为运行时的事务超时时限。相关类型请参考《谈谈分布式事务之三: System.Transactions事务详解[上篇]》和《谈谈分布式事务之三: System.Transactions事务详解[下篇]》

public class ChannelDispatcher : ChannelDispatcherBase
{
    //其他成员
    public TimeSpan TransactionTimeout { get; set; }
}

基于事务超时时限的服务行为也可以通过配置的方式指定，对应的配置节为<serviceTimeouts>,你只需按照所需的各式设置transactionTimeout属性值即可。在下面的配置中，我们将BankingService服务的事务超时时限设置成30分钟。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <system.serviceModel>    
        <services>
            <service behaviorConfiguration="transactionBehavior" name="Artech.TransactionalServices.BankingService">
                <endpoint address="net.tcp://127.0.0.1:3721/bankingservice" binding="netTcpBinding"                  contract="Artech.TransactionalServices.IBankingService" />
            </service>
        </services>
      <behaviors>
        <serviceBehaviors>
          <behavior name="transactionBehavior">
            <serviceTimeouts transactionTimeout="00:30:00" />
          </behavior>
        </serviceBehaviors>
      </behaviors>
    </system.serviceModel>
</configuration>

在事务流转的场景中，流入的事务和目标服务的事务隔离级别必须一致。也就是说，如果服务调用存在于客户端现有的事务之中，当前客户端事务的隔离级别必须和目标服务具有相同的隔离级别。否则，服务端将会返回相应的Fualt消息并导致客户端抛出异常。同样对于上面我们定义的BankingService（TransactionIsolationLevel = IsolationLevel.ReadCommitted），如果客户端按照下面的方式进行调用，由于客户端事务采用默认的隔离界别Serializable，会抛出如图2所示的ProtocolException异常。

using (ChannelFactory<IBankingService> channelFactory = new ChannelFactory<IBankingService>("bankingservice"))
{
    IBankingService bankingservice = channelFactory.CreateChannel();
    using (TransactionScope transactionScope = new TransactionScope())
    {
        bankingservice.Transfer("Foo", "Bar", 1000);
        transactionScope.Complete();
    }
}

图2 事务隔离级别不一致导致的异常

到此为止，WCF事务编程模型涉及到的三个方面，即服务（操作）契约、绑定和服务（操作）行为就介绍完了。接下来，我们将给出一个完整的例子。

作者：蒋金楠
微信公众账号：大内老A
微博：www.weibo.com/artech
如果你想及时得到个人撰写文章以及著作的消息推送，或者想看看个人推荐的技术资料，可以扫描左边二维码（或者长按识别二维码）关注个人公众号（原来公众帐号蒋金楠的自媒体将会停用）。
本文版权归作者和博客园共有，欢迎转载，但未经作者同意必须保留此段声明，且在文章页面明显位置给出原文连接，否则保留追究法律责任的权利。

原文链接

码农公寓

一、事务的自动登记（Enlistment）与提交（完成）

二、事务相关的服务行为

相关文章