チュートリアル: インライン タスクの作成

MSBuild タスクは通常、ITask インターフェイスを実装するクラスをコンパイルして作成します。 .NET Framework Version 4 以降では、プロジェクト ファイルでタスクをインラインで作成できます。 個別のアセンブリを作成してタスクをホストする必要はありません。 詳細については、「インライン タスク」を参照してください。

このチュートリアルでは、次のインライン タスクを作成し、実行する方法について説明します。

  • 入力パラメーターも出力パラメーターも持たないタスク。

  • 1 つの入力パラメーターを持つが出力パラメーターを持たないタスク。

  • 2 つの入力パラメーターと、MSBuild プロパティを返す 1 つの出力パラメーターを持つタスク。

  • 2 つの入力パラメーターと、MSBuild 項目を返す 1 つの出力パラメーターを持つタスク。

    タスクを作成して実行するには、Visual Studio と Visual Studio コマンド プロンプト ウィンドウを使用して次の操作を実行します。

  • Visual Studio を使用して MSBuild プロジェクト ファイルを作成します。

  • Visual Studio でプロジェクト ファイルを変更してインライン タスクを作成します。

  • コマンド プロンプト ウィンドウを使用してプロジェクトをビルドし、結果を確認します。

MSBuild プロジェクトの作成と変更

Visual Studio プロジェクト システムは MSBuild に基づいています。 したがって、ビルド プロジェクト ファイルは Visual Studio を使用して作成できます。 このセクションでは、Visual C# プロジェクト ファイルを作成します (代わりに、Visual Basic プロジェクト ファイルを作成することもできます。 このチュートリアルのコンテキストでは、2 つのプロジェクト ファイルにはわずかな違いしかありません)。

プロジェクト ファイルを作成および変更するには

  1. Visual Studio で、[ファイル] メニューの [新規作成] をクリックし、[プロジェクト] をクリックします。

  2. [新しいプロジェクト] ダイアログ ボックスで、プロジェクトの種類として Visual C# を選択し、[Windows フォーム アプリケーション] テンプレートをクリックします。 [名前] ボックスに「InlineTasks」と入力します。 ソリューションの場所を入力します (D:\ など)。 [ソリューションのディレクトリを作成] がオンになっていることと、[ソース管理に追加] がオフになっていること、さらに [ソリューション名]InlineTasks になっていることを確認します。

    [OK] をクリックして、プロジェクト ファイルを作成します。

  3. ソリューション エクスプローラーで、[InlineTasks] プロジェクト ノードを右クリックし、[プロジェクトのアンロード] をクリックします。

  4. プロジェクト ノードを再度右クリックし、[InlineTasks.csproj の編集] をクリックします。

    コード エディターにプロジェクト ファイルが表示されます。

基本的な Hello タスクの追加

ここでは、"Hello, world!" というメッセージを表示する基本的なタスクをプロジェクト ファイルに追加します。 また、タスクを呼び出す既定の TestBuild ターゲットを追加します。

基本的な Hello タスクを追加するには

  1. ルートの Project ノードで、DefaultTargets 属性を TestBuild に変更します。その結果、Project ノードは次の例のようになります。

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

  2. プロジェクト ファイルの </Project> タグの直前に、次のインライン タスクとターゲットを追加します。

    <UsingTask TaskName="Hello" TaskFactory="CodeTaskFactory" AssemblyFile="$(MSBuildToolsPath)\Microsoft.Build.Tasks.v4.0.dll" >  
      <ParameterGroup />  
      <Task>  
        <Code Type="Fragment" Language="cs">  
          Log.LogMessage("Hello, world!", MessageImportance.High);  
        </Code>  
      </Task>  
    </UsingTask>  
    <Target Name="TestBuild">  
      <Hello />  
    </Target>  
    
  3. プロジェクト ファイルを保存します。

    このコードによって、パラメーター、参照、Using ステートメントがない Hello という名前のインライン タスクが作成されます。 この Hello タスクには、既定のログ デバイス (通常はコンソール ウィンドウ) に Hello メッセージを表示する 1 行のコードのみが含まれています。

Hello タスクの実行

コマンド プロンプト ウィンドウを使用して MSBuild を実行し、Hello タスクを構築して、そのタスクを呼び出す TestBuild ターゲットを処理します。

Hello タスクを実行するには
  1. [スタート][すべてのプログラム] の順にクリックし、[Visual Studio Tools] フォルダーを見つけて [Visual Studio コマンド プロンプト] をクリックします。

  2. コマンド プロンプト ウィンドウで、プロジェクト ファイルが格納されているフォルダー (この場合は D:\InlineTasks\InlineTasks\) を見つけます。

  3. コマンド スイッチを指定せずに「msbuild」と入力し、Enter キーを押します。 既定では、これによって InlineTasks.csproj ファイルがビルドされ、Hello タスクを呼び出す既定のターゲット TestBuild が処理されます。

  4. コマンド プロンプト ウィンドウで出力を確認します。 次の行が表示されます。

    Hello, world!

    注意

    Hello メッセージが表示されない場合は、プロジェクト ファイルをもう一度保存してから Hello タスクを実行してみてください。

    コード エディターとコマンド プロンプト ウィンドウを交互に使用すると、プロジェクト ファイルを変更してすばやく結果を確認できます。

Echo タスクの定義

文字列パラメーターを受け取って既定のログ デバイスに文字列を表示するインライン タスクを作成します。

Echo タスクを定義するには

  1. コード エディターで、次のコードを使用して、Hello タスクと TestBuild ターゲットを置き換えます。

    <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(Text, MessageImportance.High);  
        </Code>  
      </Task>  
    </UsingTask>  
    <Target Name="TestBuild">  
      <Echo Text="Greetings!" />  
    </Target>  
    
  2. コマンド プロンプト ウィンドウで、コマンド スイッチを指定せずに「msbuild」と入力し、Enter キーを押します。 既定では、これによって Echo タスクを呼び出す既定のターゲット TestBuild が処理されます。

  3. コマンド プロンプト ウィンドウで出力を確認します。 次の行が表示されます。

    Greetings!

    このコードによって、必須の入力パラメーター Text を 1 つだけ持つ Echo という名前のインライン タスクが定義されます。 既定では、パラメーターの型は System.String です。 Text パラメーターの値は、TestBuild ターゲットによって Echo タスクが呼び出されたときに設定されます。

Adder タスクの定義

2 つの整数パラメーターを追加して、その合計を MSBuild プロパティとして生成するインライン タスクを作成します。

Adder タスクを定義するには

  1. コード エディターで、次のコードを使用して、Echo タスクと TestBuild ターゲットを置き換えます。

    <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. コマンド プロンプト ウィンドウで、コマンド スイッチを指定せずに「msbuild」と入力し、Enter キーを押します。 既定では、これによって Echo タスクを呼び出す既定のターゲット TestBuild が処理されます。

  3. コマンド プロンプト ウィンドウで出力を確認します。 次の行が表示されます。

    The sum is 9

    このコードによって、Adder という名前のインライン タスクが定義されます。このタスクには、2 つの必須の整数入力パラメーター A と B、および 1 つの整数出力パラメーター C があります。Adder タスクによって 2 つの入力パラメーターが追加され、出力パラメーターで合計が返されます。 合計は MSBuild プロパティ Sum として生成されます。 入力パラメーターの値は、TestBuild ターゲットによって Adder タスクが呼び出されたときに設定されます。

RegX タスクの定義

項目グループおよび正規表現を受け取って、正規表現と一致するファイルの内容を含むすべての項目の一覧を返すインライン タスクを作成します。

RegX タスクを定義するには

  1. コード エディターで、次のコードを使用して、Adder タスクと TestBuild ターゲットを置き換えます。

    <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. コマンド プロンプト ウィンドウで、コマンド スイッチを指定せずに「msbuild」と入力し、Enter キーを押します。 既定では、これによって RegX タスクを呼び出す既定のターゲット TestBuild が処理されます。

  3. コマンド プロンプト ウィンドウで出力を確認します。 次の行が表示されます。

    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

    このコードによって、次の 3 つのパラメーターを持つ RegX という名前のインライン タスクが定義されます。

  • Expression: 照合する正規表現を示す値を持つ必須の文字列入力パラメーター。 この例では、正規表現は "public" または "protected" という語と一致します。

  • Files: 一致する語を検索するファイルの一覧を示す値を持つ必須の項目一覧入力パラメーター。 この例では、Files はプロジェクト ソース ファイルを一覧表示する Compile 項目に設定されます。

  • Result: 正規表現と一致する内容を含むファイルの一覧を示す値を持つ出力パラメーター。

    入力パラメーターの値は、TestBuild ターゲットによって RegX タスクが呼び出されたときに設定されます。 RegX タスクによってすべてのファイルが読み取られ、正規表現と一致するファイルの一覧が返されます。 この一覧は Result 出力パラメーターとして返され、MSBuild 項目 MatchedFiles として生成されます。

予約文字の処理

MSBuild パーサーによってインライン タスクが XML として処理されます。 XML で意味が予約されている文字 ("<" や ">" など) は、.NET ソース コードではなく XML として検出されて処理されます。 コード式に予約文字を含めるには (Files.Length > 0 など)、次のように Code 要素を記述して、その内容が CDATA 式に含まれるようにします。

<Code Type="Fragment" Language="cs">

<![CDATA[

// Your code goes here.

]]>

</Code>

関連項目

インライン タスク
タスク
ターゲット