Cara: Menambahkan alat build kustom ke proyek MSBuild

Alat build kustom adalah alat baris perintah yang ditentukan pengguna yang terkait dengan file tertentu.

Untuk file tertentu, tentukan dalam file proyek (.vcxproj) baris perintah yang akan dijalankan, file input atau output lainnya, dan pesan yang akan ditampilkan. Jika MSBuild menentukan bahwa file output Anda sudah kedaluarsa relatif terhadap file input Anda, MSBuild menampilkan pesan dan menjalankan alat baris perintah.

Tentukan alat build kustom dan langkah-langkah build kustom

Untuk menentukan kapan alat build kustom dijalankan, gunakan salah satu atau kedua CustomBuildBeforeTargets elemen XML dan CustomBuildAfterTargets dalam file proyek. Misalnya, Anda dapat menentukan bahwa alat build kustom Anda berjalan setelah pengkompilasi MIDL dan sebelum pengkompilasi C/C++. Tentukan CustomBuildBeforeTargets elemen untuk menjalankan alat sebelum target tertentu berjalan. CustomBuildAfterTargets Gunakan elemen untuk menjalankan alat setelah target tertentu berjalan. Gunakan kedua elemen untuk menjalankan alat antara eksekusi dua target. Jika tidak ada elemen yang ditentukan, alat build kustom Anda akan dijalankan di lokasi defaultnya, yaitu sebelum target MIDL .

Langkah-langkah build kustom dan alat build kustom berbagi informasi yang ditentukan dalam CustomBuildBeforeTargets elemen xml dan CustomBuildAfterTargets . Tentukan target tersebut satu kali dalam file proyek Anda.

Untuk menambahkan alat build kustom

1. Tambahkan grup item ke file proyek dan tambahkan item untuk setiap file input. Tentukan perintah dan input, output, dan pesan sebagai metadata item, seperti yang ditunjukkan di sini. Contoh ini mengasumsikan bahwa file "faq.txt" ada di direktori yang sama dengan proyek Anda. Langkah build kustom menyalinnya ke direktori output.

   <ItemGroup>
     <CustomBuild Include="faq.txt">
       <Message>Copying readme...</Message>
       <Command>copy %(Identity) $(OutDir)%(Identity)</Command>
       <Outputs>$(OutDir)%(Identity)</Outputs>
     </CustomBuild>
   </ItemGroup>
   

Untuk menentukan di mana dalam build alat build kustom dijalankan

1. Tambahkan grup properti berikut ke file proyek. Anda harus menentukan setidaknya salah satu target. Anda dapat menghilangkan yang lain jika Anda hanya tertarik untuk menjalankan langkah build Anda sebelum (atau setelah) target tertentu. Contoh ini melakukan langkah kustom setelah mengkompilasi tetapi sebelum menautkan.

   <PropertyGroup>
     <CustomBuildAfterTargets>ClCompile</CustomBuildAfterTargets>
     <CustomBuildBeforeTargets>Link</CustomBuildBeforeTargets>
   </PropertyGroup>
   

Baca juga

Panduan: Menggunakan MSBuild untuk membuat proyek C++
Cara: Menggunakan peristiwa build dalam proyek MSBuild
Cara: Menambahkan langkah build kustom ke proyek MSBuild
Makro umum untuk perintah dan properti MSBuild
Metadata item terkenal MSBuild