プロパティと項目の比較

MSBuild のプロパティと項目は、いずれもタスクに情報を渡し、条件を評価し、プロジェクト ファイルで参照する値を格納しておくために使用されます。

  • プロパティは名前と値のペアです。 詳細については、「MSBuild プロパティ」を参照してください。

  • 項目は、一般的にファイルを示すオブジェクトです。 項目オブジェクトには、メタデータ コレクションを関連付けることができます。 メタデータは名前と値のペアです。 詳細については、「MSBuild 項目」をご覧ください。

スカラーとベクター

MSBuild プロパティは 1 つの文字列値のみを持つ名前と値のペアなので、多くの場合はスカラーと説明されます。 MSBuild 項目の種類は項目のリストなので、多くの場合はベクターと説明されます。 ただし実際には、プロパティで複数の値を表すことがあり、項目の種類の項目数が 0 個または 1 個の場合があります。

ターゲットの依存関係の挿入

プロパティが複数の値を表す方法については、ターゲットをターゲットの一覧に追加して一覧を作成する場合の一般的な使用パターンを考えます。 この一覧は、一般的に、プロパティ値とターゲット名をセミコロン (;) で区切って表します。

<PropertyGroup>  
    <BuildDependsOn>  
        BeforeBuild;  
        CoreBuild;  
        AfterBuild  
    </BuildDependsOn>  
</PropertyGroup>  

通常、BuildDependsOn プロパティは、ターゲットの DependsOnTargets 属性の引数として使用され、項目一覧に変換されます。 このプロパティを上書きして、ターゲットを追加したり、ターゲットの実行順を変更したりすることができます。 次に例を示します。

<PropertyGroup>  
    <BuildDependsOn>  
        $(BuildDependsOn);  
        CustomBuild;  
    </BuildDependsOn>  
</PropertyGroup>  

CustomBuild ターゲットをターゲット一覧に追加し、BuildDependsOn に値 BeforeBuild;CoreBuild;AfterBuild;CustomBuild を付与します。

MSBuild 4.0 以降、ターゲットの依存関係の挿入は推奨されていません。 代わりに AfterTargets 属性と BeforeTargets 属性を使用してください。 詳細については、「ターゲットのビルド順序」を参照してください。

文字列と項目一覧との変換

MSBuild は、項目の種類と文字列値の変換を必要に応じて実行します。 項目一覧を文字列値にする方法については、MSBuild プロパティの値として項目の種類を使用すると何が起こるかを考えます。

<ItemGroup>  
    <OutputDir Include="KeyFiles\;Certificates\" />  
  </ItemGroup>  
<PropertyGroup>  
    <OutputDirList>@(OutputDir)</OutputDirList>  
</PropertyGroup>  

項目の種類 OutputDir には、"KeyFiles\;Certificates\" という値の Include 属性があります。 MSBuild は、この文字列を 2 つの項目 KeyFiles\ と Certificates\ に解析します。 項目の種類 OutputDir を OutputDirList プロパティの値として使用している場合、MSBuild は、項目の種類をセミコロン区切りの文字列 "KeyFiles\;Certificates\" に変換または "平坦化" します。

タスクのプロパティと項目

プロパティと項目は、MSBuild タスクの入力と出力として使用されます。 詳細については、タスクに関する記事を参照してください。

プロパティは属性としてタスクに渡されます。 タスク内の MSBuild プロパティは、値を文字列との間で変換できるプロパティの種類で表されます。 サポートされるプロパティの種類には、boolcharDateTimeDecimalDoubleintstring、および ChangeType が処理できる任意の種類が含まれます。

項目は ITaskItem オブジェクトとしてタスクに渡されます。 タスク内の ItemSpec は項目の値を表し、GetMetadata はそのメタデータを取得します。

項目の種類の項目一覧は、ITaskItem オブジェクトの配列として渡すことができます。 .NET Framework 3.5 以降、Remove 属性を使用してターゲットの項目一覧から項目を削除できるようになりました。 項目は項目一覧から削除できるため、アイテムの種類の項目数が 0 個になる可能性があります。 項目一覧をタスクに渡す場合、タスクのコードでこの可能性をチェックする必要があります。

プロパティと項目の評価順序

ビルドの評価フェーズでは、インポート対象のファイルは出現順にビルドに組み込まれます。 プロパティと項目は、次の順に 3 つのパスで定義されます。

  • プロパティが出現順に定義および修正されます。

  • 項目定義が出現順に定義および修正されます。

  • 項目が出現順に定義および修正されます。

    ビルドの実行フェーズでは、ターゲット内で定義されるプロパティおよび項目は、出現順に、1 つの段階でまとめて評価されます。

    ただし、これだけでは済みません。 プロパティ、項目定義、または項目を定義するときに、その値も評価されます。 式エバリュエーターで、値を指定する文字列が展開されます。 文字列の展開はビルド フェーズによって変わります。 プロパティと項目の詳細な評価順は次のとおりです。

  • ビルドの評価フェーズ:

    • プロパティが出現順に定義および修正されます。 プロパティ関数が実行されます。 式内のフォーム $(PropertyName) のプロパティ値が展開されます。 プロパティ値が展開された式に設定されます。

    • 項目定義が出現順に定義および修正されます。 式内のプロパティ関数は既に展開されています。 メタデータ値が展開された式に設定されます。

    • 項目の種類が出現順に定義および修正されます。 フォーム @(ItemType) の項目値が展開されます。 項目の変換も展開されます。 式内のプロパティ関数と値は既に展開されています。 項目一覧とメタデータ値が展開された式に設定されます。

  • ビルドの実行フェーズ:

    • ターゲット内に定義されているプロパティと項目は、出現順にまとめて評価されます。 プロパティ関数が実行され、式内のプロパティ値が展開されます。 項目値と項目の変換も展開されます。 プロパティ値、項目の種類値、およびメタデータ値が、展開された式に設定されます。

評価順のわかりにくい効果

ビルドの評価フェーズでは、プロパティの評価が項目の評価よりも先に実行されます。 それでも、プロパティ値が項目値に依存しているように見えることがあります。 次のスクリプトがあるとします。

<ItemGroup>  
    <KeyFile Include="KeyFile.cs">  
        <Version>1.0.0.3</Version>  
    </KeyFile>  
</ItemGroup>  
<PropertyGroup>  
    <KeyFileVersion>@(KeyFile->'%(Version)')</KeyFileVersion>  
</PropertyGroup>  
<Target Name="AfterBuild">  
    <Message Text="KeyFileVersion: $(KeyFileVersion)" />  
</Target>  

Message タスクを実行すると、次のメッセージが表示されます。

KeyFileVersion: 1.0.0.3  

これは、KeyFileVersion の値が実際には文字列 "@(KeyFile->'%(Version)')" であるためです。 プロパティが最初に定義されたときに項目と項目の変換が展開されなかったため、KeyFileVersion プロパティには展開されていない文字列値が割り当てられました。

ビルドの実行フェーズで Message タスクを処理するときに、MSBuild は文字列 "@(KeyFile->'%(Version)')" を展開して "1.0.0.3" を生成します。

プロパティと項目グループの順序が変わった場合でも、同じメッセージが表示されます。

2 つ目の例として、プロパティと項目グループがターゲット内にあるときに生じる状況を考えてみましょう。

<Target Name="AfterBuild">  
    <PropertyGroup>  
        <KeyFileVersion>@(KeyFile->'%(Version)')</KeyFileVersion>  
    </PropertyGroup>  
    <ItemGroup>  
        <KeyFile Include="KeyFile.cs">  
            <Version>1.0.0.3</Version>  
        </KeyFile>  
    </ItemGroup>  
    <Message Text="KeyFileVersion: $(KeyFileVersion)" />  
</Target>  

Message タスクを実行すると、次のメッセージが表示されます。

KeyFileVersion:   

これは、ビルドの実行フェーズ中に、ターゲット内で定義されているプロパティと項目グループが上から下の順にまとめて評価されるためです。 KeyFileVersion の定義時に KeyFile は不明です。 そのため、項目の変換によって空の文字列に展開されます。

この場合、プロパティと項目グループの順序を逆にすることで、元のメッセージが復元されます。

<Target Name="AfterBuild">  
    <ItemGroup>  
        <KeyFile Include="KeyFile.cs">  
            <Version>1.0.0.3</Version>  
        </KeyFile>  
    </ItemGroup>  
    <PropertyGroup>  
        <KeyFileVersion>@(KeyFile->'%(Version)')</KeyFileVersion>  
    </PropertyGroup>  
    <Message Text="KeyFileVersion: $(KeyFileVersion)" />  
</Target>  

KeyFileVersion の値は "@(KeyFile->'%(Version)')" ではなく "1.0.0.3" に設定されます。 Message タスクを実行すると、次のメッセージが表示されます。

KeyFileVersion: 1.0.0.3  

関連項目

詳細な概念