如何将配置文件引入 Powershell 脚本？

Question

假设我有一个名为 Foo.ps1 的 Powershell 脚本

我想介绍一个名为 Foo.ps1.config 的 XML 配置文件

我可以在其中指定我的环境设置，例如：

<FunctionsDirectory>
     $ScriptDirectory\Functions
</FunctionsDirectory>
<ModulesDirectory>
     $ScriptDirectory\Modules
</ModulesDirectory>

然后我想在 Foo.ps1 的开头加载这个配置，以便我可以将我的模块和点符号导入到 Functions 目录中。

如何在 Powershell 中实现这一目标？

Answer 1

可能是一个更简单的解决方案......假设你的配置文件名为“Confix.xml”，试试这个：

PS Testing> [xml]$configFile= get-content .\Config=.xml
PS Testing> $configFile
xml                                  configuration
---                                  -------------
version="1.0"                        configuration

从新变量中读取数据：

PS Testing> $configFile.configuration.appsettings
#comment                             add
--------                             ---
Vars                                 {add, add}

PS Testing> $configFile.configuration.appsettings.add
key                                  value
---                                  -----
var1                                 variableValue1
var2                                 variableValue2

PS Testing> $configFile.configuration.appsettings.add[0].value
variableValue2

长话短说：将您的变量转换为 XML，然后执行获取内容。

在这种情况下，Config.xml 如下所示：

<?xml version="1.0"?>
<configuration>
  <startup>
  </startup>
  <appSettings>
    <!--Vars -->
    <add key="var1" value="variableValue1"/>
    <add key="var2" value="variableValue2"/>
  </appSettings>
</configuration>

Answer 2

对于 XML 配置的替代方案，如果您可以灵活地使用其他类型的配置。 我建议使用全局 PS 配置文件，方法如下：

创建一个 Powershell 配置文件（例如 Config.ps1 ），然后将所有配置作为全局变量并将其初始化为第一步，以便配置值应该在您的脚本上下文中可用。

这种方法的好处是可以在 Config.ps1 PS 文件中使用各种类型的数据结构，例如标量变量、集合和哈希，并在 PS 代码中轻松引用。

下面是一个正在运行的例子：

这是 C:\\Config\\Config.ps1 文件：

$global:config = @{   
    Var1 = "Value1"

    varCollection = @{       
        item0     = "colValue0"
        item1   = "colValue1"
        item2  = "colValue2"
    }       
}

然后从 C:\\Module\\PSModule.psm1 模块中的 Config.ps1 文件中加载函数/变量，如下所示：

$scriptFiles = Get-ChildItem "$PSScriptRoot\Config\*.ps1" -Recurse

foreach ($script in $scriptFiles)
{
    try
    {       
        . $script.FullName 
    }
    catch [System.Exception]
    {
        throw
    }
}

最后，初始化脚本包含下面这一行：( C:\\Init.ps1 )。

Import-Module $PSScriptRoot\\Module\\PSModule.psm1 -Force

运行Init.ps1后。 global:config 变量将在您的脚本上下文中可用。 这是输出：

Answer 3

基于Keith 的解决方案......加载 XML 的代码：

   $configFile = "c:\Path2Config"
    if(Test-Path $configFile) {
        Try {
            #Load config appsettings
            $global:appSettings = @{}
            $config = [xml](get-content $configFile)
            foreach ($addNode in $config.configuration.appsettings.add) {
                if ($addNode.Value.Contains(‘,’)) {
                    # Array case
                    $value = $addNode.Value.Split(‘,’)
                        for ($i = 0; $i -lt $value.length; $i++) { 
                            $value[$i] = $value[$i].Trim() 
                        }
                }
                else {
                    # Scalar case
                    $value = $addNode.Value
                }
            $global:appSettings[$addNode.Key] = $value
            }
        }
        Catch [system.exception]{
        }
    }

从 XML 值填充变量：

            $variable1 = $appSettings["var1"]
            $variable2 = $appSettings["var2"]

以及相关的 XML：

<?xml version="1.0"?>
<configuration>
  <startup>
  </startup>
  <appSettings>
<!--Vars -->
    <add key="var1" value="variableValue1"/>
    <add key="var2" value="variableValue2"/>
  </appSettings>
</configuration>

Answer 4

另一个解决方案（类似于@yantaq 的）只是有一个单独的脚本并加载它。

所以config.ps1包含：

$Environment = $Environment.ToUpper()
$GDriveUNC = "\\servername.domain.net\Data"
$BinLocation = "$pwd\bin-$Environment"

请注意，在这种情况下， $Environment是主脚本的参数，您可以进行任何您想要的操作。

然后在主脚本中，运行这个 'config' 脚本，像这样：

. $PSScriptRoot\config.ps1