PowerShell传递函数中接收到的所有参数，并处理带有空格的参数

Question

我是 PowerShell 的新手。 在Msys2（或Lnux）中，我定义了一个函数npp

npp ()
{
    ${NPP_PATH} "$@"
}

这样，如果我从命令提示符npp 调用它会启动 Notepad++（如${NPP_PATH} 中所定义）。 如果我打电话给npp "mydir/stage 1/a.txt"，它会打开该文件进行编辑。 一般来说，它允许：

1. 任意数量的参数。
2. 包含空格的参数（如果进行了适当的转义）。

PowerShell 中的等价物是什么？

我想在 PS 中我也应该使用一个函数来获得类似的行为。 到目前为止，我可以接收未定义数量的参数，并在foreach 循环中使用它们，请参见下面的代码。 但是我找不到与简单的"$@" 等效的方法来传递所有接收到的参数。 此外，如果我在其中一个参数中使用引号，它们会被删除，因此文件路径可能会出现问题，包括空格。

function multi_params {
    param(
        [Parameter(
            ValueFromRemainingArguments=$true
        )][string[]]
        $listArgs
    )
    $count = 0
    foreach($listArg in $listArgs) {
        '$listArgs[{0}]: {1}' -f $count, $listArg
        $count++
    }
}

Answer 1

假设NPP_PATH是一个环境变量，等效的PowerShell函数为：

function npp {
  & $env:NPP_PATH $args
}

^{如果 NPP_PATH 是常规 PowerShell 变量的名称，请使用 & $NPP_PATH $args。}

& 是call operator，出于句法 的原因，当您想要调用名称/路径在引号 和/或通过一个变量。

在simple functions（与advanced functions 相对）中（既不使用[CmdletBinding()] 也不使用[Parameter()] 属性），您可以使用automatic $args variable 将任何参数传递给另一个命令。

• 如果目标命令不是一个外部程序，例如这里，而是一个PowerShell命令，使用@args的形式来确保所有的参数——包括那些前面是它们的参数名称 - 正确传递 - 请参阅about_Splatting。
  请注意，@args 形式也适用于外部程序，它通常等同于 $args（唯一的区别是只有 @args 识别和删除 --%，停止解析符号）

• 请注意，传递带有 嵌入 " 字符的参数。从 PowerShell v7.0 开始，外部程序的空参数仍然被破坏 - 请参阅this answer。

---

在简单与高级函数（脚本）中传递参数：

• 仅在简单函数中，$args 包含调用时未绑定到声明的参数（如果有）的所有参数。

  • 如果您的简单函数不声明任何个参数，如上例所示，$args 包含调用时传递的所有个参数.

  • 如果您的简单函数确实声明了参数（通常通过param(...)），$args 仅包含那些未绑定到声明参数的参数；简而言之：它收集您的函数未为其声明参数的任何参数。

  • 因此，$args 是一种简单的机制，用于收集未事先声明或已知的参数，可以在函数本身中使用 - 特别是如果声明参数不值得努力 - 或者将这些参数传递给另一个命令。

  • 要将包含命名参数的参数（例如，-Path foo 而不仅仅是foo）传递给另一个 PowerShell 命令，需要 splatting，即格式@args.

    • 请注意，虽然$args 在技术上是一个常规的 PowerShell 数组 ([object[]])，但它还具有支持传递命名参数的内置魔法； 自定义数组可以不用于此，然后需要 hash-table 形式的 splatting - 请参阅about_Splatting

• 在高级函数中，$args不可用，因为根据定义，高级函数只接受参数具有被宣布。

  • 要接受额外的仅位置参数，您必须定义一个包罗万象的ValueFromRemainingArguments参数，如问题所示，它将此类参数收集在类似数组的^{[ 1]} 默认数据结构。

  • 要同时支持 named 传递参数，您有两个基本选项：

    • 如果您知道一组潜在的传递参数，将它们声明为您自己函数的一部分。

      • 然后您可以使用 splatting 与 $PSBoundParameters 字典（哈希表） - 见下文 - 传递命名参数，可能是在从字典中删除用于您的函数本身的参数之后。

    • 在为现有命令编写代理（包装器）函数时使用此技术； PowerShell SDK 允许您基于现有命令脚手架代理函数，从而更轻松地复制传递参数 - 请参阅 this answer。

  • 否则，只有一个次优的解决方案，您可以模拟 PowerShell 自己的参数解析来将位置参数解析为参数名称/值对 - 请参阅 this answer。

---

automatic $PSBoundParameters variable 是一个字典， 提供简单和高级功能：

• $PSBoundParameters 仅在您的函数声明参数时适用，并且仅包含声明参数中在调用时实际绑定（传递）参数的条目；字典键是参数名称，尽管没有初始 -。
  请注意，默认值绑定的参数不包括在内 - 请参阅 this GitHub issue 进行讨论。
  同样，请注意，在 高级 函数中，如果为它声明了参数，则只能传递给定参数，因此在给定调用中传递的任何参数根据定义反映在 $PSBoundParameters 中。

• 因为它是一个字典（哈希表），它可以与基于哈希表的 splatting - @PSBoundParameters 一起使用 - 将命名参数传递给其他 PowerShell 命令，并且因为它是可变的 ，您可以选择添加或删除命名参数（例如用于您的函数本身的参数）。

---

^{[1] 那个类型是[System.Collections.Generic.List[object]]；但是，您可以显式指定集合类型，例如 [object[]] 以获取常规 PowerShell 数组。}