CommunityToolkit.Mvvm 8.3.0版本WinRT.Runtime兼容性问题解析

问题背景

CommunityToolkit.Mvvm 8.3.0版本发布后，部分开发者在Windows桌面应用开发中遇到了WinRT.Runtime程序集加载异常的问题。该问题主要影响WinForms、WPF和WinUI3等基于.NET 8的Windows应用程序，表现为运行时抛出"Could not load file or assembly 'WinRT.Runtime, Version=2.1.0.0'"异常。

问题现象

当开发者将项目从CommunityToolkit.Mvvm 8.2.2升级到8.3.0版本后，应用程序在启动时会出现以下异常：

System.TypeInitializationException: The type initializer for '<Module>' threw an exception.
Inner Exception: FileNotFoundException: Could not load file or assembly 'WinRT.Runtime, Version=2.1.0.0'

该问题在以下环境中均有报告：

• WinForms项目（目标框架net8.0-windows10.0.22621.0）
• WPF项目（目标框架net8.0-windows10.0.17763.0）
• WinUI3项目

问题根源

经过分析，该问题源于CommunityToolkit.Mvvm 8.3.0版本对WinRT.Runtime程序集版本依赖的变化。新版本需要WinRT.Runtime 2.1.0.0版本，但项目中可能存在其他组件引用了WinRT.Runtime 2.0.0.0版本，导致版本冲突。

在构建过程中，开发者可能会看到类似警告：

Found conflicts between different versions of "WinRT.Runtime" that could not be resolved.
There was a conflict between "WinRT.Runtime, Version=2.0.0.0" and "WinRT.Runtime, Version=2.1.0.0".

解决方案

方案一：调整目标框架

将项目文件中的目标框架从特定Windows版本改为通用Windows目标框架：

<TargetFramework>net8.0-windows</TargetFramework>

替代原先的：

<TargetFramework>net8.0-windows10.0.22621.0</TargetFramework>

这种方法简单有效，但可能会限制使用某些特定Windows版本的API。

方案二：添加Microsoft.Windows.CsWinRT包

在项目中添加Microsoft.Windows.CsWinRT NuGet包可以解决WinRT.Runtime版本冲突问题：

Install-Package Microsoft.Windows.CsWinRT

这种方法特别适用于需要保持特定Windows版本目标框架的项目。

方案三：临时降级版本

如果上述方案不可行，可以暂时降级到CommunityToolkit.Mvvm 8.2.2版本：

Install-Package CommunityToolkit.Mvvm -Version 8.2.2

设计器问题解决

对于WinForms设计器无法加载的问题，添加Microsoft.Windows.CsWinRT包通常可以解决。如果设计器中仍然出现WinRT相关警告，可以考虑以下调整：

1. 将自定义集合类从继承List改为继承Collection
2. 或者为需要跨WinRT ABI的类型添加partial修饰符

技术背景

WinRT.Runtime是Windows运行时(Windows Runtime)与.NET之间的互操作层。在.NET 8中，微软对WinRT互操作机制进行了调整，导致了版本兼容性问题。CommunityToolkit.Mvvm 8.3.0开始依赖较新版本的WinRT.Runtime，而Windows SDK中的某些组件仍然引用旧版本，从而产生冲突。

最佳实践建议

1. 对于新项目，建议使用net8.0-windows目标框架，除非有特定Windows版本API需求
2. 定期检查项目中的程序集版本冲突警告
3. 在设计时遇到WinRT相关问题，优先考虑添加Microsoft.Windows.CsWinRT包
4. 对于自定义集合类型，优先使用Collection而非List，以获得更好的兼容性

总结

CommunityToolkit.Mvvm 8.3.0引入的WinRT.Runtime依赖变化确实带来了一些兼容性挑战，但通过上述解决方案，开发者可以顺利升级并继续使用这个强大的MVVM工具包。理解Windows运行时与.NET互操作的底层机制，有助于更好地解决类似问题。