Usar WorkflowInvoker y WorkflowApplication

Windows Workflow Foundation (WF) proporciona varios métodos de hospedaje de flujos de trabajo. WorkflowInvoker proporciona una manera sencilla de invocar un flujo de trabajo como si fuera una llamada al método y se puede usar solo para los flujos de trabajo que no usan la persistencia. WorkflowApplication proporciona un modelo más enriquecido para ejecutar flujos de trabajo que incluye notificación de eventos de ciclo de vida, control de ejecución, reanudación de marcadores y persistencia. WorkflowServiceHost proporciona compatibilidad para las actividades de mensajería y se usa principalmente con servicios de flujo de trabajo. Este tema presenta el hospedaje del flujo de trabajo con WorkflowInvoker y WorkflowApplication. Para más información sobre cómo hospedar flujos de trabajo con WorkflowServiceHost, consulte Servicios de flujo de trabajo y Información general sobre hospedaje de servicios de flujo de trabajo.

Usar WorkflowInvoker

WorkflowInvoker proporciona un modelo para ejecutar un flujo de trabajo como si fuera una llamada al método. Para invocar un flujo de trabajo mediante WorkflowInvoker, llame al método Invoke y pase la definición del flujo de trabajo que se vaya a invocar. En este ejemplo, se invoca una actividad WriteLine mediante WorkflowInvoker.

Activity wf = new WriteLine
{
    Text = "Hello World."
};

WorkflowInvoker.Invoke(wf);

Cuando se invoca un flujo de trabajo con WorkflowInvoker, el flujo de trabajo se ejecuta en el subproceso que realiza la llamada y el método Invoke se bloquea hasta que el flujo de trabajo haya finalizado, incluido el tiempo de inactividad. Para configurar un intervalo de tiempo de espera en el que se debe completar el flujo de trabajo, use una de las sobrecargas Invoke que tome un parámetro TimeSpan. En este ejemplo, se invoca un flujo de trabajo dos veces con dos intervalos de tiempo de espera diferentes. El primer flujo de trabajo se completa, pero el segundo no.

Activity wf = new Sequence()
{
    Activities =
    {
        new WriteLine()
        {
            Text = "Before the 1 minute delay."
        },
        new Delay()
        {
            Duration = TimeSpan.FromMinutes(1)
        },
        new WriteLine()
        {
            Text = "After the 1 minute delay."
        }
    }
};

// This workflow completes successfully.
WorkflowInvoker.Invoke(wf, TimeSpan.FromMinutes(2));

// This workflow does not complete and a TimeoutException
// is thrown.
try
{
    WorkflowInvoker.Invoke(wf, TimeSpan.FromSeconds(30));
}
catch (TimeoutException ex)
{
    Console.WriteLine(ex.Message);
}

WorkflowInvoker también proporciona versiones asincrónicas del método de invocación. Para obtener más información, vea InvokeAsync y BeginInvoke.

Definir argumentos de entrada de un flujo de trabajo

Los datos se pueden pasar a un flujo de trabajo mediante un diccionario de parámetros de entrada, con claves por nombre de argumento, que se asignan a los argumentos de entrada del flujo de trabajo. En este ejemplo, se invoca WriteLine y el valor de su argumento Text se especifica con el diccionario de parámetros de entrada.

Activity wf = new WriteLine();

Dictionary<string, object> inputs = new Dictionary<string, object>();
inputs.Add("Text", "Hello World.");

WorkflowInvoker.Invoke(wf, inputs);

Recuperar argumentos de salida de un flujo de trabajo

Los parámetros de salida de un flujo de trabajo se pueden obtener usando el diccionario de salidas que se devuelve de la llamada a Invoke. En el siguiente ejemplo se invoca un flujo de trabajo formado por una sola actividad Divide que tiene dos argumentos de entrada y dos argumentos de salida. Cuando se invoca el flujo de trabajo, se pasa el diccionario de arguments que contiene los valores de cada argumento de entrada, ordenados por nombre de argumento. Cuando la llamada a Invoke devuelve resultados, cada uno de los argumentos de salida se devuelve en el diccionario outputs, ordenados por nombre de argumento.

public sealed class Divide : CodeActivity
{
    [RequiredArgument]
    public InArgument<int> Dividend { get; set; }

    [RequiredArgument]
    public InArgument<int> Divisor { get; set; }

    public OutArgument<int> Remainder { get; set; }
    public OutArgument<int> Result { get; set; }

    protected override void Execute(CodeActivityContext context)
    {
        int quotient = Dividend.Get(context) / Divisor.Get(context);
        int remainder = Dividend.Get(context) % Divisor.Get(context);

        Result.Set(context, quotient);
        Remainder.Set(context, remainder);
    }
}

int dividend = 500;
int divisor = 36;

Dictionary<string, object> arguments = new Dictionary<string, object>();
arguments.Add("Dividend", dividend);
arguments.Add("Divisor", divisor);

IDictionary<string, object> outputs =
    WorkflowInvoker.Invoke(new Divide(), arguments);

Console.WriteLine("{0} / {1} = {2} Remainder {3}",
    dividend, divisor, outputs["Result"], outputs["Remainder"]);

Si el flujo de trabajo se deriva de ActivityWithResult, como CodeActivity<TResult> o Activity<TResult>, y hay argumentos de salida, además del argumento de salida Result bien determinado, se debe utilizar una sobrecarga no genérica de Invoke para recuperar argumentos adicionales. Para ello, la definición de flujo de trabajo pasada a Invoke debe ser de tipo Activity. En este ejemplo la actividad Divide se deriva de CodeActivity<int>, pero se declara como Activity para utilizar una sobrecarga no genérica de Invoke que devuelve un diccionario de argumentos en lugar de un valor único.

public sealed class Divide : CodeActivity<int>
{
    public InArgument<int> Dividend { get; set; }
    public InArgument<int> Divisor { get; set; }
    public OutArgument<int> Remainder { get; set; }

    protected override int Execute(CodeActivityContext context)
    {
        int quotient = Dividend.Get(context) / Divisor.Get(context);
        int remainder = Dividend.Get(context) % Divisor.Get(context);

        Remainder.Set(context, remainder);

        return quotient;
    }
}

int dividend = 500;
int divisor = 36;

Dictionary<string, object> arguments = new Dictionary<string, object>();
arguments.Add("Dividend", dividend);
arguments.Add("Divisor", divisor);

Activity wf = new Divide();

IDictionary<string, object> outputs =
    WorkflowInvoker.Invoke(wf, arguments);

Console.WriteLine("{0} / {1} = {2} Remainder {3}",
    dividend, divisor, outputs["Result"], outputs["Remainder"]);

Usar WorkflowApplication

WorkflowApplication proporciona un amplio conjunto de características para la administración de instancias de flujo de trabajo. WorkflowApplication actúa como un proxy seguro para subprocesos para la WorkflowInstance real, que encapsula el entorno de ejecución y proporciona métodos para crear y cargar instancias de flujo de trabajo, pausar y reanudar, terminar y notificar los eventos de ciclo de vida. Para ejecutar un flujo de trabajo mediante WorkflowApplication, cree WorkflowApplication, suscríbase a cualquier evento de ciclo de vida que desee, inicie el flujo de trabajo y, a continuación, espere a que termine. En este ejemplo, se crea una definición de flujo de trabajo que consta de una actividad WriteLine y se crea una WorkflowApplication usando la definición de flujo de trabajo especificada. Se controla Completed de forma que se notifica al host cuando el flujo de trabajo se completa, el flujo de trabajo se inicia con una llamada a Run y el host espera a que el flujo de trabajo se complete. Cuando se completa el flujo de trabajo, se establece AutoResetEvent y la aplicación host puede reanudar la ejecución, tal y como se muestra en el siguiente ejemplo.

AutoResetEvent syncEvent = new AutoResetEvent(false);

Activity wf = new WriteLine
{
    Text = "Hello World."
};

// Create the WorkflowApplication using the desired
// workflow definition.
WorkflowApplication wfApp = new WorkflowApplication(wf);

// Handle the desired lifecycle events.
wfApp.Completed = delegate (WorkflowApplicationCompletedEventArgs e)
{
    syncEvent.Set();
};

// Start the workflow.
wfApp.Run();

// Wait for Completed to arrive and signal that
// the workflow is complete.
syncEvent.WaitOne();

Eventos de ciclo de vida de WorkflowApplication

Además de Completed, se puede notificar a los autores de hosts cuando se descargue un flujo de trabajo (Unloaded), se anule (Aborted), se vuelva inactivo (Idle y PersistableIdle) o se produzca una excepción no controlada (OnUnhandledException). Los desarrolladores de aplicaciones de flujo de trabajo pueden administrar estas notificaciones y realizar la acción adecuada, tal y como se muestra en el siguiente ejemplo.

wfApp.Completed = delegate (WorkflowApplicationCompletedEventArgs e)
{
    if (e.CompletionState == ActivityInstanceState.Faulted)
    {
        Console.WriteLine("Workflow {0} Terminated.", e.InstanceId);
        Console.WriteLine("Exception: {0}\n{1}",
            e.TerminationException.GetType().FullName,
            e.TerminationException.Message);
    }
    else if (e.CompletionState == ActivityInstanceState.Canceled)
    {
        Console.WriteLine("Workflow {0} Canceled.", e.InstanceId);
    }
    else
    {
        Console.WriteLine("Workflow {0} Completed.", e.InstanceId);

        // Outputs can be retrieved from the Outputs dictionary,
        // keyed by argument name.
        // Console.WriteLine("The winner is {0}.", e.Outputs["Winner"]);
    }
};

wfApp.Aborted = delegate (WorkflowApplicationAbortedEventArgs e)
{
    // Display the exception that caused the workflow
    // to abort.
    Console.WriteLine("Workflow {0} Aborted.", e.InstanceId);
    Console.WriteLine("Exception: {0}\n{1}",
        e.Reason.GetType().FullName,
        e.Reason.Message);
};

wfApp.Idle = delegate (WorkflowApplicationIdleEventArgs e)
{
    // Perform any processing that should occur
    // when a workflow goes idle. If the workflow can persist,
    // both Idle and PersistableIdle are called in that order.
    Console.WriteLine("Workflow {0} Idle.", e.InstanceId);
};

wfApp.PersistableIdle = delegate (WorkflowApplicationIdleEventArgs e)
{
    // Instruct the runtime to persist and unload the workflow.
    // Choices are None, Persist, and Unload.
    return PersistableIdleAction.Unload;
};

wfApp.Unloaded = delegate (WorkflowApplicationEventArgs e)
{
    Console.WriteLine("Workflow {0} Unloaded.", e.InstanceId);
};

wfApp.OnUnhandledException = delegate (WorkflowApplicationUnhandledExceptionEventArgs e)
{
    // Display the unhandled exception.
    Console.WriteLine("OnUnhandledException in Workflow {0}\n{1}",
        e.InstanceId, e.UnhandledException.Message);

    Console.WriteLine("ExceptionSource: {0} - {1}",
        e.ExceptionSource.DisplayName, e.ExceptionSourceInstanceId);

    // Instruct the runtime to terminate the workflow.
    // Other choices are Abort and Cancel. Terminate
    // is the default if no OnUnhandledException handler
    // is present.
    return UnhandledExceptionAction.Terminate;
};

Definir argumentos de entrada de un flujo de trabajo

Se pueden pasar datos a un flujo de trabajo cuando se inicia gracias a un diccionario de parámetros, al igual que la manera en que los datos se pasan cuando se usa WorkflowInvoker. Cada elemento en el diccionario se asigna a un argumento de entrada del flujo de trabajo especificado. En este ejemplo, se invoca un flujo de trabajo que está compuesto de una actividad WriteLine y se especifica su argumento Text mediante el diccionario de parámetros de entrada.

AutoResetEvent syncEvent = new AutoResetEvent(false);

Activity wf = new WriteLine();

// Create the dictionary of input parameters.
Dictionary<string, object> inputs = new Dictionary<string, object>();
inputs.Add("Text", "Hello World!");

// Create the WorkflowApplication using the desired
// workflow definition and dictionary of input parameters.
WorkflowApplication wfApp = new WorkflowApplication(wf, inputs);

// Handle the desired lifecycle events.
wfApp.Completed = delegate (WorkflowApplicationCompletedEventArgs e)
{
    syncEvent.Set();
};

// Start the workflow.
wfApp.Run();

// Wait for Completed to arrive and signal that
// the workflow is complete.
syncEvent.WaitOne();

Recuperar argumentos de salida de un flujo de trabajo

Cuando un flujo de trabajo se completa, se puede recuperar cualquier parámetro de salida en el controlador Completed teniendo acceso al diccionario WorkflowApplicationCompletedEventArgs.Outputs. En el siguiente ejemplo, se hospeda un flujo de trabajo utilizando WorkflowApplication. Una instancia de WorkflowApplication se construye utilizando una definición de flujo de trabajo que está compuesta de actividad DiceRoll única. La actividad DiceRoll tiene dos argumentos de salida que representan los resultados de la operación de tirar los dados. Cuando se completa el flujo de trabajo, las salidas se recuperan en el controlador Completed.

public sealed class DiceRoll : CodeActivity
{
    public OutArgument<int> D1 { get; set; }
    public OutArgument<int> D2 { get; set; }

    static Random r = new Random();

    protected override void Execute(CodeActivityContext context)
    {
        D1.Set(context, r.Next(1, 7));
        D2.Set(context, r.Next(1, 7));
    }
}

// Create a WorkflowApplication instance.
WorkflowApplication wfApp = new WorkflowApplication(new DiceRoll());

// Subscribe to any desired workflow lifecycle events.
wfApp.Completed = delegate (WorkflowApplicationCompletedEventArgs e)
{
    if (e.CompletionState == ActivityInstanceState.Faulted)
    {
        Console.WriteLine("Workflow {0} Terminated.", e.InstanceId);
        Console.WriteLine("Exception: {0}\n{1}",
            e.TerminationException.GetType().FullName,
            e.TerminationException.Message);
    }
    else if (e.CompletionState == ActivityInstanceState.Canceled)
    {
        Console.WriteLine("Workflow {0} Canceled.", e.InstanceId);
    }
    else
    {
        Console.WriteLine("Workflow {0} Completed.", e.InstanceId);

        // Outputs can be retrieved from the Outputs dictionary,
        // keyed by argument name.
        Console.WriteLine("The two dice are {0} and {1}.",
            e.Outputs["D1"], e.Outputs["D2"]);
    }
};

// Run the workflow.
wfApp.Run();

Pasar datos en un flujo de trabajo en ejecución mediante marcadores

Los marcadores son el mecanismo por el que una actividad puede esperar de forma pasiva a que se reanude y, además, un mecanismo para pasar los datos a una instancia de flujo de trabajo en ejecución. Si una actividad está esperando los datos, puede crear Bookmark y registrar un método de devolución de llamada que se va a llamar cuando se reanude Bookmark, tal y como se muestra en el siguiente ejemplo.

public sealed class ReadLine : NativeActivity<string>
{
    [RequiredArgument]
    public InArgument<string> BookmarkName { get; set; }

    protected override void Execute(NativeActivityContext context)
    {
        // Create a Bookmark and wait for it to be resumed.
        context.CreateBookmark(BookmarkName.Get(context),
            new BookmarkCallback(OnResumeBookmark));
    }

    // NativeActivity derived activities that do asynchronous operations by calling
    // one of the CreateBookmark overloads defined on System.Activities.NativeActivityContext
    // must override the CanInduceIdle property and return true.
    protected override bool CanInduceIdle
    {
        get { return true; }
    }

    public void OnResumeBookmark(NativeActivityContext context, Bookmark bookmark, object obj)
    {
        // When the Bookmark is resumed, assign its value to
        // the Result argument.
        Result.Set(context, (string)obj);
    }

Cuando se ejecuta, la actividad ReadLine crea un Bookmark, registra una devolución de llamada y, a continuación, espera a que se reanude Bookmark. Cuando lo haga, la actividad ReadLine asigna los datos que se pasaron con Bookmark a su argumento Result. En este ejemplo, se crea un flujo de trabajo que usa la actividad ReadLine para recopilar el nombre del usuario y mostrarlo en la ventana de la consola.

Variable<string> name = new Variable<string>();

Activity wf = new Sequence
{
    Variables = { name },
    Activities =
     {
         new WriteLine
         {
             Text = "What is your name?"
         },
         new ReadLine
         {
             BookmarkName = "UserName",
             Result = new OutArgument<string>(name)
         },
         new WriteLine
         {
             Text = new InArgument<string>((env) =>
                 ("Hello, " + name.Get(env)))
         }
     }
};

// Create a WorkflowApplication instance.
WorkflowApplication wfApp = new WorkflowApplication(wf);

// Workflow lifecycle events omitted except idle.
AutoResetEvent idleEvent = new AutoResetEvent(false);

wfApp.Idle = delegate (WorkflowApplicationIdleEventArgs e)
{
    idleEvent.Set();
};

// Run the workflow.
wfApp.Run();

// Wait for the workflow to go idle before gathering
// the user's input.
idleEvent.WaitOne();

// Gather the user's input and resume the bookmark.
// Bookmark resumption only occurs when the workflow
// is idle. If a call to ResumeBookmark is made and the workflow
// is not idle, ResumeBookmark blocks until the workflow becomes
// idle before resuming the bookmark.
BookmarkResumptionResult result = wfApp.ResumeBookmark("UserName",
    Console.ReadLine());

// Possible BookmarkResumptionResult values:
// Success, NotFound, or NotReady
Console.WriteLine("BookmarkResumptionResult: {0}", result);

Cuando se ejecuta la actividad ReadLine, crea un Bookmark denominado UserName y, a continuación, espera a que se reanude el marcador. El host recopila los datos deseados y, a continuación, reanuda Bookmark. El flujo de trabajo se reanuda, muestra el nombre y, a continuación, finaliza.

La aplicación host puede inspeccionar el flujo de trabajo para determinar si hay marcadores activos. Puede hacerlo llamando al método GetBookmarks de una instancia WorkflowApplication o inspeccionando el objeto WorkflowApplicationIdleEventArgs en el controlador Idle.

El siguiente ejemplo de código es similar al ejemplo anterior salvo que los marcadores activos se enumeran antes de que se reanude el marcador. Se inicia el flujo de trabajo, y una vez se ha creado el objeto Bookmark y se ha quedado inactivo el flujo de trabajo, se llama al método GetBookmarks. Cuando se completa el flujo de trabajo, se muestra la siguiente salida en la consola.

¿Cómo se llama?
BookmarkName: UserName - OwnerDisplayName: ReadLineSteveHola, Steve

Variable<string> name = new Variable<string>();

Activity wf = new Sequence
{
    Variables = { name },
    Activities =
     {
         new WriteLine
         {
             Text = "What is your name?"
         },
         new ReadLine
         {
             BookmarkName = "UserName",
             Result = new OutArgument<string>(name)
         },
         new WriteLine
         {
             Text = new InArgument<string>((env) =>
                 ("Hello, " + name.Get(env)))
         }
     }
};

// Create a WorkflowApplication instance.
WorkflowApplication wfApp = new WorkflowApplication(wf);

// Workflow lifecycle events omitted except idle.
AutoResetEvent idleEvent = new AutoResetEvent(false);

wfApp.Idle = delegate (WorkflowApplicationIdleEventArgs e)
{
    // You can also inspect the bookmarks from the Idle handler
    // using e.Bookmarks

    idleEvent.Set();
};

// Run the workflow.
wfApp.Run();

// Wait for the workflow to go idle and give it a chance
// to create the Bookmark.
idleEvent.WaitOne();

// Inspect the bookmarks
foreach (BookmarkInfo info in wfApp.GetBookmarks())
{
    Console.WriteLine("BookmarkName: {0} - OwnerDisplayName: {1}",
        info.BookmarkName, info.OwnerDisplayName);
}

// Gather the user's input and resume the bookmark.
wfApp.ResumeBookmark("UserName", Console.ReadLine());

El siguiente ejemplo de código inspecciona el objeto WorkflowApplicationIdleEventArgs pasado al controlador de la propiedad Idle de una instancia de WorkflowApplication. En este ejemplo, el flujo de trabajo que va a estar inactivo tiene un objeto Bookmark con el nombre EnterGuess, que una actividad denominada ReadInt posee. Este ejemplo de código se basa en Cómo ejecutar un flujo de trabajo, que forma parte del tutorial de introducción. Si el controlador de la propiedad Idle en ese paso se modifica para contener el código de este ejemplo, se muestra la siguiente salida.

BookmarkName: EnterGuess - OwnerDisplayName: ReadInt

wfApp.Idle = delegate (WorkflowApplicationIdleEventArgs e)
{
    foreach (BookmarkInfo info in e.Bookmarks)
    {
        Console.WriteLine("BookmarkName: {0} - OwnerDisplayName: {1}",
            info.BookmarkName, info.OwnerDisplayName);
    }

    idleEvent.Set();
};

Resumen

WorkflowInvoker proporciona una manera ligera de invocar los flujos de trabajo y, aunque proporciona los métodos para pasar los datos al principio de un flujo de trabajo y extraer los datos de un flujo de trabajo completado, no se proporciona para escenarios más complejos, que son aquellos en los se puede usar WorkflowApplication.