共用方式為

薪酬

  • 發行項

Windows Workflow Foundation (WF) 中的「補償」，是一種在發生後續失敗時，能讓先前完成的工作復原或得到補償 (依照應用程式定義的邏輯) 的機制。 本節描述如何在工作流程中使用補償。

補償與交易

異動可讓您將多項作業結合成單一工作單位。 如果異動處理序的任何部分中發生錯誤，使用異動可讓應用程式中止 (回復) 在異動內部執行的所有變更。 然而，如果屬於長期執行的工作，可能就不適合使用異動。 例如，假設有一項旅遊計劃應用程式實作為工作流程。 工作流程的步驟包括預訂班機、等待經理核准，然後繳交班機費用。 這些處理程序可能要耗費許多天，因此讓預定班機與繳交班機費用的步驟都在同一個異動中，會是一個不實際的選擇。 在此類型案例中，如果處理程序稍後失敗，則可以使用補償復原工作流程的預定班機步驟。

注意

本主題介紹工作流程中的補償。 如需工作流程中交易的詳細資訊，請參閱交易和 TransactionScope。 如需交易的詳細資訊，請參閱 System.Transactions 和 System.Transactions.Transaction。

使用 CompensableActivity

CompensableActivity 是 WF 中的核心補償活動。 任何執行可能需補償之工作的活動，都會置放在 Body 的 CompensableActivity 中。 在此範例中，購買機票的預定步驟會置放在 Body 的 CompensableActivity 中，而預定取消則會置放在 CompensationHandler 中。 工作流程中的 CompensableActivity 之後緊接著兩個活動，這兩個活動會等候經理核准，然後完成機票購買步驟。 如果錯誤狀況導致在 CompensableActivity 順利完成之後取消工作流程，則會排定 CompensationHandler 處理常式中的活動，並取消班機。

Activity wf = new Sequence()
{
    Activities =
    {
        new CompensableActivity
        {
            Body = new ReserveFlight(),
            CompensationHandler = new CancelFlight()
        },
        new ManagerApproval(),
        new PurchaseFlight()
    }
};

下列範例是 XAML 中的工作流程。

<Sequence
   xmlns="http://schemas.microsoft.com/netfx/2009/xaml/activities"
   xmlns:c="clr-namespace:CompensationExample;assembly=CompensationExample"
   xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">
  <CompensableActivity>
    <CompensableActivity.Result>
      <OutArgument
         x:TypeArguments="CompensationToken" />
    </CompensableActivity.Result>
    <CompensableActivity.CompensationHandler>
      <c:CancelFlight />
    </CompensableActivity.CompensationHandler>
    <c:ReserveFlight />
  </CompensableActivity>
  <c:ManagerApproval />
  <c:PurchaseFlight />
</Sequence>

當叫用此工作流程時，主控台就會顯示下列輸出。

ReserveFlight: Ticket is reserved.ManagerApproval: Manager approval received.PurchaseFlight: Ticket is purchased.Workflow completed successfully with status: Closed.

注意

本主題中的範例活動 (例如 ReserveFlight) 會將其名稱和目的顯示到主控台，以協助說明發生補償時活動的執行順序。

預設的工作流程補償

根據預設，如果取消工作流程，會執行任何已順利完成且尚未確認或補償之可補償活動的補償邏輯。

注意

當 CompensableActivity 為「已確認」時，就不會再叫用活動的補償。 本節稍後會描述補償程序。

在此範例中，會在預定班機之後、經理核准步驟之前擲出例外狀況。

Activity wf = new Sequence()
{
    Activities =
    {
        new CompensableActivity
        {
            Body = new ReserveFlight(),
            CompensationHandler = new CancelFlight()
        },
        new SimulatedErrorCondition(),
        new ManagerApproval(),
        new PurchaseFlight()
    }
};

本範例是 XAML 中的工作流程。

<Sequence
   xmlns="http://schemas.microsoft.com/netfx/2009/xaml/activities"
   xmlns:c="clr-namespace:CompensationExample;assembly=CompensationExample"
   xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">
  <CompensableActivity>
    <CompensableActivity.Result>
      <OutArgument
         x:TypeArguments="CompensationToken" />
    </CompensableActivity.Result>
    <CompensableActivity.CompensationHandler>
      <c:CancelFlight />
    </CompensableActivity.CompensationHandler>
    <c:ReserveFlight />
  </CompensableActivity>
  <c:SimulatedErrorCondition />
  <c:ManagerApproval />
  <c:PurchaseFlight />
</Sequence>

AutoResetEvent syncEvent = new AutoResetEvent(false);
WorkflowApplication wfApp = new WorkflowApplication(wf);

wfApp.Completed = delegate(WorkflowApplicationCompletedEventArgs e)
{
    if (e.TerminationException != null)
    {
        Console.WriteLine("Workflow terminated with exception:\n{0}: {1}",
            e.TerminationException.GetType().FullName,
            e.TerminationException.Message);
    }
    else
    {
        Console.WriteLine("Workflow completed successfully with status: {0}.",
            e.CompletionState);
    }

    syncEvent.Set();
};

wfApp.OnUnhandledException = delegate(WorkflowApplicationUnhandledExceptionEventArgs e)
{
    Console.WriteLine("Workflow Unhandled Exception:\n{0}: {1}",
        e.UnhandledException.GetType().FullName,
        e.UnhandledException.Message);

    return UnhandledExceptionAction.Cancel;
};

wfApp.Run();
syncEvent.WaitOne();

當叫用工作流程時，OnUnhandledException 中的主應用程式會處理模擬的錯誤條件例外狀況、取消工作流程，然後叫用補償邏輯。

ReserveFlight: Ticket is reserved.SimulatedErrorCondition: Throwing an ApplicationException.Workflow Unhandled Exception:System.ApplicationException: Simulated error condition in the workflow.CancelFlight: Ticket is canceled.Workflow completed successfully with status: Canceled.

取消和 CompensableActivity

如果 Body 之 CompensableActivity 中的活動尚未完成，而活動已取消時，則會執行 CancellationHandler 中的活動。

注意

CancellationHandler 只有在 Body 之 CompensableActivity 中的活動尚未完成，而活動已取消時才會叫用。 CompensationHandler 只有在 Body 之 CompensableActivity 中的活動已順利完成，而且後續在活動上叫用補償時才會執行。

CancellationHandler 讓工作流程作者有機會提供任何適當的取消邏輯。 在下列範例中，Body 執行期間會擲回例外狀況，接著叫用 CancellationHandler。

Activity wf = new Sequence()
{
    Activities =
    {
        new CompensableActivity
        {
            Body = new Sequence
            {
                Activities =
                {
                    new ChargeCreditCard(),
                    new SimulatedErrorCondition(),
                    new ReserveFlight()
                }
            },
            CompensationHandler = new CancelFlight(),
            CancellationHandler = new CancelCreditCard()
        },
        new ManagerApproval(),
        new PurchaseFlight()
    }
};

本範例是 XAML 中的工作流程。

<Sequence
   xmlns="http://schemas.microsoft.com/netfx/2009/xaml/activities"
   xmlns:c="clr-namespace:CompensationExample;assembly=CompensationExample"
   xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">
  <CompensableActivity>
    <CompensableActivity.Result>
      <OutArgument
         x:TypeArguments="CompensationToken" />
    </CompensableActivity.Result>
    <Sequence>
      <c:ChargeCreditCard />
      <c:SimulatedErrorCondition />
      <c:ReserveFlight />
    </Sequence>
    <CompensableActivity.CancellationHandler>
      <c:CancelCreditCard />
    </CompensableActivity.CancellationHandler>
    <CompensableActivity.CompensationHandler>
      <c:CancelFlight />
    </CompensableActivity.CompensationHandler>
  </CompensableActivity>
  <c:ManagerApproval />
  <c:PurchaseFlight />
</Sequence>

當叫用工作流程時，OnUnhandledException 中的主應用程式會處理模擬的錯誤條件例外狀況、取消工作流程，然後叫用 CompensableActivity 的取消邏輯。 在此範例中，補償邏輯和取消邏輯有不同的目標。 如果 Body 成功完成，表示會透過信用卡扣款並預訂航班，因此補償應該會復原這兩個步驟。 (在這個範例中，取消航班會自動取消信用卡收費。)但是，如果取消 CompensableActivity，表示 Body 未完成，因此 CancellationHandler 的邏輯需要能夠判斷如何做出最好的取消處理。 在此範例中，CancellationHandler 會取消信用卡收費，但由於 ReserveFlight 是 Body 中的最後一個活動，因此不會嘗試取消航班。 因為 ReserveFlight 是 Body 中的最後一個活動，所以如果其順利完成，則 Body 已完成，而且無法取消。

ChargeCreditCard: Charge credit card for flight.SimulatedErrorCondition: Throwing an ApplicationException.Workflow Unhandled Exception:System.ApplicationException: Simulated error condition in the workflow.CancelCreditCard: Cancel credit card charges.Workflow completed successfully with status: Canceled.如需取消的詳細資訊，請參閱取消。

使用補償活動的明確補償

上一節的說明涵蓋了隱含補償。 隱含補償適用於簡單的案例，旦若因排定補償處理而需較明確的控制，則可以使用 Compensate 活動。 若要以 Compensate 活動啟動補償程序，就會使用需要補償之 CompensationToken 的 CompensableActivity。 Compensate 活動可用於在任何已完成但尚未確認或補償之 CompensableActivity 上啟動補償。 例如，Compensate 活動可用於 Catches 活動的 TryCatch 區段，或在 CompensableActivity 完成後的任何時間點。 在此範例中，Compensate 活動的 Catches 區段中會使用 TryCatch 活動，以反轉 CompensableActivity 的動作。

Variable<CompensationToken> token1 = new Variable<CompensationToken>
{
    Name = "token1",
};

Activity wf = new TryCatch()
{
    Variables =
    {
        token1
    },
    Try = new Sequence
    {
        Activities =
        {
            new CompensableActivity
            {
                Body = new ReserveFlight(),
                CompensationHandler = new CancelFlight(),
                ConfirmationHandler = new ConfirmFlight(),
                Result = token1
            },
            new SimulatedErrorCondition(),
            new ManagerApproval(),
            new PurchaseFlight()
        }
    },
    Catches =
    {
        new Catch<ApplicationException>()
        {
            Action = new ActivityAction<ApplicationException>()
            {
                Handler = new Compensate()
                {
                    Target = token1
                }
            }
        }
    }
};

本範例是 XAML 中的工作流程。

<TryCatch
   xmlns="http://schemas.microsoft.com/netfx/2009/xaml/activities"
   xmlns:c="clr-namespace:CompensationExample;assembly=CompensationExample"
   xmlns:s="clr-namespace:System;assembly=mscorlib"
   xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">
  <TryCatch.Variables>
    <Variable
       x:TypeArguments="CompensationToken"
       x:Name="__ReferenceID0"
       Name="token1" />
  </TryCatch.Variables>
  <TryCatch.Try>
    <Sequence>
      <CompensableActivity>
        <CompensableActivity.Result>
          <OutArgument
             x:TypeArguments="CompensationToken">
            <VariableReference
               x:TypeArguments="CompensationToken"
               Variable="{x:Reference __ReferenceID0}">
              <VariableReference.Result>
                <OutArgument
                   x:TypeArguments="Location(CompensationToken)" />
              </VariableReference.Result>
            </VariableReference>
          </OutArgument>
        </CompensableActivity.Result>
        <CompensableActivity.CompensationHandler>
          <c:CancelFlight />
        </CompensableActivity.CompensationHandler>
        <CompensableActivity.ConfirmationHandler>
          <c:ConfirmFlight />
        </CompensableActivity.ConfirmationHandler>
        <c:ReserveFlight />
      </CompensableActivity>
      <c:SimulatedErrorCondition />
      <c:ManagerApproval />
      <c:PurchaseFlight />
    </Sequence>
  </TryCatch.Try>
  <TryCatch.Catches>
    <Catch
       x:TypeArguments="s:ApplicationException">
      <ActivityAction
         x:TypeArguments="s:ApplicationException">
        <Compensate>
          <Compensate.Target>
            <InArgument
               x:TypeArguments="CompensationToken">
              <VariableValue
                 x:TypeArguments="CompensationToken"
                 Variable="{x:Reference __ReferenceID0}">
                <VariableValue.Result>
                  <OutArgument
                     x:TypeArguments="CompensationToken" />
                </VariableValue.Result>
              </VariableValue>
            </InArgument>
          </Compensate.Target>
        </Compensate>
      </ActivityAction>
    </Catch>
  </TryCatch.Catches>
</TryCatch>

當叫用此工作流程時，主控台就會顯示下列輸出。

ReserveFlight: Ticket is reserved.SimulatedErrorCondition: Throwing an ApplicationException.CancelFlight: Ticket is canceled.Workflow completed successfully with status: Closed.

確認補償

根據預設，可補償的活動可在活動完成之後隨時補償。 但在某些情況下，可能不太合適這麼做。 在上一個範例中，預訂機票的補償是取消預定。 不過，該班機完成之後，這個補償步驟就不再有效。 確認可補償的活動會叫用 ConfirmationHandler 所指定的活動。 這個動作可能的用法之一，就是允許釋放執行補償所必要的任何資源。 確認可補償的活動之後，就不能補償該活動，如果嘗試這麼做，則會擲回 InvalidOperationException 例外狀況。 當工作流程順利完成時，所有已順利完成但未確認及未補償的可補償活動均會依完成的順序進行反向確認。 在此範例中，會預定班機、購買機票、完成，然後確認可補償的活動。 若要確認 CompensableActivity，請使用 Confirm 活動並指定欲確認之 CompensationToken 的 CompensableActivity。

Variable<CompensationToken> token1 = new Variable<CompensationToken>
{
    Name = "token1",
};

Activity wf = new Sequence()
{
    Variables =
    {
        token1
    },
    Activities =
    {
        new CompensableActivity
        {
            Body = new ReserveFlight(),
            CompensationHandler = new CancelFlight(),
            ConfirmationHandler = new ConfirmFlight(),
            Result = token1
        },
        new ManagerApproval(),
        new PurchaseFlight(),
        new TakeFlight(),
        new Confirm()
        {
            Target = token1
        }
    }
};

本範例是 XAML 中的工作流程。

<Sequence
   xmlns="http://schemas.microsoft.com/netfx/2009/xaml/activities"
   xmlns:c="clr-namespace:CompensationExample;assembly=CompensationExample"
   xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml">
  <Sequence.Variables>
    <x:Reference>__ReferenceID0</x:Reference>
  </Sequence.Variables>
  <CompensableActivity>
    <CompensableActivity.Result>
      <OutArgument
         x:TypeArguments="CompensationToken">
        <VariableReference
           x:TypeArguments="CompensationToken">
          <VariableReference.Result>
            <OutArgument
               x:TypeArguments="Location(CompensationToken)" />
          </VariableReference.Result>
          <VariableReference.Variable>
            <Variable
               x:TypeArguments="CompensationToken"
               x:Name="__ReferenceID0"
               Name="token1" />
          </VariableReference.Variable>
        </VariableReference>
      </OutArgument>
    </CompensableActivity.Result>
    <CompensableActivity.CompensationHandler>
      <c:CancelFlight />
    </CompensableActivity.CompensationHandler>
    <CompensableActivity.ConfirmationHandler>
      <c:ConfirmFlight />
    </CompensableActivity.ConfirmationHandler>
    <c:ReserveFlight />
  </CompensableActivity>
  <c:ManagerApproval />
  <c:PurchaseFlight />
  <c:TakeFlight />
  <Confirm>
    <Confirm.Target>
      <InArgument
         x:TypeArguments="CompensationToken">
        <VariableValue
           x:TypeArguments="CompensationToken"
           Variable="{x:Reference __ReferenceID0}">
          <VariableValue.Result>
            <OutArgument
               x:TypeArguments="CompensationToken" />
          </VariableValue.Result>
        </VariableValue>
      </InArgument>
    </Confirm.Target>
  </Confirm>
</Sequence>

當叫用此工作流程時，主控台就會顯示下列輸出。

ReserveFlight: Ticket is reserved.ManagerApproval: Manager approval received.PurchaseFlight: Ticket is purchased.TakeFlight: Flight is completed.ConfirmFlight: Flight has been taken, no compensation possible.Workflow completed successfully with status: Closed.

巢狀補償活動

CompensableActivity 可置於另一個 Body 的 CompensableActivity 區段中。 不可將 CompensableActivity 放在另一個 CompensableActivity 的處理常式中。 父 CompensableActivity 必須確保一旦取消、確認或補償父活動後，就必須在父系完成取消、確認或補償之前確認或補償所有可補償的子活動 (已成功完成且尚未確認或補償)。 若無法明確建立模型，父 CompensableActivity 會隱含補償可補償的子活動 (若父活動收到取消或補償信號)。 如果父活動收到確認信號，就會隱含確認可補償的子活動。 如果在父 CompensableActivity 的處理常式中明確建立處理取消、確認或補償邏輯的模型，則會隱含確認所有未明確處理的子活動。

另請參閱