不容錯過的MSBuild技巧，必備用法詳解和實踐指南
一、MSBuild簡介
MSBuild是一種基于XML的構建引擎，用于在.NET Framework和.NET Core應用程序中自動化構建過程。它是Visual Studio的構建引擎，可在命令行或其他構建工具中使用。
MSBuild使用XML文件格式來指定項目的編譯、測試和部署等各個階段的任務。這些XML文件通常以.csproj文件的形式存儲。每個項目文件都包含一個或多個 PropertyGroup 元素和一個或多個 ItemGroup 元素。 PropertyGroup 元素聲明和定義屬性，例如目標框架、輸出路徑和程序集名稱等。 ItemGroup 元素創建項，例如NuGet包引用、文件和資源等。
可以使用 dotnet build 命令或 msbuild 命令來運行MSBuild，它會自動查找與當前目錄相關聯的項目并執行構建過程。你還可以使用/t選項指定一個或多個目標，例如Clean、Build和Publish。
MSBuild支持條件和屬性組合，可以為不同的目標平臺自定義構建過程。還可以使用自定義任務，例如運行代碼靜態分析器或壓縮構建輸出文件等。
二、MSBuild應用場景
MSBuild可以用于多種場景，包括：
- 編譯源代碼 MSBuild可以編譯應用程序中的源代碼文件，將它們編譯成二進制文件，以便在部署時使用。它支持多種編譯選項，例如優化、生成調試信息和設置警告等級等。
- 處理配置文件和資源文件 MSBuild還可以處理應用程序的配置文件和資源文件，例如App.config和Resources.resx文件。它可以將這些文件復制到應用程序目錄中，并將其包含在最終編譯的二進制文件中。
- 安裝和注冊組件 如果應用程序依賴于其他組件或庫，MSBuild可以自動安裝和注冊這些組件，以確保應用程序能夠正常運行。它也可以從NuGet包管理器中下載和安裝依賴項。
- 打包和部署應用程序 MSBuild可以將應用程序打包成zip文件或其他格式，以方便部署到其他環境中。它還可以自動部署應用程序到遠程服務器或云平臺上，例如Azure或AWS。
- 自定義任務 除了執行預定義的任務之外，MSBuild還可以編寫自定義任務，以執行特定的構建任務。例如，你可以編寫一個任務來執行代碼靜態分析或壓縮構建輸出文件。
三、MSBuild基礎知識
以下是一些MSBuild基礎知識：
屬性
屬性是聲明和定義變量的方式。可以使用 SetProperty 元素或 PropertyGroup元素來定義屬性。例如：
<PropertyGroup>
<MyProperty>MyValue</MyProperty>
</PropertyGroup>項
項用于表示一個或多個文件或其他資源。可以使用 ItemGroup 元素和具有Include屬性的元素來創建項。例如：
<ItemGroup>
<Compile Include="*.cs" />
</ItemGroup>任務
任務是執行構建過程中的特定操作的方式。可以使用 Task 元素和具有TaskName屬性的元素來聲明和定義任務。例如：
<TaskName Parameter1="Value1" Parameter2="Value2" />運行構建
要在命令行上運行MSBuild，請使用以下命令：
msbuild MyProject.csproj /t:Build /p:Configuration=Debug該命令將運行名為 "Build" 的構建目標，并使用名為 "Debug" 的配置文件來構建項目。
四、MSBuild高級用法
MSBuild還有許多高級用法，包括：
自定義屬性和條件
在項目文件中定義自定義屬性和條件，例如定義一個自定義屬性來指定構建輸出目錄：
<Project>
<PropertyGroup>
<OutputDirectory>bin\$(Configuration)\</OutputDirectory>
</PropertyGroup>
...
<Target Name="Build">
<MakeDir Directories="$(OutputDirectory)" />
...
</Target>
</Project>此時，可以在通用屬性文件中定義屬性值，然后在不同的項目文件中包含該通用屬性文件，以便重復使用自定義屬性。
目標依賴關系
在項目文件中聲明目標之間的依賴關系，例如，在兩個目標之間添加依賴關系：
<Project>
...
<Target Name="Build">
...
</Target>
<Target Name="Test" DependsOnTargets="Build">
...
</Target>
</Project>這樣，MSBuild在執行 "Test" 目標時，會先執行 "Build" 目標。
自定義任務
編寫自定義任務來執行構建過程中的特定任務。例如，使用 MSBuildCommunityTasks 執行 FTP 上傳：
<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
<UsingTask TaskName="FTPTask" AssemblyFile="MSBuild.Community.Tasks.dll" />
<Target Name="UploadFile">
<FTPTask ServerHost="ftp.example.com"
RemoteFile="upload.txt"
LocalFile="c:\files\upload.txt"
Username="user"
Password="pass" />
</Target>
</Project>這個示例中，定義了一個名為 "FTPTask" 的自定義任務，然后在 "UploadFile" 目標中調用該任務來執行 FTP 上傳。
條件表達式
使用條件表達式根據條件執行不同的任務。例如，根據平臺類型選擇不同的構建配置：
<Project>
...
<Choose>
<When Condition="'$(Platform)' == 'x86'">
<PropertyGroup>
<DefineConstants>DEBUG;X86</DefineConstants>
...
</PropertyGroup>
</When>
<When Condition="'$(Platform)' == 'x64'">
<PropertyGroup>
<DefineConstants>DEBUG;X64</DefineConstants>
...
</PropertyGroup>
</When>
</Choose>
...
</Project>此示例使用條件表達式 <Choose> 和 <When> 標記，通過判斷 $(Platform) 變量的值來選擇執行不同的 PropertyGroup。
自定義構建日志
自定義構建日志以記錄構建過程中的詳細信息。例如，將構建日志輸出到文件：
<Project>
<PropertyGroup>
<LogDirectory>logs\</LogDirectory>
</PropertyGroup>
<Target Name="Build">
<Exec Command="dotnet build MyApp.csproj" />
</Target>
<Target Name="LogBuild" AfterTargets="Build">
<Message Text="Writing build log to $(LogDirectory)\build.log" Importance="high" />
<WriteLinesToFile File="$(LogDirectory)\build.log" Lines="$([System.DateTime]::Now.ToString()) - Build succeeded." />
</Target>
</Project>此示例中，定義了一個名為 "LogBuild" 的目標，并在執行 "Build" 目標之后調用該目標。在 "LogBuild" 目標中，使用 <Message> 元素將日志輸出到控制臺，使用 <WriteLinesToFile> 元素將日志寫入日志文件。
五、MSBuild最佳實踐
以下是MSBuild的一些最佳實踐及代碼示例：
使用命名屬性組，以便更好地組織和管理屬性：
<Project>
<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
<DefineConstants>DEBUG;TRACE</DefineConstants>
<Optimize>false</Optimize>
<OutputPath>bin\Debug\</OutputPath>
...
</PropertyGroup>
...
</Project>在這個示例中，屬性都被包含在一個名為 "Debug|AnyCPU" 的 PropertyGroup 中。這樣可以更好地組織和管理屬性，并且可以使用條件表達式來根據需要選擇不同的屬性組。
避免硬編碼文件路徑，而是使用相對路徑和通用屬性：
<Project>
<ItemGroup>
<Compile Include="src\**\*.cs" />
...
</ItemGroup>
<PropertyGroup>
<OutputPath>bin\$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildProjectDirectory), Build.props)\)</OutputPath>
</PropertyGroup>
...
</Project>在這個示例中，使用相對路徑 "src***.cs" 來指定需要編譯的源代碼文件，并使用通用屬性來獲取輸出路徑，以避免硬編碼路徑并提高可移植性。
使用預定義的 MSBuild 目標和任務，以便重復使用現有功能：
<Project>
...
<Target Name="Clean">
<MSBuild Projects="$(MSBuildThisFileFullPath)"
Targets="CleanSolution"
Properties="Configuration=$(Configuration)" />
</Target>
...
</Project>在這個示例中，使用現有的 MSBuild 目標和任務來執行 "Clean" 目標。這樣可以重復使用現有功能并提高構建效率。
使用條件表達式來支持多個版本和平臺：
<Project>
...
<Choose>
<When Condition="'$(TargetFramework)' == 'netcoreapp3.1'">
<PropertyGroup>
<DefineConstants>NET_CORE_3_1</DefineConstants>
...
</PropertyGroup>
</When>
<When Condition="'$(TargetFramework)' == 'net5.0'">
<PropertyGroup>
<DefineConstants>NET_5_0</DefineConstants>
...
</PropertyGroup>
</When>
</Choose>
...
</Project>在這個示例中，使用條件表達式根據目標框架選擇執行不同的操作。這樣可以更好地支持多個版本和平臺，并保持代碼的簡潔和易于維護。
禁用 Visual Studio 的自動格式化選項，以避免與代碼格式化工具沖突：
<Project>
...
<PropertyGroup Condition="'$(BuildingInsideVisualStudio)' == 'true'">
<EnableEditorConfig>false</EnableEditorConfig>
</PropertyGroup>
...
</Project>在這個示例中，使用 EnableEditorConfig 屬性來禁用 Visual Studio 的自動格式化選項，以避免與代碼格式化工具沖突。這樣可以保持代碼格式化的一致性，減少錯誤和不必要的麻煩。
參考文檔：https://learn.microsoft.com/zh-cn/visualstudio/msbuild/msbuild-concepts?view=vs-2022。
