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

Question

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

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

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

任意数量的参数。

包含空格的参数，如果适当转义。

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包含调用时未绑定(bind)到声明参数的所有参数(如果有)。

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

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

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

要将包含命名参数(例如， -Path foo 而不仅仅是 foo )的参数传递给另一个 PowerShell 命令，需要使用 splatting，即形式 @args .

请注意，虽然 $args从技术上讲，它是一个常规的 PowerShell 数组( [object[]] )，它还具有支持传递命名参数的内置魔法；自定义数组不能用于此目的，然后需要散列表形式的散列 - 参见 about_Splatting

在高级功能中 , $args不可用，因为高级函数根据定义只接受已声明参数的参数。

要接受额外的、仅限位置的参数，您必须定义一个包罗万象的 ValueFromRemainingArguments参数，如问题所示，默认情况下，它在类数组 [1] 数据结构中收集此类参数。

要还支持命名传递参数，您有两个基本选项:

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

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

在为现有命令编写代理(包装器)函数时使用此技术； PowerShell SDK 允许您基于现有命令构建代理功能，从而更容易复制传递参数 - 参见 this answer .

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

automatic $PSBoundParameters variable 是一本有简单和高级功能的字典:

$PSBoundParameters仅当您的函数声明参数时才适用，并且 仅包含在调用时实际绑定(bind)(传递)参数的声明参数中的条目 ;字典键是参数名称，尽管没有初始 - .
请注意，不包括由默认值绑定(bind)的参数 - 参见 this GitHub issue进行讨论。
再次注意，在高级函数中，如果为给定参数声明了参数，则只能传递给定参数，因此在给定调用中传递的任何参数根据定义反射(reflect)在 $PSBoundParameters 中。 .

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

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