如何编写带签名的csproj XML？解决VS编码对比警告

我编写了一个更新csproj文件XML内容的应用程序，XML格式合法，但在Visual Studio中对比新旧文件时，收到警告：左侧文件为带签名的Unicode（UTF-8），右侧文件为不带签名的Unicode（UTF-8）。

序列化XmlDocument的代码如下：

var xmlOutputSettings = new XmlWriterSettings
{
    Indent = true,
    IndentChars = "\t",
    Encoding = new UTF8Encoding(true),                
};
using var outStream = new StreamWriter(inputFile.FullName);
using var xmlWriter = XmlWriter.Create(outStream, xmlOutputSettings);
xmlOutputDocument.WriteContentTo(xmlWriter);

生成的新XML文件开头与原文件一致：

<?xml version="1.0" encoding="utf-8"?>
<Project Sdk="Microsoft.NET.Sdk.Web">

我需要保留UTF-8 BOM，但现有方案无法解决警告，求其他解决办法？

问题根源是StreamWriter的默认编码覆盖了XmlWriter的设置：StreamWriter默认使用不带BOM的UTF-8，即便XmlWriterSettings指定了带BOM的编码，最终写入文件时还是会用StreamWriter的默认编码。

方案1：直接用XmlWriter创建文件流（推荐） #

跳过StreamWriter，让XmlWriter直接操作文件流，确保编码设置完全生效：

var xmlOutputSettings = new XmlWriterSettings
{
    Indent = true,
    IndentChars = "\t",
    Encoding = new UTF8Encoding(true), // 明确启用UTF-8 BOM
    CloseOutput = true // 确保文件流自动关闭
};

using var xmlWriter = XmlWriter.Create(inputFile.FullName, xmlOutputSettings);
xmlOutputDocument.WriteContentTo(xmlWriter);

方案2：显式给StreamWriter传入带BOM的编码 #

如果必须保留StreamWriter，需要在实例化时指定带BOM的UTF-8编码：

var utf8WithBom = new UTF8Encoding(true);
var xmlOutputSettings = new XmlWriterSettings
{
    Indent = true,
    IndentChars = "\t",
    Encoding = utf8WithBom,                
};

using var outStream = new StreamWriter(inputFile.FullName, false, utf8WithBom);
using var xmlWriter = XmlWriter.Create(outStream, xmlOutputSettings);
xmlOutputDocument.WriteContentTo(xmlWriter);

方案3：匹配原文件的换行格式 #

如果原文件使用CRLF换行，而生成的文件是LF，Visual Studio对比工具可能误判编码。可以通过XmlWriterSettings强制保留原换行格式：

var xmlOutputSettings = new XmlWriterSettings
{
    Indent = true,
    IndentChars = "\t",
    Encoding = new UTF8Encoding(true),
    NewLineHandling = NewLineHandling.None // 不修改原文档的换行符
};

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