新 csproj 对 WPF/UWP 支持不太好？有第三方 SDK 可以用！MSBuild.Sdk.Extras
新 csproj 对 WPF/UWP 支持不太好？有第三方 SDK 可以用！MSBuild.Sdk.Extras
新 csproj 对 WPF/UWP 支持不太好？有第三方 SDK 可以用！MSBuild.Sdk.Extras
发布于 2018-05-22 07:07 更新于 2018-07-25 23:21
自从微软推出 .NET Core 以来，新的项目文件格式以其优秀的可扩展性正吸引着更多项目采用。然而——微软官方的 WPF/UWP 项目模板依然还在采用旧的 csproj 格式！
这只是因为——官方 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>从下图我们可以看出，设置 ExtrasEnableWpfProjectSetup 为 true 后，WPF 的类型将直接可用，而无需额外引用。（当然，不设置也是可以的，只是需要手动引用。）
没错，真的如此简单！在我们猜测的 .NET Core 3 支持 WPF/UWP 项目格式之前，这应该算是最简单的迁移方案了！
至于项目结构的效果，可以看下图所示（包含 UWP 的多目标）：
相比于此前的手工迁移，使用此新格式创建出来的 XAML 文件是可见的，而且 .xaml.cs 也是折叠在 .xaml 之下，且能正常编译！（当然，咱们还得考虑 UWP 和 WPF 在 XAML 书写上的细微差异）
官方提供了更多的使用方法，例如更简单的是安装 NuGet 包，而不修改 SDK。详见：onovotny/MSBuildSdkExtras: Extra properties for MSBuild SDK projects。
参考资料
本文会经常更新，请阅读原文： https://walterlv.com/post/use-msbuild-sdk-extras-for-wpf-and-uwp.html ，以避免陈旧错误知识的误导，同时有更好的阅读体验。
本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。欢迎转载、使用、重新发布，但务必保留文章署名 吕毅 （包含链接： https://walterlv.com ），不得用于商业目的，基于本文修改后的作品务必以相同的许可发布。如有任何疑问，请 与我联系 (walter.lv@qq.com) 。