代码之家 › 专栏 › 技术社区 › Purclot

PowerShell函数参数验证

powershell

Purclot · 技术社区 · 5 年前

假设我有一个函数Add Values,当一个函数为参数提供一个字符串而不是一个整数时,如何避免一个丑陋的错误消息?

Function Add-Values
{
    param(
    [parameter(mandatory=$true)][int]$val1,
    [parameter(mandatory=$true)][int]$val2
    )

    $val1 + $val2
}

谢谢你的帮助

0 回复 | 直到 5 年前

mklement0 4 年前

Janne Tuukkanen's helpful answer

退一步:

在里面 Windows PowerShell 和版本,这可能会让最终用户感到困惑。

两个次优选项

使用 $host.UI.WriteErrorLine($errMsg) $errMsg 红色,无任何其他信息。
另一个选择是使用 Write-Warning $errMsg WARNING: .

但总的来说,这是最好的不绕过常见的错误报告功能 (为了保持一致性并支持进一步的编程处理),PowerShell[Core]7+可以帮助:

PowerShell[核心]7+ 现在默认为 格式化错误 ConciseView

带偏好变量 $ErrorView 设置为新的默认值, ,如果给定一个非整数,您的命令将失败,如下所示(打印在一行上,红色;为了可读性,请分散在多行中):

Add-Values: Cannot process argument transformation on parameter 'val1'. 
Cannot convert value "abc" to type "System.Int32". 
Error: "Input string was not in a correct format."

屏幕截图(自定义背景色):

但是,你可以 自定义验证 关于参数经由 [ValidateScript()] ErrorMessage 属性,因此您可以执行以下操作:

Function Add-Values
{
  param(
    [ValidateScript({ ($_ -as [int]) -is [int] }, ErrorMessage='Please pass an integer.')]
    [Parameter(Mandatory)]
    $val1
    ,
    [ValidateScript({ ($_ -as [int]) -is [int] }, ErrorMessage='Please pass an integer.')]
    [Parameter(Mandatory)]
    $val2
  )

  $val1 + $val2
}

这个 $_ $true )-或不-(有效) $false .
字面量 { ... } [ValidateScript()] ,因此这两个参数的值必须重复。
($_ -as [int]) -is [int] -as 运算符以查看给定的参数值( )已经是一个 [int] 或者可以转换为1,并返回 [内部] 若有,举例说明;及 $null 否则 -is [int] 操作是否确实返回了整数。

Add-Values abc 2 -然后,您将得到如下结果:

enter image description here

Janne Tuukkanen 5 年前

只需在参数声明中保留未定义的类型,并在函数代码中检查它们:

function Foo {
    param(
        [parameter(Mandatory)]$a,
        [parameter(Mandatory)]$b
    )

    if($a -is [int] -and $b -is [int]) {
        return $a + $b
    }

    Write-Output "Bad parameters"
}

推荐文章