VS2022与VS2019的XML序列化差异问题咨询

问题描述 #

项目基于.NET Framework 4.5.1，在VS2019中运行以下单元测试可通过：

// Arrange
var expectedXml =
    "<?xml version=\"1.0\" encoding=\"utf-16\"?><LeadData xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\"><LanguagePreference>English</LanguagePreference>...</LeadData>";

// Act
var xmlString = contract.ToXmlString();

// Assert
Assert.AreEqual(expectedXml, xmlString);

其中ToXmlString()的实现代码如下：

var xmlSerializer = new XmlSerializer(this.GetType());
var stringWriter = new StringWriter();
var xmlWriter = new XmlTextWriter(stringWriter) { Formatting = Formatting.None };

xmlSerializer.Serialize(xmlWriter, this);
return stringWriter.ToString();

切换到VS2022后，项目仍以.NET Framework 4.5.1为目标框架，但单元测试失败，生成的XML字符串中xmlns:xsd与xmlns:xsi的顺序发生了调换：

<?xml version="1.0" encoding="utf-16"?><LeadData xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><LanguagePreference>English</LanguagePreference>...</LeadData>

原因分析 #

• VS运行时环境差异：尽管项目目标框架是.NET Framework 4.5.1，但VS2022默认使用更新版本的.NET Framework运行时（如4.8）执行项目，而VS2019可能依赖较旧的运行时版本。XmlSerializer在不同.NET Framework版本中，对默认命名空间的输出顺序实现有调整——早期版本优先输出xmlns:xsi，后续版本改为优先输出xmlns:xsd。
• XML规范与XmlSerializer特性：XML规范并未强制要求命名空间属性的顺序，XmlSerializer的实现允许在版本迭代中调整输出顺序，只要语义符合规范即可。你的单元测试通过完全匹配字符串的方式验证XML，属于依赖非规范实现细节的脆弱测试。
• 过时API的兼容性问题：XmlTextWriter是已标记过时的API，在新版.NET运行环境中，其内部处理逻辑可能被替换或优化，导致输出的属性顺序改变。推荐使用XmlWriter.Create()方法创建XmlWriter实例，替代直接使用XmlTextWriter。

内容的提问来源于stack exchange，提问作者urlreader