Метаданные элементов в пакетной обработке задач

  • Статья

MSBuild может разделять списки элементов на разные категории или пакеты на основе метаданных элементов и поочередно выполнять задачи с использованием каждого пакета. Не так просто понять, какие именно элементы передаются с каким пакетом. В этом разделе рассматриваются наиболее распространенные сценарии, в которых используется пакетная обработка.

  • Разделение списка элементов на пакеты

  • Деление нескольких списков элементов на пакеты

  • Пакетная обработка одного элемента за раз

  • Фильтрация списков элементов

Дополнительные сведения о пакетной обработке с помощью MSBuild см. в статье Пакетная обработка в MSBuild.

Разделение списка элементов на пакеты

Пакетная обработка позволяет разделить список элементов на различные пакеты на основе метаданных элементов и передать задаче каждый из пакетов отдельно. Это полезно при создании вспомогательных сборок.

В следующем примере показано, как разделить список элементов на пакеты на основе метаданных элементов. Список элементов ExampColl делится на три пакета на основе метаданных элементов Number. Если в атрибуте Text есть %(ExampColl.Number), MSBuild получает уведомление о том, что необходимо выполнить пакетную обработку. Список элементов ExampColl делится на три пакета на основе метаданных Number, а каждый пакет отдельно передается задаче.

<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>

Задача Message отображает следующие сведения:

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

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

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

Разделение списка элементов на пакеты

MSBuild может разделить несколько списков элементов на пакеты на основе одинаковых метаданных. Это упрощает деление различных списков элементов на пакеты для создания нескольких сборок. Например, у вас может быть список элементов с CS-файлами, разделенный на пакет приложения и пакет сборки, и список элементов с файлами ресурсов, разделенный на пакет приложения и пакет сборки. Затем, используя пакетную обработку, можно передать эти списки элементов одной задаче и создать приложение и сборку.

Примечание.

Если в передаваемом задаче списке элементов нет элементов с указанными метаданными, каждый элемент из этого списка передается во все пакеты.

В следующем примере показано, как разделить несколько списков элементов на пакеты на основе метаданных элементов. Списки элементов ExampColl и ExampColl2 делятся на три пакета на основе метаданных элементов Number. Если в атрибуте Text есть %(Number), MSBuild получает уведомление о том, что необходимо выполнить пакетную обработку. Списки элементов ExampColl и ExampColl2 делятся на три пакета на основе метаданных Number, а каждый пакет отдельно передается задаче.

<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>

Задача Message отображает следующие сведения:

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

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

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

Пакетная обработка одного элемента за раз

Пакетная обработка может также выполняться со стандартными метаданными, назначенными каждому элементу при создании. Это гарантирует, что каждый элемент в коллекции будет содержать некоторые метаданные для пакетной обработки. Значение метаданных Identity удобно использовать для выделения из списка каждого элемента в отдельный пакет. Полный список стандартных метаданных элементов см. в статье Стандартные метаданные элементов.

Следующий пример демонстрирует поочередную пакетную обработку каждого элемента из списка элементов. Список элементов ExampColl делится на шесть пакетов, каждый из которых содержит один элемент списка элементов. Если в атрибуте Text есть %(Identity), MSBuild получает уведомление о том, что необходимо выполнить пакетную обработку.

<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>

Задача Message отображает следующие сведения:

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

Однако Identity может не быть уникальным; его значение является вычисленным окончательным значением атрибута Include. Таким образом, если какие-либо атрибуты Include используются несколько раз, они объединяются в пакеты. Как показано в следующем примере, для использования этого метода атрибуты Include должны быть уникальными для каждого элемента в группе. Чтобы лучше проиллюстрировать это, рассмотрим следующий код.

<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>

Выходные данные показывают, что первые два элемента находятся в одном пакете, так как атрибут Include для них одинаков.

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

Списки элементов фильтра

Пакетную обработку можно использовать для фильтрации определенных элементов из списка элементов перед их передачей задаче. Например, фильтрация по значению известных метаданных элементов Extension позволяет выполнить задачу только для файлов с определенным расширением.

В приведенном ниже примере показано, как разделить список элементов на пакеты на основе метаданных элементов, а затем отфильтровать эти пакеты при передаче их задаче. Список элементов ExampColl делится на три пакета на основе метаданных элементов Number. Атрибут задачи Condition указывает, что задаче будут переданы только пакеты со значением метаданных элемента Number равным 2.

<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>

Задача Message отображает следующие сведения:

Items in ExampColl: Item2;Item5

Связанный контент