ビルド イベントを指定する (C#)
ビルド開始前またはビルド終了後に実行するコマンドを指定するには、ビルド イベントを使用します。
ビルド イベントを指定する
ソリューション エクスプローラーで、ビルド イベントを指定するプロジェクトを選択します。
[プロジェクト] メニューの [プロパティ] をクリックします。
ビルド イベント タブを選択します。
[ビルド前に実行するコマンド ライン] ボックスで、ビルド イベントの構文を指定します。
メモ
プロジェクトが最新の状態で、ビルドがトリガーされない場合、ビルド前イベントは実行されません。
[ビルド後に実行するコマンド ライン] ボックスで、ビルド イベントの構文を指定します。
メモ
.bat ファイルを実行するすべてのビルド後コマンドの前に
callステートメントを追加してください。 たとえば、call MyFile.batまたはcall MyFile.bat call MyFile2.batのようにします。 パスは、絶対パスでも、出力フォルダーに対する相対パスでもかまいません。[ビルド後イベントの実行] ボックスで、ビルド後イベントを実行する条件を指定します。
メモ
長い構文を追加する場合、または [ビルド前に実行するコマンド ライン]/[ビルド後に実行するコマンド ライン] ダイアログ ボックスでビルド マクロを選択する場合は、省略記号 [...] ボタンをクリックして編集ボックスを表示します。
ソリューション エクスプローラーで、ビルド イベントを指定するプロジェクトを選択します。
[プロジェクト] メニューで、[{ProjectName} のプロパティ] をクリックします (または、ソリューション エクスプローラーから、Alt+Enter キーを押します)。
[ビルド] > [イベント] を選択します。
[ビルド前のイベント] セクションで、ビルド イベントの構文を指定します。
メモ
プロジェクトが最新の状態で、ビルドがトリガーされない場合、ビルド前イベントは実行されません。
[ビルド後のイベント] セクションで、ビルド イベントの構文を指定します。
メモ
.bat ファイルを実行するすべてのビルド後コマンドの前に
callステートメントを追加してください。 たとえば、call MyFile.batまたはcall MyFile.bat call MyFile2.batのようにします。 パスは、絶対パスでも、プロジェクト フォルダーに対する相対パスでもかまいません。[ビルド後のイベントをいつ実行するか] セクションで、ビルド後のイベントを実行する条件を指定します。
ビルド イベント コマンドを作成する
ビルド イベント コマンドでは、コマンド プロンプトまたは .bat ファイルで有効な任意のコマンドを使うことができます。 使用可能なコマンドについては、Windows のコマンド リファレンスに記載されています。 後続のすべてのコマンドが確実に実行されるように、バッチ ファイルの名前の前には call を記述する必要があります。 バッチ ファイル自体は、出力フォルダー (例: bin/Debug) から実行されます。 同じバッチ ファイルがすべての構成で必要な場合は、それをプロジェクト ファイルと同じフォルダーに配置し、call ../../prebuild.bat などの相対パスを使用できます。
PowerShell MyPowerShellScript.ps1 などのコマンドを入力することで、PowerShell スクリプトを実行できます。 PowerShell スクリプトへのパスは絶対パスにするか、プロジェクト ディレクトリに対する相対パスにすることができます。 スクリプトを実行するには、オペレーティング システム上の PowerShell スクリプトの実行ポリシーが適切に設定されていることを確認する必要があります。 実行ポリシーに関するページを参照してください。
bash などの別のシェルを使用する場合は、通常、Windows コマンド プロンプトからシェル スクリプトを起動する場合と同じコマンド構文を使用します。 サードパーティ製のシェルの使用についてはこのドキュメントでは取り上げませんが、Stack Overflow などのサイトが役に立つ場合があります。
プロジェクト ファイル内
前のステップを実行すると、Visual Studio で、PreBuild または PostBuild ターゲットと、指定したステップを実行するために必要な MSBuild コードが追加されることで、プロジェクト ファイルに変更が加えらえれます。 プロジェクト ファイルを開いて、その手順を確認することができます。 プロジェクト ファイルの手順は変更しても問題ありません。 変更を保存した後は、プロジェクトのプロパティの [ビルド] > [イベント] セクションで、変更を確認できます。
<Target Name="PreBuild" BeforeTargets="PreBuildEvent">
<Exec Command="call prebuild.bat" />
</Target>
<Target Name="PostBuild" AfterTargets="PostBuildEvent">
<Exec Command="call postbuild.bat" />
</Target>
Exec 要素は、MSBuild Exec タスクを参照します。 実行のカスタマイズに使用できるその他のパラメーターについては、「Exec タスク」を参照してください。 たとえば、WorkingDirectory を使用して、実行可能ファイルの実行元フォルダーを設定できます。 既定値は、プロジェクト ファイルを含むディレクトリです。
<Exec Command="call prebuild.bat" WorkingDirectory="$(OutDir)">
前の例の OutDir などの MSBuild プロパティ (マクロ) は、この記事の「マクロ」で後述するように使用できます。
エラーとその他の出力
ビルド イベントの出力は、出力ウィンドウの [ビルド] セクションに書き込まれます。 これを開くには、[表示 ]、[他のウィンドウ>] もしくは [出力ウィンドウ ] を選択するか、Ctrl または Alt+を押しながら O+を押します。 [からの出力を表示] の横にあるドロップダウンで、[ビルド] を選択します。
ビルド前またはビルド後イベントが正常に完了しない場合は、ゼロ (0) 以外のコードでイベント アクションを終了させることで、ビルドを終了することができます。 ゼロの終了コードは正常なアクションを示します。その他の終了コードはエラーと見なされます。
ビルド前イベントが失敗した場合は、[エラー一覧] ウィンドウに次のようなエラーが表示されることがあります。
MSB3073 The command "call c:\source\repos\prebuild.bat" exited with code 1.
[エラー一覧] ウィンドウに十分な情報がない場合は、出力ウィンドウを使用して、バッチ ファイルからのすべての出力が含まれる、完全なビルド出力を確認することができます。
ヒント
[エラー一覧] ウィンドウは、イベントに入力した最初の行である 1 行の出力のみに制限されます。 [エラー一覧] ウィンドウの出力が重要な場合は、イベントに複数の行を含めることは避けてください。 Windows コマンド プロンプトまたはオペレーティング システムからバッチ ファイルを作成し、そのイベントにだけ call mybatchfile.bat を使用します。 コマンドをバッチ ファイル自体に含めます。
バッチ ファイルで使用できるコマンドのガイダンスについては、「Windows のコマンド」を参照してください。
マクロ
一般に使用できる "マクロ" (実際には MSBuild のプロパティ) は MSBuild 共通プロパティに関するページに記載されています。 .NET SDK プロジェクト (.NET Core または .NET 5 以降) の場合、追加のプロパティは「Microsoft.NET.Sdk の MSBuild プロパティ」に記載されています。
ビルド イベントのスクリプトでは、プロジェクトの名前や出力フォルダーの場所など、一部のプロジェクトレベルの変数の値を参照することができます。 以前のバージョンの Visual Studio では、これらは マクロ と呼ばれていました。 最近のバージョンの Visual Studio では、マクロに相当するものは MSBuild プロパティです。 MSBuild は、Visual Studio がビルドを実行するときにプロジェクト ファイルの処理に使われるビルド エンジンです。 IDE のビルド イベントにより、プロジェクト ファイル内の MSBuild ターゲットが発生します。 プロジェクト ファイル内のターゲットで使用できる任意の MSBuild プロパティ ($(OutDir) や $(Configuration)など) を使用できます。 これらのイベントで使用できる MSBuild プロパティは、.props や .targets のファイルなどのプロジェクト ファイルに暗黙的または明示的にインポートされたファイルや、PropertyGroup 要素などのプロジェクト ファイルに設定されたプロパティによって異なります。 各プロパティのスペルが正確になるように注意してください。 プロパティのスペルを間違えてもエラーにはなりません。その代わり、未定義のプロパティは空文字列として評価されます。
たとえば、ビルド前のイベントを次のように指定するとします。
このビルド前のイベントは、次のようにプロジェクト ファイルの Target というエントリになります。
<Target Name="PreBuild" BeforeTargets="PreBuildEvent">
<Exec Command="echo Configuration: $(Configuration)
echo DevEnvDir: $(DevEnvDir)
echo OutDir: $(OutDir)
echo ProjectDir: $(ProjectDir)
echo VisualStudioVersion: $(VisualStudioVersion)
echo AssemblySearchPaths: $(AssemblySearchPaths)
echo AssemblyName: $(AssemblyName)
echo BaseIntermediateOutputPath: $(BaseIntermediateOutputPath)
echo CscToolPath: $(CscToolPath)" />
</Target>
ビルド イベントは、Command として指定した入力と共に Exec タスクを含むターゲットとして表示されます。 改行は XML でエンコードされます。
この例でプロジェクトをビルドすると、ビルド前イベントでいくつかのプロパティの値が出力されます。 この例では、$(CscToolPath) は定義されていないため、何も出力されません。 これは省略可能なプロパティであり、C# コンパイラのカスタマイズされたインスタンスへのパスを指定するために、プロジェクト ファイル内で定義できます (たとえば、異なるバージョンの csc.exe や、実験用のコンパイラをテストしている場合など)。
ビルド イベントの出力はビルド出力に書き込まれ、[出力] ウィンドウに表示されます。 [出力元の表示] ドロップダウンで、[ビルド] を選びます。
Build started...
1>------ Build started: Project: ConsoleApp4, Configuration: Debug Any CPU ------
1>You are using a preview version of .NET. See: https://aka.ms/dotnet-core-preview
1>Configuration: Debug
1>DevEnvDir: C:\Program Files\Microsoft Visual Studio\2022\Preview\Common7\IDE\
1>OutDir: bin\Debug\net6.0\
1>ProjectDir: C:\source\repos\ConsoleApp4\ConsoleApp4\
1>VisualStudioVersion: 17.0
1>ALToolsPath:
1>AssemblySearchPaths: {CandidateAssemblyFiles};{HintPathFromItem};{TargetFrameworkDirectory};{RawFileName}
1>AssemblyName: ConsoleApp4
1>BaseIntermediateOutputPath: obj\
1>CscToolsPath:
1>Skipping analyzers to speed up the build. You can execute 'Build' or 'Rebuild' command to run analyzers.
1>ConsoleApp4 -> C:\source\repos\ConsoleApp4\ConsoleApp4\bin\Debug\net6.0\ConsoleApp4.dll
メモ
一部のシナリオでは、ビルド イベントで実行できるものよりも、より複雑なビルド アクションが必要です。 たとえば、多くの一般的なコード生成シナリオでは、クリーンとリビルドの操作を処理する必要があります。また、コード生成ステップに対してインクリメンタル ビルドを有効にし、入力に関して出力が古くなっている場合にのみステップが実行されるようにすることができます。 MSBuild は、これらのすべてのシナリオをインテリジェントに処理するように設計されています。 AfterTargets または BeforeTargets を指定し、ビルド プロセスの特定の時点で実行するカスタム ターゲットを作成することを検討してください。また、高度なシナリオでさらなる制御を行うために、カスタム タスクの作成を検討するか、ビルドをカスタマイズする別の方法を確認してください。
例
プロジェクト フォルダーに、次のような内容の
postbuild.batという名前のバッチ ファイルを作成します。echo Copying output file %1 to %1.copy copy %1 %1.copyバッチ ファイルにおいて、
%1は渡された最初の引数を指すことを思い出してください。プロジェクト プロパティの [ビルド後のイベント] セクションでそのバッチ ファイルを呼び出し、MSBuild プロパティ
$(TargetPath)を使用して引数を渡します。call postbuild.bat $(TargetPath)プロジェクトをビルドし、出力フォルダーを確認します。 ビルドされたアセンブリの横に、コピーしたファイルが表示されます。 出力ウィンドウの [ビルド] セクションに、バッチ ファイルの出力が表示されます。
1>Output file is C:\source\repos\ConsoleApp-BuildEvents\ConsoleApp-BuildEvents\bin\Debug\net6.0\ConsoleApp-BuildEvents.dll 1> 1 file(s) copied. ========== Build: 1 succeeded, 0 failed, 0 up-to-date, 0 skipped ========== ========== Build started at 12:00 PM and took 00.723 seconds ==========