PowerShell：如何将命令行参数传递给模块中的函数？

场景重现 #

编写PowerShell模块处理帮助请求，用户输入-show help-topic这类参数时展示对应帮助内容。

主脚本导入模块及调用函数代码 #

# 导入模块
Import-Module Help-Module -ArgumentList $args

# 调用模块函数
Show-Help $args

模块中Show-Help函数代码 #

function Show-Help {
<#
.SYNOPSIS
Looks for command line arguments indicating user requested help, and if they are present, displays the
requested help.
.OUTPUTS
$true if one or more help requests were found and answered, else $false.
Throws an error if a help request was malformed.
#>
   Write-Debug "Inside Show-Help"
   if ([string]::IsNullOrWhiteSpace($args)) {                     # 无参数时
      return $false                                               # 直接返回
   }
   if ($args.Length -gt 0 -and $args[0] -eq "-help") {            # 通用帮助请求
      Show-ScriptOverview                                         # 展示脚本概览
      return $true                                                # 处理完成
   }                                                              # 其他情况
   foreach ($argument in $args) {                                 # 遍历每个参数
      Write-Host "Argument type is $($argument.getType())"
      $argarray = $argument.split(' ')                  
      if ($argarray.length -eq 2 -and $argarray[0] -eq "-show") { # 匹配-show请求
         switch ($topic = $($argarray[1])) {                      # 判断请求主题
            default {throw "Sorry, we don’t what '$topic' means"} # 不识别主题则抛出错误
         }
         return $true
      }
   }
}

错误现象 #

运行后输出Argument type is System.Object[]，随后调用$argument.split(' ')失败，报错：

Method invocation failed because [System.Object[]] does not contain a method named 'split'

问题原因 #

调用Show-Help $args时，$args本身是数组，直接传递会让函数内部的$args变成嵌套数组——即$args的元素是原命令行参数数组，而非单个字符串。因此foreach循环中$argument的类型是数组，自然没有Split方法。

解决方案 #

1. 调用函数时展开数组参数 #

使用**数组展开运算符@**将$args的元素逐个传递给函数，避免嵌套：

Show-Help @args

这样函数内部的$args会直接接收原命令行的单个字符串参数，foreach循环中每个$argument都是字符串类型，可正常调用Split方法。

2. 显式定义函数参数（更规范写法） #

避免依赖自动变量$args，显式定义参数提升代码可读性：

function Show-Help {
<#
.SYNOPSIS
Looks for command line arguments indicating user requested help, and if they are present, displays the
requested help.
.OUTPUTS
$true if one or more help requests were found and answered, else $false.
Throws an error if a help request was malformed.
#>
    [CmdletBinding()]
    param(
        [Parameter(ValueFromRemainingArguments=$true)]
        [string[]]$CommandLineArgs
    )

    Write-Debug "Inside Show-Help"
    if (-not $CommandLineArgs) {
        return $false
    }

    if ($CommandLineArgs[0] -eq "-help") {
        Show-ScriptOverview
        return $true
    }

    foreach ($argument in $CommandLineArgs) {
        Write-Host "Argument type is $($argument.GetType())"
        $argarray = $argument.Split(' ')
        if ($argarray.Length -eq 2 -and $argarray[0] -eq "-show") {
            switch ($topic = $argarray[1]) {
                default {throw "Sorry, we don't know what '$topic' means"}
            }
            return $true
        }
    }
}

调用时同样使用展开运算符：

Show-Help @args

3. 额外修正点 #

• 若模块初始化未用到-ArgumentList $args，可移除该参数传递；
• 原错误信息中的拼写错误don’t what需修正为don't know what。

内容的提问来源于stack exchange，提问作者aksarben