Condividi tramite

Creazione di un'attività inline

  • Articolo

Le attività di MSBuild in genere vengono create compilando una classe che implementa l'interfaccia ITask. A partire dalla versione 4 di .NET Framework è possibile creare attività inline nel file di progetto. Non è necessario creare un assembly separato per ospitare l'attività. Per altre informazioni, vedere Inline Tasks (Attività inline).

Questa procedura dettagliata mostra come creare ed eseguire le attività inline seguenti:

  • Un'attività priva di parametri di input o di output.

  • Un'attività che presenta un solo parametro di input e nessun parametro di output.

  • Un'attività che presenta due parametri di input e un parametro di output che restituisce una proprietà MSBuild.

  • Un'attività che presenta due parametri di input e un parametro di output che restituisce un elemento MSBuild.

Per creare ed eseguire le attività, usare Visual Studio e la finestra del prompt dei comandi di Visual Studio nel modo seguente:

  1. Creare un file di progetto MSBuild tramite Visual Studio.

  2. Modificare il file di progetto in Visual Studio per creare l'attività inline.

  3. Usare la finestra del prompt dei comandi per compilare il progetto ed esaminare i risultati.

Creare e modificare un progetto MSBuild

Il sistema dei progetti di Visual Studio si basa su MSBuild. È pertanto possibile creare un file di progetto di compilazione usando Visual Studio. In questa sezione si crea un file di progetto Visual C#. È invece possibile creare un file di progetto visual Basic. Nel contesto di questa esercitazione, la differenza tra i due file di progetto è secondaria.

Per creare e modificare un file di progetto

  1. In Visual Studio creare un nuovo progetto usando il modello applicazione Windows Form C#. Nella casella Nome digitare InlineTasks. Digitare un percorso per la soluzione, ad esempio D:\. Verificare che l'opzione Crea directory per soluzione sia selezionata, che l'opzione Aggiungi al controllo del codice sorgente sia deselezionata e che Nome soluzione sia InlineTasks.

  2. Scegliere OK per creare il file di progetto.

  3. In Esplora soluzioni fare clic con il pulsante destro del mouse sul nodo di progetto InlineTasks e quindi scegliere Scarica progetto.

  4. Fare nuovamente clic con il pulsante destro del mouse sul nodo di progetto e quindi scegliere Modifica InlineTasks.csproj.

    Il file di progetto verrà visualizzato nell'editor del codice.

Aggiungere un'attività di base denominata Hello

Aggiungere ora al file di progetto un'attività di base che visualizza il messaggio "Hello, world!" Aggiungere anche una destinazione TestBuild predefinita per richiamare l'attività.

Per aggiungere un'attività di base denominata Hello

  1. Nel nodo Project radice modificare l'attributo DefaultTargets in TestBuild. Il nodo Project risultante sarà simile all'esempio seguente:

    <Project ToolsVersion="4.0" DefaultTargets="TestBuild" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">

  2. Aggiungere la destinazione e l'attività inline seguenti al file di progetto subito prima del tag </Project>.

    <UsingTask TaskName="Hello" TaskFactory="CodeTaskFactory" AssemblyFile="$(MSBuildToolsPath)\Microsoft.Build.Tasks.v4.0.dll" >
  <ParameterGroup />
  <Task>
    <Code Type="Fragment" Language="cs">
      Log.LogMessage(MessageImportance.High, "Hello, world!");
    </Code>
  </Task>
</UsingTask>
<Target Name="TestBuild">
  <Hello />
</Target>

  3. Salvare il file di progetto.

    Questo codice crea un'attività inline denominata Hello e senza parametri, riferimenti o Using direttive. L'attività Hello contiene un'unica riga di codice. Tale riga visualizza un messaggio di saluto nel dispositivo di registrazione predefinito, in genere la finestra della console.

Eseguire l'attività Hello

Eseguire MSBuild tramite la finestra del prompt dei comandi per costruire l'attività Hello ed elaborare la destinazione TestBuild che la richiama.

Per eseguire l'attività Hello

  1. Fare clic su Start, scegliere Tutti i programmi, , quindi individuare la cartella Strumenti di Visual Studio e infine fare clic su Prompt dei comandi di Visual Studio.

  2. Nella finestra del prompt dei comandi individuare la cartella che contiene il file di progetto, in questo caso D:\InlineTasks\InlineTasks\.

  3. Digitare msbuild senza opzioni di comando e quindi premere Invio. Per impostazione predefinita, viene compilato il file InlineTasks.csproj e viene elaborata la destinazione predefinita TestBuild che richiama l'attività Hello.

  4. Esaminare l'output nella finestra del prompt dei comandi. Dovrebbe essere visualizzata questa riga:

    Hello, world!

    Nota

    Se questa riga non viene visualizzata, salvare nuovamente il file di progetto e quindi eseguire l'attività Hello.

    Alternando l'editor del codice e la finestra del prompt dei comandi, è possibile modificare il file di progetto e visualizzare velocemente i risultati.

Definire l'attività Echo

Creare un'attività inline che accetta un parametro stringa e visualizza la stringa nel dispositivo di registrazione predefinito.

Per definire l'attività Echo

  1. Nell'editor del codice sostituire l'attività Hello e la destinazione TestBuild tramite il codice seguente.

    <UsingTask TaskName="Echo" TaskFactory="CodeTaskFactory" AssemblyFile="$(MSBuildToolsPath)\Microsoft.Build.Tasks.v4.0.dll" >
  <ParameterGroup>
    <Text Required="true" />
  </ParameterGroup>
  <Task>
    <Code Type="Fragment" Language="cs">
      Log.LogMessage(MessageImportance.High, Text);
    </Code>
  </Task>
</UsingTask>
<Target Name="TestBuild">
  <Echo Text="Greetings!" />
</Target>

  2. Nella finestra del prompt dei comandi digitare msbuild senza opzioni di comando e quindi premere Invio. Per impostazione predefinita, viene elaborata la destinazione predefinita TestBuild che richiama l'attività Echo.

  3. Esaminare l'output nella finestra del prompt dei comandi. Dovrebbe essere visualizzata questa riga:

    Greetings!

    Questo codice definisce un'attività inline denominata Echo che presenta un unico parametro di input obbligatorio denominato Text. Per impostazione predefinita, i parametri sono di tipo System.String. Il valore del parametro Text viene impostato quando la destinazione TestBuild richiama l'attività Echo.

Definire l'attività Adder

Creare un'attività inline che aggiunge due parametri Integer e ne genera la somma come proprietà MSBuild.

Per definire l'attività Adder

  1. Nell'editor del codice sostituire l'attività Echo e la destinazione TestBuild usando il codice seguente.

    <UsingTask TaskName="Adder" TaskFactory="CodeTaskFactory" AssemblyFile="$(MSBuildToolsPath)\Microsoft.Build.Tasks.v4.0.dll" >
  <ParameterGroup>
    <A ParameterType="System.Int32" Required="true" />
    <B ParameterType="System.Int32" Required="true" />
    <C ParameterType="System.Int32" Output="true" />
  </ParameterGroup>
  <Task>
    <Code Type="Fragment" Language="cs">
      C = A + B;
    </Code>
  </Task>
</UsingTask>
<Target Name="TestBuild">
  <Adder A="4" B="5">
    <Output PropertyName="Sum" TaskParameter="C" />
  </Adder>
  <Message Text="The sum is $(Sum)" Importance="High" />
</Target>

  2. Nella finestra del prompt dei comandi digitare msbuild senza opzioni di comando e quindi premere Invio. Per impostazione predefinita, viene elaborata la destinazione predefinita TestBuild che richiama l'attività Echo.

  3. Esaminare l'output nella finestra del prompt dei comandi. Dovrebbe essere visualizzata questa riga:

    The sum is 9

    Questo codice definisce un'attività inline denominata Adder che presenta due parametri di input Integer obbligatori, A e B, e un parametro di output Integer, C. L'attività Adder aggiunge i due parametri di input e restituisce la somma nel parametro di output. La somma viene generata come proprietà MSBuild denominata Sum. I valori dei parametri di input vengono impostati quando la destinazione TestBuild richiama l'attività Adder.

Definire l'attività RegX

Creare un'attività inline che accetta un gruppo di elementi e un'espressione regolare e restituisce un elenco di tutti gli elementi il cui contenuto di file corrisponde all'espressione.

Per definire l'attività RegX

  1. Nell'editor del codice sostituire l'attività Adder e la destinazione TestBuild tramite il codice seguente.

    <UsingTask TaskName="RegX" TaskFactory="CodeTaskFactory" AssemblyFile="$(MSBuildToolsPath)\Microsoft.Build.Tasks.v4.0.dll" >
  <ParameterGroup>
    <Expression Required="true" />
    <Files ParameterType="Microsoft.Build.Framework.ITaskItem[]" Required="true" />
    <Result ParameterType="Microsoft.Build.Framework.ITaskItem[]" Output="true" />
  </ParameterGroup>
  <Task>
    <Using Namespace="System.Text.RegularExpressions"/>
    <Code Type="Fragment" Language="cs">
<![CDATA[
      if (Files.Length > 0)
      {
        Result = new TaskItem[Files.Length];
        for (int i = 0; i < Files.Length; i++)
        {
          ITaskItem item = Files[i];
          string path = item.GetMetadata("FullPath");
          using(StreamReader rdr = File.OpenText(path))
          {
            if (Regex.Match(rdr.ReadToEnd(), Expression).Success)
            {
              Result[i] = new TaskItem(item.ItemSpec);
            }
          }
        }
      }
]]>
    </Code>
  </Task>
</UsingTask>
<Target Name="TestBuild">
  <RegX Expression="public|protected" Files="@(Compile)">
    <Output ItemName="MatchedFiles" TaskParameter="Result" />
  </RegX>
  <Message Text="Input files: @(Compile)" Importance="High" />
  <Message Text="Matched files: @(MatchedFiles)" Importance="High" />
</Target>

  2. Nella finestra del prompt dei comandi digitare msbuild senza opzioni di comando e quindi premere Invio. Per impostazione predefinita, viene elaborata la destinazione predefinita TestBuild che richiama l'attività RegX.

  3. Esaminare l'output nella finestra del prompt dei comandi. Dovrebbero essere visualizzate queste righe:

    Input files: Form1.cs;Form1.Designer.cs;Program.cs;Properties\AssemblyInfo.cs;Properties\Resources.Designer.cs;Properties\Settings.Designer.cs

    Matched files: Form1.cs;Form1.Designer.cs;Properties\Settings.Designer.cs

    Questo codice definisce un'attività inline denominata RegX che presenta i tre parametri seguenti:

  • Expression è un parametro stringa di input obbligatorio il cui valore è l'espressione regolare rispetto a cui verificare la corrispondenza. In questo esempio, la verifica viene eseguita rispetto alle parole "public" e "protected".

  • Files è un parametro di input obbligatorio di tipo elenco di elementi e il cui valore è un elenco di file in cui verificare la corrispondenza. In questo esempio Files viene impostato sull'elemento Compile che elenca i file di origine del progetto.

  • Result è un parametro di output il cui valore è l'elenco dei file con un contenuto corrispondente all'espressione regolare.

    I valori dei parametri di input vengono impostati quando la destinazione TestBuild richiama l'attività RegX. L'attività RegX legge tutti i file e restituisce l'elenco di quelli che corrispondono all'espressione regolare. Questo elenco viene restituito tramite il parametro di output Result, che viene generato come elemento MSBuild denominato MatchedFiles.

Gestire caratteri riservati

Il parser di MSBuild elabora le attività inline come codice XML. I caratteri con significato riservato in XML, ad esempio "<" e ">", vengono rilevati e gestiti come se fossero XML e non nel codice sorgente .NET. Per includere i caratteri riservati nelle espressioni di codice, ad esempio Files.Length > 0, scrivere l'elemento Code in modo che il relativo contenuto si trovi in un'espressione CDATA, come indicato di seguito:

<Code Type="Fragment" Language="cs">
 <![CDATA[

 if (Files.Length > 0)
 {
     // Your code goes here.
 }
 ]]>
</Code>

Contenuto correlato