构建动态参数和Powershell参数验证

PowerShell 中高级函数最酷但最复杂的功能之一是动态参数，并使用该功能执行 PowerShell 参数验证。动态参数将您的典型功能参数提升到一个全新的水平。

您是否曾经有过这样的经历：创建一个高级函数并希望您的参数依赖于其他东西？根据您在运行时选择的标准动态创建？

想要进行 Powershell 参数验证（例如构建一个 PowerShell ValidateSet 数组）来对不基于静态字符串集而是在运行时生成的参数提供制表符补全功能怎么样？这些都可以通过动态参数来实现。

这篇文章是有关 Windows PowerShell 高级功能的 PowerShell 博客周 (#PSBlogWeek) 系列的一部分，这是一系列协调一致的文章，旨在提供特定主题的全面视图。

在这个系列中，我们还有：

• 标准和高级 PowerShell 函数，作者：Francois-Xavier Cat (@LazyWinAdm)（2015 年 3 月 30 日）
• PowerShell 高级功能：我们可以更好地构建它们吗？通过参数验证，我们可以！byMike F. Robbins (@mikefrobbins)（2015 年 3 月 31 日）
• 在高级功能中支持 WhatIf 和 Confirm，作者：Jeffery Hicks (@JeffHicks)（2015 年 4 月 2 日）
• 高级功能的高级帮助，作者：June Blender (@juneb_get_help)（2015 年 4 月 3 日）
• 看看 PowerShell 中的 Try/Catch，作者：Boe Prox (@proxb)（2015 年 4 月 4 日）

要建议 PowerShell 博客周主题，请发表评论或使用 #PSBlogWeek 标签向我们发送推文。

我见过有几种不同的方法来使用动态参数。第一种是 Ben Ten 在 PowerShell 杂志上描述它们的方式。使用这种方法，Ben 能够根据是否使用不同的参数来动态创建参数。就我个人而言，我从来没有必要这样做。

我真的很喜欢使用动态参数作为一种基于运行时可用的标准来验证输入的方法。这样我就可以编写一个实时收集信息的脚本，这使我能够实现我们都知道和喜爱的漂亮参数制表符补全。

让我们看一个示例，了解如何基于文件夹中的文件创建 Powershell 参数验证。

“普通”高级功能参数允许您使用一些验证选项。您可以验证参数可以接受的参数数量、参数参数的最小和最大长度、数组中的一组选项、匹配正则表达式字符串或脚本块等等。我在这里寻找的是使用 ValidateSet 属性来完成制表符。

您会注意到，在上面的示例中，我使用了 Get-Item cmdlet 和制表符补全的默认参数，这是预期的。我想要这个功能，但我想用制表符补全我自己的参数，所以让我们创建一个简单的函数来做到这一点。

您会注意到，我突出显示了验证属性，该属性允许我们使用 Tab 键完成 MyParameter 参数。现在，我们可以使用 PowerShell ValidateSet 数组属性中指定的值来获取自定义参数参数制表符补全。

但是现在，如果我希望根据其他标准而不是静态列表即时生成制表符补全选项，该怎么办？唯一的选择是使用动态参数。在我的示例中，我想在运行时用制表符补全特定文件夹中的文件列表。

为了完成此任务，我将使用一个动态参数，每当我尝试使用 Tab 键补全 MyParameter 参数时，该参数都会运行 Get-ChildItem。

话虽如此，让我们将 MyParameter 参数的 ValidateSet 属性设为动态，好吗？

您会注意到标准参数和动态参数之间的第一个区别是动态参数位于它们自己的块中。

[CmdletBinding()]
param()
DynamicParam {

}

以困难的方式创建动态 Powershell 参数验证

在 DynamicParam 块内是神奇发生的地方。而且这种魔力确实需要一段时间才能让你明白。

从某种意义上说，动态参数是一个 System.Management.Automation.RuntimeDefinedParameterDictionary 对象，其中包含一个或多个 System.Management.Automation.RuntimeDefinedParameter 对象。但这并不那么容易。让我们来分解一下。

1. 首先，实例化一个新的 System.Management.Automation.RuntimeDefinedParameterDictionary 对象，用作我们将添加到其中的一个或多个参数的容器

$RuntimeParamDic = New-Object System.Management.Automation.RuntimeDefinedParameterDictionary.

2. 接下来，创建准备包含 System.Attribute 对象的 System.Collections.ObjectModel.Collection。

$AttribColl = New-Object System.Collections.ObjectModel.Collection[System.Attribute].

3. 现在实例化一个 System.Management.Automation.ParameterAttribute 对象，该对象将保存我们习惯的所有参数属性。在我们的实例中，我将参数定义在所有参数集中，并通过管道对象和属性名称接受管道输入。

$ParamAttrib = New-Object System.Management.Automation.ParameterAttribute
$ParamAttrib.Mandatory = $Mandatory.IsPresent
$ParamAttrib.ParameterSetName = '__AllParameterSets'
$ParamAttrib.ValueFromPipeline = $ValueFromPipeline.IsPresent
$ParamAttrib.ValueFromPipelineByPropertyName = $ValueFromPipelineByPropertyName.IsPresent

4. 将我们的参数属性集添加到我们上面实例化的集合中。

$AttribColl.Add($ParamAttrib)

5. 由于我使用此动态参数构建 PowerShell ValidateSet 数组以进行参数验证，因此我还必须在属性集合中包含一个 System.Management.Automation.ValidateSetAttribute 对象。您可以在此处定义代码以实际创建值，从而允许我们使用制表符完成参数参数。

$AttribColl.Add((New-Object System.Management.Automation.ValidateSetAttribute((Get-ChildItem C:\TheAwesome -File | Select-Object -ExpandProperty Name))))

6. 然后，我们必须使用参数名称、类型和我们添加内容的属性集合来实例化一个 System.Management.Automation.RuntimeDefinedParameter 对象。

$RuntimeParam = New-Object System.Management.Automation.RuntimeDefinedParameter('MyParameter', [string], $AttribColl)

7. 运行时参数完成后，我们将返回到之前使用参数名称和我们创建的运行时参数对象实例化的原始字典对象。

$RuntimeParamDic.Add('MyParameter', $RuntimeParam)

8. 然后我们可以将此运行时字典对象返回到动态参数块，我们就完成了！

return $RuntimeDic

你的眼睛还呆滞吗？当我第一次尝试解决这个问题时，就是我的情况。

作为一个懒惰的管理员，我创建了一个名为 New-ValidationDynamicParam 的函数，它为您创建 PowerShell ValidateSet 数组完成所有这些工作。只需传入参数名称、您希望参数具有的属性以及将用于创建验证的代码即可完成！该函数完成剩下的工作。

轻松创建动态 ValidateSet 数组参数

New-ValidationDynamicParam -Name 'MyParameter' -Mandatory -ValidateSetOptions (Get-ChildItem C:\TheAwesome -File | Select-Object -ExpandProperty Name)

我的痛苦就是你们的收获，朋友们！

现在，创建了动态验证参数后，让我们对其进行测试。

我的计算机上的目录中有一些文件，我只想将其传递给 MyParameter 参数。

现在我所要做的就是运行我们的脚本，瞧！我现在只能使用文件名作为参数参数，并且它们会随着文件进出文件夹而更新！