Sdk 風格的 csproj 對 WPF/UWP 支持不太好？有第三方 SDK 可以用！MSBuild.Sdk.Extras

原創

walter lv

2020-02-22 08:20

自從微軟推出 .NET Core 以來，新的項目文件格式以其優秀的可擴展性正吸引着更多項目採用。然而——微軟官方的 WPF/UWP 項目模板依然還在採用舊的 csproj 格式！

這只是因爲——在 .NET Core 3.0 以前，基於 Microsoft.NET.Sdk 的官方 SDK 依然對 WPF/UWP 支持不夠友好。

本文內容

爲什麼要使用第三方的 SDK？

關於項目文件格式的遷移，我和林德熙都寫過文章：

不過，這兩篇文章中的遷移方法都是手動或半自動遷移的。而且遷移完畢之後，對新增的 WPF/UWP XAML 文件的支持非常不友好——新增的 XAML 文件是看不見的，除非手工去 csproj 文件中去掉自動生成的 Remove XAML 的代碼。

這確實阻礙着我們在 WPF/UWP 項目中體會到新風格 csproj 的好處。

微軟在 Build 2018 大會上宣佈，WPF/UWP 將能夠在 .NET Core 3 中運行。想必，微軟會爲未來版本的 Microsoft.NET.Sdk 這樣的官方 SDK 添加更多的 WPF/UWP 這類格式的支持吧！即便沒有這樣的原生支持，想必也會提供官方的擴展方案。

但在此之前呢？感謝小夥伴 KodamaSakuno (神樹桜乃) 提醒我第三方 SDK 的存在 —— MSBuild.Sdk.Extras。我想，在 .NET Core 3 推出之前，這是一種不錯的中轉方案。既能體會到新風格 csproj 格式的好處，也能在將來 .NET Core 3 官方支持後較快地遷移成官方版本。

如何使用 MSBuild.Sdk.Extras

雖說是第三方 SDK，但實際使用的方便程度卻如官方般簡潔！只需要將 SDK 替換成 MSBuild.Sdk.Extras/1.6.41 即可。1.6.41 是目前 MSBuild.Sdk.Extras 在 NuGet 上的最新版本，建議訪問 NuGet Gallery - MSBuild.Sdk.Extras 使用最新穩定版本。

以下是最簡同時支持 WPF 和 UWP 雙框架的代碼：

<Project Sdk="MSBuild.Sdk.Extras/1.6.41">
  <PropertyGroup>
    <TargetFrameworks>net471;uap10.0.17134</TargetFrameworks>
  </PropertyGroup>
</Project>

▲ 在剛剛指定完 uap10.0.17134 之後，等待 Visual Studio 還原需要等待好幾分鐘。

另外，從 1.6.0 版本開始，爲 WPF 和 Windows Forms 分別新增了一個屬性，用於默認引用 WPF 或 Windows Forms 所需的程序集。

<Project Sdk="MSBuild.Sdk.Extras/1.6.41">
  <PropertyGroup>
    <TargetFramework>net471</TargetFramework>
    <!-- 以下是默認引用 WPF 相關依賴的屬性 -->
    <ExtrasEnableWpfProjectSetup>true</ExtrasEnableWpfProjectSetup>
    <!-- 以下是默認引用 Windows Forms 相關依賴的屬性 -->
    <!-- <ExtrasEnableWinFormsProjectSetup >true</ExtrasEnableWinFormsProjectSetup> -->
  </PropertyGroup>
</Project>