インクリメンタル ビルド

Visual Studio 2017 RC の最新のドキュメントの詳細については、Visual Studio 2017 RC ドキュメントをご参照ください。

インクリメンタル ビルドは、対応する入力ファイルに対して最新の状態の出力ファイルを含むターゲットが実行されないように最適化されたビルドです。 ターゲット要素には、ターゲットが入力として受け取る項目を示す Inputs 属性と、ターゲットが出力として生成する項目を示す Outputs 属性の両方を指定できます。 MSBuild は、これらの属性の値間に一対一の対応関係があるかどうかを確認します。 一対一の対応関係が存在する場合、MSBuild は、すべての入力項目のタイム スタンプをそれぞれ対応する出力項目のタイム スタンプと比較します。 一対一の対応関係が存在しない出力ファイルは、すべての入力ファイルと比較されます。 項目が最新の状態であると見なされるのは、その出力ファイルが入力ファイルと同じタイム スタンプであるかそれよりも新しい場合です。

すべての出力項目が最新の状態である場合、MSBuild はターゲットをスキップします。 このターゲットのインクリメンタル ビルドにより、ビルド速度が大幅に向上します。 一部のファイルだけが最新の状態である場合、MSBuild は最新の項目をスキップしてターゲットを実行するので、すべての項目が最新の状態になります。 これは、部分インクリメンタル ビルドと呼ばれます。

一対一の対応関係は、通常は項目の変換によって生成されます。 詳細については、「変換」を参照してください。

次にターゲットの例を示します。

<Target Name="Backup" Inputs="@(Compile)"   
    Outputs="@(Compile->'$(BackupFolder)%(Identity).bak')">  
    <Copy SourceFiles="@(Compile)" DestinationFiles=  
        "@(Compile->'$(BackupFolder)%(Identity).bak')" />  
</Target>  

Compile 項目の種類によって表されるファイル セットは、バックアップ ディレクトリにコピーされます。 バックアップ ファイル名の拡張子は .bak です。 Compile 項目の種類によって表されるファイル (対応するバックアップ ファイル) が Backup ターゲットの実行後に削除または変更されない場合、Backup ターゲットは以降のビルドでスキップされます。

出力の推論

MSBuild は、ターゲットの Inputs 属性と Outputs 属性を比較して、ターゲットを実行する必要があるかどうかを判断します。 インクリメンタル ビルドが完了した後に存在するファイル セットが、関連するターゲットが実行されるかどうかにかかわらず、同じままであることが理想的です。 タスクによって作成または変更されるプロパティと項目はビルドに影響する可能性があるため、プロパティと項目に影響するターゲットがスキップされる場合でも MSBuild はそれらの値を推論する必要があります。 これは、出力の推論と呼ばれます。

次の 3 つの場合があります。

  • ターゲットに false と評価される Condition 属性が指定されている場合。 この場合、ターゲットは実行されず、ビルドには影響しません。

  • ターゲットに古い出力があり、ターゲットを実行して最新の状態にする場合。

  • ターゲットに古い出力がなく、ターゲットがスキップされる場合。 MSBuild はターゲットを評価し、ターゲットが実行された場合と同じように項目とプロパティを変更します。

    インクリメンタル コンパイルをサポートするために、タスクでは Output 要素の TaskParameter 属性値がタスク入力パラメーターと等しいことを確認する必要があります。 次にいくつかの例を示します。

<CreateProperty Value="123">  
    <Output PropertyName="Easy" TaskParameter="Value" />  
</CreateProperty>  

これにより、ターゲットが実行またはスキップされるかどうかにかかわらず、値が "123" の Easy プロパティが作成されます。

<CreateItem Include="a.cs;b.cs">  
    <Output ItemName="Simple" TaskParameter="Include" />  
</CreateItem>  

これにより、ターゲットが実行またはスキップされるかどうかにかかわらず、"a.cs" と "b.cs" の 2 つの項目を持つ、項目の種類 Simple が作成されます。

MSBuild 3.5 以降では、ターゲットの項目グループとプロパティ グループに対して、出力の推論が自動的に実行されます。 CreateItem タスクはターゲットでは必要でないため、使用しないようにしてください。 また、CreateProperty タスクは、ターゲットが実行されたかどうかを確認する場合にのみターゲットで使用するようにしてください。

ターゲットが実行されたかどうかの確認

出力の推論のため、ターゲットが実行されたかどうかを確認できるように、CreateProperty タスクをターゲットに追加してプロパティと項目を調べる必要があります。 CreateProperty タスクをターゲットに追加し、TaskParameter が "ValueSetByTask" である Output 要素を指定します。

<CreateProperty Value="true">  
    <Output TaskParameter="ValueSetByTask" PropertyName="CompileRan" />  
</CreateProperty>  

これにより、ターゲットが実行された場合にのみ、CompileRan プロパティが作成され、値 true が指定されます。 ターゲットがスキップされた場合、CompileRan は作成されません。

参照

ターゲット