PowerShell 中的函数重载

Question

可以在 PowerShell 中重载函数吗？

我希望我的函数接受字符串、数组或某些开关。

我想要的一个例子：

• Backup-UsersData singleUser
• Backup-UsersData @('Alice', 'Bob', 'Joe')
• 备份用户数据 -all

Answer 1

在 PowerShell 中函数不会重载。最后一个定义会覆盖同一作用域中的前一个定义，或隐藏父作用域中的前一个定义。因此，您应该创建一个函数并提供一种通过参数区分其调用模式的方法。

在 V2 中，您可以使用高级函数，请参阅 help about_Functions_Advanced_Parameters 并避免在解决参数集歧义时进行一些手动编码：

# advanced function with 3 parameter sets
function Backup-UsersData
(
    [Parameter(Position=0, ParameterSetName="user")]
    [string]$user,
    [Parameter(Position=0, ParameterSetName="array")]
    [object[]]$array,
    [Parameter(Position=0, ParameterSetName="all")]
    [switch]$all
)
{
    # use this to get the parameter set name
    $PSCmdlet.ParameterSetName
}

# test
Backup-UsersData -user 'John'
Backup-UsersData 1, 2
Backup-UsersData -all

# OUTPUT:
# user
# array
# all

请注意，这种机制有时很奇怪。例如，在第一个测试中，我们必须显式指定参数名称 -user 。否则：

Backup-UsersData : Parameter set cannot be resolved using the specified named parameters.
At C:\TEMP\_101015_110059\try2.ps1:21 char:17
+ Backup-UsersData <<<<  'John'
    + CategoryInfo          : InvalidArgument: (:) [Backup-UsersData], ParentContainsErrorRecordException
    + FullyQualifiedErrorId : AmbiguousParameterSet,Backup-UsersData

在许多情况下，具有混合参数的标准函数（而不是高级函数）就可以：

function Backup-UsersData
(
    [string]$user,
    [object[]]$array,
    [switch]$all
)
{
    if ($user) {'user'}
    elseif ($array) {'array'}
    elseif ($all) {'all'}
    else {'may be'}
}

Backup-UsersData -user 'John'
Backup-UsersData -array 1, 2
Backup-UsersData -all
Backup-UsersData

但在这种情况下，您应该解决（或接受并忽略）歧义，例如，决定在以下情况下做什么：

Backup-UsersData -user 'John' -array 1, 2 -all

Answer 2

这是罗马答案的一个变体，我认为它更灵活一些：

function Backup
{
    [CmdletBinding(DefaultParameterSetName='Users')]
    Param (
        [parameter(mandatory=$true, ParameterSetName='Users', position=0, ValueFromPipeline=$true)][string[]]$User,
        [parameter(mandatory=$true, ParameterSetName='AllUsers')][switch]$All
    )

    Begin
    {
        if ($All) { $User = @('User1', 'User2', 'User3') }
    }

    Process
    {
        foreach ($u in $User)
        {
            echo "Backup $u"
        }
    }
}

Answer 3

1) 构建一个类...

class c1 { 
    [int]f1( [string]$x ){ return 1 } 
    [int]f1( [int ]$x ){ return 2 }
    }

1+) 如果您喜欢在不实例化的情况下调用它们，请使用静态方法...

class c1 { 
    static [int] f1( [string]$x ){ return 1 } 
    static [int] f1( [int]$x ){ return 2 } 
    }

2) 调用类或对象中的方法...重载工作正常

$o1 = [c1]::new()
o1.f1( "abc" ) ~> returns 1
o1.f1( 123 )   ~> returns 2

---

-OR-< /em>

---

[c1]::f1( "abc" ) ~> returns 1
[c1]::f1( 123 )   ~> returns 2

3)
如果（像我一样）
您希望将“重载函数”放入库中...
这样您的用户就可以透明地使用它们...
从代码或交互式命令行（REPL）...

我能想到的最接近
“Powershell 中的重载函数”
是这样的：

function Alert-String() { [c1]::f1( "abc" ) }
function Alert-Strings(){ [c1]::f1( 123 ) }
function Alert-Stringn(){ [c1]::f1( 123 ) }

也许在 PS-Core v8 中？？？ ;-)

希望有帮助...

Answer 4

如果您使用 PSObject 而不是 Object 来定义参数类型，它应该可以工作。
例如，函数 Get-Control 知道如何基于字符串或模板类型进行重载，并且可以使用位置值进行调用：

    Get-Control "A-Name-Of-A-Control"
    Get-Control $template

要使重载起作用，请使用 PSObject，如下所示：

Function Get-Control {
    Param(
        [Parameter(Mandatory=$False,ParameterSetName="ByTemplate",Position=0)]
        [PSObject]
        $Template,

        [Parameter(Mandatory=$False,ParameterSetName="ByName",Position=0)]        
        [String]
        $Name,

        [Parameter(Mandatory=$False)] 
        [Switch]
        $List
      ) 
   ... # remaining code removed for brevity

Answer 5

已经发布了一些很好的答案，但我想我会分享另一种方法；虽然从技术上讲，此方法不是函数重载，但它确实提供了类似的功能，这可能就足够了，具体取决于您的要求。

这个想法是使用一个只有 1 个 [HashTable] 类型参数的函数。您需要传递给函数的所有参数都将通过这个单个哈希表参数传递。下面的代码应该很容易看出它是如何工作的。

Function OverLoadedFunction
{
 Param
 (
  [HashTable] $Parameters
 )

 # Default parameter values if desired.
 [String] $Server = 'Default Server'
 [Int]    $Port   = 22

 ForEach ($Parameter In $Parameters.Keys)
 {
  Switch ($Parameter)
  {
   'Server' {$Server = $Parameters.$Parameter.Trim(); Break} 
   'Port'   {$Port   = $Parameters.$Parameter       ; Break}
   Default  {Write-Host 'Not a valid parameter'}
  }
 }
  Write-Host $Server on port $Port
}

Cls

OverLoadedFunction
OverLoadedFunction @{server='new server'}