Metadados de item no envio de tarefas em lote

  • Artigo

O MSBuild tem a capacidade de dividir as listas de itens em diferentes categorias ou lotes, com base nos metadados do item, além de executar uma tarefa uma única vez com cada lote. Pode ser difícil entender exatamente quais itens estão sendo passados com qual lote. Este tópico aborda os cenários comuns a seguir, que envolvem o envio em lote.

  • Divisão de uma lista de itens em lotes

  • Divisão de várias listas de itens em lotes

  • Envio em lote, um item por vez

  • Filtragem de listas de itens

Para obter mais informações sobre envio em lote com o MSBuild, confira Envio em lote.

Dividir uma lista de itens em lotes

O envio em lote permite que você divida uma lista de itens em lotes diferentes com base nos metadados do item e passe cada um dos lotes em uma tarefa separadamente. Isso é útil para a criação de assemblies satélite.

O exemplo a seguir mostra como dividir uma lista de itens em lotes com base nos metadados do item. A lista de itens ExampColl é dividida em três lotes com base nos metadados do item Number. A presença de %(ExampColl.Number) no atributo Text notifica o MSBuild de que o envio em lote deve ser realizado. A lista de itens ExampColl é dividida em três lotes com base nos metadados Number e cada lote é passado separadamente para a tarefa.

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

    <ItemGroup>
        <ExampColl Include="Item1">
            <Number>1</Number>
        </ExampColl>
        <ExampColl Include="Item2">
            <Number>2</Number>
        </ExampColl>
        <ExampColl Include="Item3">
            <Number>3</Number>
        </ExampColl>
        <ExampColl Include="Item4">
            <Number>1</Number>
        </ExampColl>
        <ExampColl Include="Item5">
            <Number>2</Number>
        </ExampColl>
        <ExampColl Include="Item6">
            <Number>3</Number>
        </ExampColl>
    </ItemGroup>

    <Target Name="ShowMessage">
        <Message
            Text = "Number: %(ExampColl.Number) -- Items in ExampColl: @(ExampColl)"/>
    </Target>

</Project>

A tarefa Message exibe as seguintes informações:

Number: 1 -- Items in ExampColl: Item1;Item4

Number: 2 -- Items in ExampColl: Item2;Item5

Number: 3 -- Items in ExampColl: Item3;Item6

Dividir várias listas de itens em lotes

O MSBuild pode dividir várias listas de itens em lotes com base nos mesmos metadados. Isso facilita a divisão listas de itens diferentes em lotes para criar vários assemblies. Por exemplo, você pode ter uma lista de itens de arquivos .cs divididos em um lote de aplicativo e um lote de assembly, e uma lista de itens de arquivos de recurso divididos em um lote de aplicativo e um lote de assembly. Você poderia então usar o envio em lote para passar essas listas de itens em uma tarefa e compilar ambos o aplicativo e o assembly.

Observação

Se uma lista de itens sendo passada em uma tarefa não contiver itens com os metadados referenciados, cada item nessa lista será passado para todos os lotes.

O exemplo a seguir mostra como dividir listas com vários itens em lotes com base nos metadados do item. Cada uma das listas de itens ExampColl e ExampColl2 é dividida em três lotes com base nos metadados do item Number. A presença de %(Number) no atributo Text notifica o MSBuild de que o envio em lote deve ser realizado. As listas de itens ExampColl e ExampColl2 são divididas em três lotes com base nos metadados Number e cada lote é passado separadamente para a tarefa.

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

    <ItemGroup>

        <ExampColl Include="Item1">
            <Number>1</Number>
        </ExampColl>
        <ExampColl Include="Item2">
            <Number>2</Number>
        </ExampColl>
        <ExampColl Include="Item3">
            <Number>3</Number>
        </ExampColl>

        <ExampColl2 Include="Item4">
            <Number>1</Number>
        </ExampColl2>
        <ExampColl2 Include="Item5">
            <Number>2</Number>
        </ExampColl2>
        <ExampColl2 Include="Item6">
            <Number>3</Number>
        </ExampColl2>

    </ItemGroup>

    <Target Name="ShowMessage">
        <Message
            Text = "Number: %(Number) -- Items in ExampColl: @(ExampColl) ExampColl2: @(ExampColl2)"/>
    </Target>

</Project>

A tarefa Message exibe as seguintes informações:

Number: 1 -- Items in ExampColl: Item1 ExampColl2: Item4

Number: 2 -- Items in ExampColl: Item2 ExampColl2: Item5

Number: 3 -- Items in ExampColl: Item3 ExampColl2: Item6

Envio em lote, um item por vez

O envio em lote também pode ser executado nos metadados de itens conhecidos que são atribuídos a cada item no momento da criação. Isso assegura que cada item em uma coleção tenha alguns metadados para usar para o envio em lote. O valor de metadados Identity é útil para dividir cada item em uma lista de itens em um lote separado. Para obter uma lista completa dos metadados de itens conhecidos, confira Metadados de item conhecidos.

O exemplo a seguir mostra como enviar em lote cada item em uma lista de itens, um por vez. A ExampColl lista de itens é dividida em seis lotes, cada lote que contém um item da lista de itens. A presença de %(Identity) no atributo Text notifica o MSBuild de que o envio em lote deve ser realizado.

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

    <ItemGroup>

        <ExampColl Include="Item1"/>
        <ExampColl Include="Item2"/>
        <ExampColl Include="Item3"/>
        <ExampColl Include="Item4"/>
        <ExampColl Include="Item5"/>
        <ExampColl Include="Item6"/>

    </ItemGroup>

    <Target Name="ShowMessage">
        <Message
            Text = "Identity: '%(Identity)' -- Items in ExampColl: @(ExampColl)"/>
    </Target>

</Project>

A tarefa Message exibe as seguintes informações:

Identity: 'Item1' -- Items in ExampColl: Item1
Identity: 'Item2' -- Items in ExampColl: Item2
Identity: 'Item3' -- Items in ExampColl: Item3
Identity: 'Item4' -- Items in ExampColl: Item4
Identity: 'Item5' -- Items in ExampColl: Item5
Identity: 'Item6' -- Items in ExampColl: Item6

No entanto, não existe garantia de que Identity seja exclusivo; seu valor é o valor final avaliado do atributo Include. Portanto, se algum atributo Include for usado várias vezes, eles serão agrupados em lote. Como mostra o exemplo a seguir, essa técnica exige que os atributos Include sejam exclusivos para cada item no grupo. Para ilustrar esse ponto, considere o seguinte código:

<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <ItemGroup>
    <Item Include="1">
      <M>1</M>
    </Item>
    <Item Include="1">
      <M>2</M>
    </Item>
    <Item Include="2">
      <M>3</M>
    </Item>
  </ItemGroup>

  <Target Name="Batching">
    <Warning Text="@(Item->'%(Identity): %(M)')" Condition=" '%(Identity)' != '' "/>
  </Target>
</Project>

A saída mostra que os dois primeiros itens estão no mesmo lote, pois o atributo Include é o mesmo para eles:

test.proj(15,5): warning : 1: 1;1: 2
test.proj(15,5): warning : 2: 3

Filtrar listas de item

O envio em lote pode ser usado para filtrar certos itens de uma lista de itens antes de passá-la para uma tarefa. Por exemplo, filtrar o valor Extension de metadados de itens conhecidos permite que você execute uma tarefa somente em arquivos com uma extensão específica.

O exemplo a seguir mostra como dividir uma lista de itens em lotes com base nos metadados de item e, em seguida, filtrar esses lotes quando eles são passados para uma tarefa. A lista de itens ExampColl é dividida em três lotes com base nos metadados do item Number. O atributo Condition da tarefa especifica que somente lotes com um valor 2 para os metadados de item Number serão passados para a tarefa

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

    <ItemGroup>

        <ExampColl Include="Item1">
            <Number>1</Number>
        </ExampColl>
        <ExampColl Include="Item2">
            <Number>2</Number>
        </ExampColl>
        <ExampColl Include="Item3">
            <Number>3</Number>
        </ExampColl>
        <ExampColl Include="Item4">
            <Number>1</Number>
        </ExampColl>
        <ExampColl Include="Item5">
            <Number>2</Number>
        </ExampColl>
        <ExampColl Include="Item6">
            <Number>3</Number>
        </ExampColl>

    </ItemGroup>

    <Target Name="Exec">
        <Message
            Text = "Items in ExampColl: @(ExampColl)"
            Condition="'%(Number)'=='2'"/>
    </Target>

</Project>

A tarefa Message exibe as seguintes informações:

Items in ExampColl: Item2;Item5

Conteúdo relacionado