Richiamo della convalida di attività

La convalida dell'attività offre un metodo per identificare e segnalare errori nella configurazione di qualsiasi attività prima della relativa esecuzione. Viene eseguita quando un flusso di lavoro viene modificato nell'utilità di progettazione del flusso di lavoro e gli eventuali errori o avvisi di convalida vengono visualizzati in tale utilità. La convalida avviene anche in fase di esecuzione quando un flusso di lavoro viene richiamato e, se si verificano errori di convalida, viene generata un'eccezione InvalidWorkflowException dalla logica di convalida predefinita. Windows Workflow Foundation (WF) fornisce la classe ActivityValidationServices che può essere usata dagli sviluppatori di applicazioni e strumenti flusso di lavoro per convalidare in modo esplicito un'attività. In questo argomento viene descritto come usare l'oggetto ActivityValidationServices per eseguire la convalida delle attività.

Uso di ActivityValidationServices

L'oggetto ActivityValidationServices dispone di due overload Validate usati per richiamare la logica di convalida di un'attività. Il primo overload accetta l'attività radice da convalidare e restituisce una raccolta di errori e di avvisi di convalida. Nell'esempio seguente viene usata un'attività Add personalizzata con due argomenti obbligatori.

public sealed class Add : CodeActivity<int>  
{  
    [RequiredArgument]  
    public InArgument<int> Operand1 { get; set; }  
  
    [RequiredArgument]  
    public InArgument<int> Operand2 { get; set; }  
  
    protected override int Execute(CodeActivityContext context)  
    {  
        return Operand1.Get(context) + Operand2.Get(context);  
    }  
}  

L'attività Add viene usata all'interno di un oggetto Sequence, ma i due relativi argomenti obbligatori non sono associati, come illustrato nell'esempio seguente.

Variable<int> Operand1 = new Variable<int>{ Default = 10 };  
Variable<int> Operand2 = new Variable<int>{ Default = 15 };  
Variable<int> Result = new Variable<int>();  
  
Activity wf = new Sequence  
{  
    Variables = { Operand1, Operand2, Result },  
    Activities =
    {  
        new Add(),  
        new WriteLine  
        {  
            Text = new InArgument<string>(env => "The result is " + Result.Get(env))  
        }  
    }  
};  

Questo flusso di lavoro può essere convalidato chiamando Validate. Validate restituisce una raccolta di tutti gli avvisi e gli errori di convalida contenuti nell'attività e negli elementi figlio, come mostrato nell'esempio riportato di seguito.

ValidationResults results = ActivityValidationServices.Validate(wf);  
  
if (results.Errors.Count == 0 && results.Warnings.Count == 0)  
{  
    Console.WriteLine("No warnings or errors");  
}  
else  
{  
    foreach (ValidationError error in results.Errors)  
    {  
        Console.WriteLine("Error: {0}", error.Message);  
    }  
    foreach (ValidationError warning in results.Warnings)  
    {  
        Console.WriteLine("Warning: {0}", warning.Message);  
    }  
}  

Quando il metodo Validate viene chiamato in questo flusso di lavoro di esempio, vengono restituiti due errori di convalida.

Errore: Valore non specificato per un argomento di attività 'Operand2' obbligatorio.
Errore: Valore non specificato per un argomento di attività 'Operand1' obbligatorio. Se questo flusso di lavoro viene richiamato, viene generata un'eccezione InvalidWorkflowException, come illustrato nell'esempio seguente.

try  
{  
    WorkflowInvoker.Invoke(wf);  
}  
catch (Exception ex)  
{  
    Console.WriteLine(ex);  
}  

System.Activities.InvalidWorkflowException:
Gli errori seguenti sono stati rilevati durante l'elaborazione della struttura ad albero del flusso di lavoro:'Aggiungi': Valore non specificato per un argomento di attività 'Operand2' obbligatorio.'Aggiungi': Valore non specificato per un argomento di attività 'Operand1' obbligatorio. Affinché questo flusso di lavoro di esempio sia valido, è necessario associare i due argomenti obbligatori dell'attività Add. Nell'esempio seguente i due argomenti obbligatori vengono associati alle variabili del flusso di lavoro insieme al valore di risultato. In questo esempio l'argomento Result viene associato insieme ai due argomenti obbligatori. L'argomento Result non deve essere associato e tale condizione non genera un errore di convalida. È compito dell'autore del flusso di lavoro associare la proprietà Result qualora il relativo valore venisse usato in altri punti all'interno del flusso di lavoro.

new Add  
{  
    Operand1 = Operand1,  
    Operand2 = Operand2,  
    Result = Result  
}  

Convalida di argomenti obbligatori nell'attività radice

Se l'attività radice di un flusso di lavoro dispone di argomenti, questi vengono associati solo quando il flusso di lavoro viene richiamato e i parametri vengono passati al flusso di lavoro. Il seguente flusso di lavoro supera la convalida, ma viene generata un'eccezione se il flusso di lavoro viene richiamato senza passare gli argomenti obbligatori, come illustrato nell'esempio seguente.

Activity wf = new Add();  
  
ValidationResults results = ActivityValidationServices.Validate(wf);  
// results has no errors or warnings, but when the workflow  
// is invoked, an InvalidWorkflowException is thrown.  
try  
{  
    WorkflowInvoker.Invoke(wf);  
}  
catch (Exception ex)  
{  
    Console.WriteLine(ex);  
}  

System.ArgumentException: le impostazioni degli argomenti dell'attività radice non sono corrette.
Correggere la definizione del flusso del lavoro o fornire valori di input per risolvere questi errori:'Aggiungi': Valore non specificato per un argomento di attività 'Operand2' obbligatorio.'Aggiungi': Valore non specificato per un argomento di attività 'Operand1' obbligatorio. Una volta passati gli argomenti appropriati, il flusso di lavoro viene completato correttamente, come illustrato nell'esempio seguente.

Add wf = new Add();  
  
ValidationResults results = ActivityValidationServices.Validate(wf);  
// results has no errors or warnings, and the workflow completes  
// successfully because the required arguments were passed.  
try  
{  
    Dictionary<string, object> wfparams = new Dictionary<string, object>  
    {  
        { "Operand1", 10 },  
        { "Operand2", 15 }  
    };  
  
    int result = WorkflowInvoker.Invoke(wf, wfparams);  
    Console.WriteLine("Result: {0}", result);  
}  
catch (Exception ex)  
{  
    Console.WriteLine(ex);  
}  

In caso di convalida di argomenti radice, è compito dell'applicazione host assicurare che vengano passati tutti gli argomenti obbligatori quando viene richiamato il flusso di lavoro.

Chiamata della convalida basata su codice imperativo

La convalida basata su codice imperativo fornisce un modo semplice per la convalida automatica di un'attività ed è disponibile per le attività che derivano dagli oggetti CodeActivity, AsyncCodeActivity e NativeActivity. Il codice di convalida che determina qualsiasi errore o avviso di convalida viene aggiunto all'attività. Quando la convalida viene richiamata sull'attività, questi avvisi o errori sono contenuti nella raccolta restituita dalla chiamata a Validate. Nell'esempio seguente viene definita un'attività CreateProduct . Se Cost è maggiore di Price, viene aggiunto un errore di convalida ai metadati nell'override di CacheMetadata.

public sealed class CreateProduct : CodeActivity  
{  
    public double Price { get; set; }  
    public double Cost { get; set; }  
  
    // [RequiredArgument] attribute will generate a validation error
    // if the Description argument is not set.  
    [RequiredArgument]  
    public InArgument<string> Description { get; set; }  
  
    protected override void CacheMetadata(CodeActivityMetadata metadata)  
    {  
        base.CacheMetadata(metadata);  
        // Determine when the activity has been configured in an invalid way.  
        if (this.Cost > this.Price)  
        {  
            // Add a validation error with a custom message.  
            metadata.AddValidationError("The Cost must be less than or equal to the Price.");  
        }  
    }  
  
    protected override void Execute(CodeActivityContext context)  
    {  
        // Not needed for the sample.  
    }  
}  

In questo esempio, un flusso di lavoro viene configurato usando l'attività CreateProduct. In questo flusso di lavoro, Cost è maggiore di Price e l'argomento obbligatorio Description non è impostato. Quando viene richiamata la convalida, vengono restituiti gli errori seguenti.

Activity wf = new Sequence  
{  
    Activities =
    {  
        new CreateProduct  
        {  
            Cost = 75.00,  
            Price = 55.00  
            // Cost > Price and required Description argument not set.  
        },  
        new WriteLine  
        {  
            Text = "Product added."  
        }  
    }  
};  
  
ValidationResults results = ActivityValidationServices.Validate(wf);  
  
if (results.Errors.Count == 0 && results.Warnings.Count == 0)  
{  
    Console.WriteLine("No warnings or errors");  
}  
else  
{  
    foreach (ValidationError error in results.Errors)  
    {  
        Console.WriteLine("Error: {0}", error.Message);  
    }  
    foreach (ValidationError warning in results.Warnings)  
    {  
        Console.WriteLine("Warning: {0}", warning.Message);  
    }  
}  

Errore: Cost deve essere minore o uguale a Price.
Errore: Valore non specificato per un argomento di attività 'Description' obbligatorio.

Utilizzo dell'oggetto ValidationSettings

Per impostazione predefinita, tutte le attività nell'albero delle attività vengono valutate quando la convalida viene richiamata da ActivityValidationServices. ValidationSettings consente di personalizzare la convalida in vari modi attraverso la configurazione delle relative tre proprietà. SingleLevel specifica se il validator deve analizzare l'intero albero delle attività o applicare semplicemente la logica di convalida all'attività fornita. L'impostazione predefinita per questo valore è false. AdditionalConstraints specifica il mapping di vincoli aggiuntivi da un tipo a un elenco di vincoli. Per il tipo base di ogni attività nell'albero delle attività convalidata è disponibile una ricerca nella proprietà AdditionalConstraints. Se viene individuato un elenco di vincoli corrispondente, tutti i vincoli nell'elenco vengono valutati per l'attività. OnlyUseAdditionalConstraints specifica se tutti i vincoli o solo quelli specificati in AdditionalConstraints devono essere valutati dal validator. Il valore predefinito è false. Gli autori di host del flusso di lavoro usano AdditionalConstraints e OnlyUseAdditionalConstraints per aggiungere un'ulteriore convalida ai flussi di lavoro, quali i vincoli di criteri per strumenti come FxCop. Per altre informazioni sui vincoli, vedere Vincoli dichiarativi.

Per usare l'oggetto ValidationSettings, configurare le proprietà desiderate, quindi passarlo nella chiamata al metodo Validate. In questo esempio viene convalidato un flusso di lavoro che è costituito da un oggetto Sequence con un'attività Add personalizzata. L'attività Add dispone di due argomenti obbligatori.

public sealed class Add : CodeActivity<int>  
{  
    [RequiredArgument]  
    public InArgument<int> Operand1 { get; set; }  
  
    [RequiredArgument]  
    public InArgument<int> Operand2 { get; set; }  
  
    protected override int Execute(CodeActivityContext context)  
    {  
        return Operand1.Get(context) + Operand2.Get(context);  
    }  
}  

L'attività Add seguente viene usata in un oggetto Sequence, ma i due argomenti obbligatori non sono associati.

Variable<int> Operand1 = new Variable<int> { Default = 10 };  
Variable<int> Operand2 = new Variable<int> { Default = 15 };  
Variable<int> Result = new Variable<int>();  
  
Activity wf = new Sequence  
{  
    Variables = { Operand1, Operand2, Result },  
    Activities =
    {  
        new Add(),  
        new WriteLine  
        {  
            Text = new InArgument<string>(env => "The result is " + Result.Get(env))  
        }  
    }  
};  

Per l'esempio seguente, la convalida viene eseguita con la proprietà SingleLevel impostata su true, pertanto solo l'attività Sequence radice viene convalidata.

ValidationSettings settings = new ValidationSettings  
{  
    SingleLevel = true  
};  
  
ValidationResults results = ActivityValidationServices.Validate(wf, settings);  
  
if (results.Errors.Count == 0 && results.Warnings.Count == 0)  
{  
    Console.WriteLine("No warnings or errors");  
}  
else  
{  
    foreach (ValidationError error in results.Errors)  
    {  
        Console.WriteLine("Error: {0}", error.Message);  
    }  
    foreach (ValidationError warning in results.Warnings)  
    {  
        Console.WriteLine("Warning: {0}", warning.Message);  
    }  
}  

Di seguito viene visualizzato l'output del codice:

Assenza di avvisi ed errori Anche se l'attività Add dispone di argomenti obbligatori che non sono associati, la convalida viene completata perché viene valutata solo l'attività radice. Questo tipo di convalida è utile per convalidare solo elementi specifici in un albero delle attività, ad esempio la convalida di una modifica a una proprietà di una singola attività in una finestra di progettazione. Si noti che se questo flusso di lavoro viene richiamato, viene valutata l'intera convalida configurata nel flusso di lavoro ed eventualmente viene generata un'eccezione InvalidWorkflowException. ActivityValidationServices e ValidationSettings configurano solo la convalida richiamata in modo esplicito dall'host e non la convalida che viene eseguita quando un flusso di lavoro viene richiamato.