使用 Powershell 解析具有变量类型的 XML 文件

Question

我正在尝试从脚本中删除变量的定义，并从类似于下面的 XML 配置文件中读取它们：

XML 文件

<?xml version="1.0" encoding="utf-8" ?>
<settings>
    <process>FALSE</process>
    <xmlDir>\\serv1\dev</xmlDir>
    <scanDir>\\serv1\dev</scanDir>
    <processedDir>\\serv1\dev\done</processedDir>
    <errorDir>\\serv1\dev\err</errorDir>
    <log>\\serv1\dev\log\dev-Log##DATE##.log</log>
    <retryDelay>5</retryDelay>
    <retryLimit>3</retryLimit>
</settings>

然后用下面的代码解析脚本中的 XML：

[xml]$configFile = Get-Content $PSScriptRoot\$confFile
$settings = $configFile.settings.ChildNodes
foreach ($setting in $settings) {  
    New-Variable -Name $setting.LocalName -Value ($setting.InnerText -replace '##DATE##',(get-date -f yyyy-MM-dd)) -Force
}

这很好用，但问题是它们都被读取为字符串，但我需要一些整数。为了解决这个问题，我必须在创建变量后将它们更改为整数，如下所示：

$retryDelay = ([int]$retryDelay)
$retryLimit = ([int]$retryLimit)

虽然这可行，但我希望在 XML 中包含其他变量，例如 boolean $true / $false（并作为布尔值读入），并且希望 foreach 能够处理它们的类型而不是附加行在脚本中。任何线索表示赞赏。

Answer 1

首先，永远不要像这样读取 XML 文件。这会破坏内置于 XML 解析器中的编码检测，迟早会导致您的数据遭到破坏。

# BAD, DO NOT USE
[xml]$configFile = Get-Content $PSScriptRoot\$confFile

正确地读取 XML 文件是这样工作的 - 创建一个新的 XML 对象并让它处理文件加载：

$configFile = New-Object xml
$configFile.Load("$PSScriptRoot\$confFile")

其次，我强烈建议不要从文件中创建全局变量。这是一种不好的风格，因为它很容易通过盲目地覆盖现有变量来破坏您的程序。使用哈希来存储文件中的值，或者直接使用 XML 文件作为您的配置。

$config = @{}

foreach ($setting in $configFile.SelectNodes("/settings/*") ) {
    $config[$setting.Name] = $setting.InnerText
}

第三，XML 没有固有的数据类型信息。在您添加有关它的更多信息之前，一切都是字符串。一种方法可能是type 属性（type="string" 可以视为默认值）：

<settings>
    <process type="boolean">FALSE</process>
    <xmlDir type="string">\\serv1\dev</xmlDir>
    <scanDir type="string">\\serv1\dev</scanDir>
    <processedDir type="string">\\serv1\dev\done</processedDir>
    <errorDir type="string">\\serv1\dev\err</errorDir>
    <log type="string">\\serv1\dev\log\dev-Log##DATE##.log</log>
    <retryDelay type="int">5</retryDelay>
    <retryLimit type="int">3</retryLimit>
</settings>

当然，type 属性本身没有任何意义。您需要编写关注这些属性并进行必要类型转换的代码（if ($setting.type -eq "boolean") { ... } 等）。

第四，我相信只要使用 JSON 作为配置文件格式，你会很多变得更好。它更易于编辑，并且具有固有的数据类型信息。

{
    "settings": {
        "process": false,
        "xmlDir": "\\\\serv1\\dev",
        "scanDir": "\\\\serv1\\dev",
        "processedDir": "\\\\serv1\\dev\\done",
        "errorDir": "\\\\serv1\\dev\\err",
        "log": "\\\\serv1\dev\\log\\dev-Log##DATE##.log",
        "retryDelay": 5,
        "retryLimit": 3
    }
}

使用ConvertFrom-JSON cmdlet 解析数据。使用Get-Content -Encoding UTF8 阅读。

在处理文本文件时使用Encoding 参数很重要，在使用Set-Content 或Out-File 编写文件时也是如此。这里没有隐藏的魔法可以做正确的事情，你必须明确编码。

这里有一些关于Out-File 和Set-Content 行为的更深入的信息。 Powershell set-content and out-file what is the difference?

Answer 2

我同意 Tomalak 的回答，JSON 可能更适合您的用例。这是一个实际示例，向您展示如何使用它。这是使用从哈希表创建的自定义对象来生成 JSON 并将其保存到文件中：

$Config = [pscustomobject]@{
    Process = $false
    xmldir = '\\serv1\dev'
    scanDir = '\\serv1\dev'
    processedDir = '\\serv1\dev\done'
    errorDir = '\\serv1\dev\err'
    log = '\\serv1\dev\log\dev-Log##DATE##.log'
    retryDelay = 5
    retryLimit = 3
}

$Config | ConvertTo-Json | Out-File .\config.txt -Encoding UTF8

这会创建如下所示的 JSON：

{
    "Process":  false,
    "xmldir":  "\\\\serv1\\dev",
    "scanDir":  "\\\\serv1\\dev",
    "processedDir":  "\\\\serv1\\dev\\done",
    "errorDir":  "\\\\serv1\\dev\\err",
    "log":  "\\\\serv1\\dev\\log\\dev-Log##DATE##.log",
    "retryDelay":  5,
    "retryLimit":  3
}

可以这样读：

$Settings = Get-Content .\config.txt -Encoding UTF8 | ConvertFrom-Json

由于您可以看到 JSON 存储变量的方式，PowerShell 在读回变量时可以更好地正确键入它们。