Powershell XML文档保存为UTF-8没有BOM

Question

我构建了一个System类型的XML对象。Xml。XmlDocument。

$scheme.gettype()
IsPublic IsSerial Name BaseType                                                         
-------- -------- ---- --------                                                         
True     False    XmlDocument System.Xml.XmlNode 

我使用保存（）方法将其保存到文件中。

$scheme.save()

这会将文件以UTF-8格式与BOM一起保存。BOM表会导致后续的其他脚本出现问题。

当我们在记事本中打开XML文件并将其保存为UTF-8（没有BOM）时，其他脚本不会有问题。所以我被要求保存没有BOM的脚本。

保存方法的MS文档说明：

encoding属性的值取自XmlDeclaration。编码属性。如果XmlDocument没有XmlDeclaration，或者XmlDeclaration没有编码属性，则保存的文档也不会有编码属性。

XmlDeclaration上的MS文档列出了UTF-8、UTF-16等的编码属性。它没有提到BOM表。

XmlDeclaration是否具有省略BOM的编码属性？

另外，此行为在Powershell 5和Powershell 7中是相同的。

Answer 1

正如BACON在注释中解释的那样，XML声明中Encoding属性的字符串值与包含文档的文件的编码方式没有任何关系。

您可以通过创建带有非BOM的UTF8Encoding的StreamWriter或XmlWriter来控制这一点，然后将其传递到Save（$writer）：

$filename = Resolve-Path path\to\output.xml

# Create UTF8Encoding instance, sans BOM
$encoding = [System.Text.UTF8Encoding]::new($false)

# Create StreamWriter instance
$writer = [System.IO.StreamWriter]::new($filename, $false, $encoding)

# Save using (either) writer
$scheme.Save($writer)

# Dispose of writer
$writer.Dispose()

或者使用[XmlWriter]：

# XmlWriter Example
$writer = [System.Xml.XmlWriter]::Create($filename, @{ Encoding = $encoding })

第二个参数是[XmlWriterSettings]对象，通过它，除了显式设置编码外，我们还可以对格式选项进行更大的控制：

$settings = [System.Xml.XmlWriterSettings]@{
  Encoding = $encoding
  Indent = $true
  NewLineOnAttributes = $true
}
$writer = [System.Xml.XmlWriter]::Create($filename, $settings)

#  <?xml version="1.0" encoding="utf-8"?>
#  <Config>
#    <Group
#      name="PropertyGroup">
#      <Property
#        id="1"
#        value="Foo" />
#      <Property
#        id="2"
#        value="Bar"
#        exclude="false" />
#    </Group>
#  </Config>

Answer 2

不幸的是，在XML文档的声明中显式存在编码="utf-8"属性会导致。NET到。如果给定目标文件路径，则将文档保存（）到具有BOM的UTF-8编码文件中，这确实会导致问题。

更改此项的请求被拒绝，因为担心破坏向后兼容性；这里有一个至少记录行为的请求。

有点讽刺的是，缺少编码属性会导致。保存（）以创建没有BOM的UTF-8编码文件。

因此，一个简单的解决方案是删除编码属性^[1]；例如。：

# Create a sample XML document:
$xmlDoc = [xml] '<?xml version="1.0" encoding="utf-8"?><foo>bar</foo>'

# Remove the 'encoding' attribute from the declaration.
# Without this, the .Save() method below would create a UTF-8 file *with* BOM.
$xmlDoc.ChildNodes[0].Encoding = $null

# Now, saving produces a UTf-8 file *without* a BOM.
$xmlDoc.Save("$PWD/out.xml")

^{[1]这样做是安全的，因为XML W3C建议在没有BOM和编码属性的情况下有效地强制将UTF-8作为默认值}