powershell - 从 PowerShell 函数调用回调

Question

我正在尝试向 PowerShell 函数添加一些回调功能，但我希望能够在函数定义之外定义回调的行为，因此基本上是一个非常简单的 PowerShell 控制反转。

我正在尝试尽可能向后兼容，这就是我到目前为止所想出的(为简洁起见，删除了错误处理):

$ErrorActionPreference = "Stop";
Set-StrictMode -Version "Latest";

function Invoke-DoSomethingMethod
{
    param
    (
        [hashtable] $Callbacks
    )
    $CallBacks["OnStarted"].Invoke();
    for( $i = 1; $i -le 10; $i++ )
    {
        # ... do something here ...
        $CallBacks["OnProgress"].Invoke($i * 10);
    }
    $CallBacks["OnFinished"].Invoke();
}

$myHostCallbacks = @{
    "OnStarted"  = { write-host "started" }
    "OnProgress" = { write-host "processing $($args[0])%" }
    "OnFinished" = { write-host "finished" }
}

$myFileCallbacks = @{
    "OnStarted"  = { Add-Content "C:\temp\log.txt" "started" }
    "OnProgress" = { Add-Content "C:\temp\log.txt" "processing $($args[0])%" }
    "OnFinished" = { Add-Content "C:\temp\log.txt" "finished" }
}

$myWebCallbacks = @{
    "OnStarted"  = { Invoke-WebRequest -Uri "http://example.org/OnStarted" }
    "OnProgress" = { Invoke-WebRequest -Uri "http://example.org/OnProgress/$($args[0])" }
    "OnFinished" = { Invoke-WebRequest -Uri "http://example.org/OnFinish" }
}

Invoke-DoSomethingMethod -Callbacks $myHostCallbacks;

运行时，输出以下内容:

c:\temp>powershell .\callbacks.ps1

started
processing 10%
processing 20%
processing 30%
processing 40%
processing 50%
processing 60%
processing 70%
processing 80%
processing 90%
processing 100%
finished

在不使用外部模块或 C# 代码的情况下，是否有一种更理想的方式使用 PowerShell 来执行此操作，而不依赖于匹配回调名称的魔术字符串和 $args[] 参数的顺序？ (最好兼容2.0版本)。

干杯，

迈克

更新

对于某些上下文，我的 Invoke-DoSomething 函数是 CI 构建框架的一部分( https://github.com/ASOS/OctopusStepTemplateCi ) 当前已硬编码为在构建过程中使用 Write-Host 发送 TeamCity 服务消息。

我们有兴趣支持其他构建服务器产品，因此我正在研究一种方法，将与构建服务器的各种交互抽象为用户可定义的回调，例如“OnBuildStarted”、“OnBuildStepFailed”等，就像您可能做的那样使用 C# 中的 IoC 框架。

这将使在项目内提供对新构建服务器的支持变得更加容易，并且用户也可以更轻松地为非开箱即用的构建服务器编写回调。

这可能有助于让我了解我正在尝试做的事情:

function Invoke-BuildScript
{
    param( [hashtable] $Callbacks )
    $CallBacks["OnBuildStarted"].Invoke();
    ... build script here ...
    $CallBacks["OnBuildFinished"].Invoke();
}

$teamCityCallbacks = @{
    "OnBuildStarted"  = { write-host "started" }
    "OnBuildFinished" = { write-host "finished" }
    "OnBuildError"    = { write-host "error '$($args[0])'" }
}

$jenkinsCallbacks = @{
    "OnBuildStarted"  = { ... }
    "OnBuildFinished" = { ... }
    "OnBuildError"    = { ... }
}

Invoke-BuildScript -Callbacks $teamCityCallbacks;

Answer 1

我不太清楚你想做什么，但是 OnStarted、OnProgress、OnFinished 似乎与PowerShell 管道概念:Begin、Process、End。

如果您有一个多部分管道，它们可能都会实现其中的 1 个或多个 block 。

在单个管道中，每个元素的 Begin block 首先执行，然后每个元素的 Process block 每个元素执行一次管道中的项目(如果前一个元素没有向管道发送任何输出，则可以跳过后面的元素)，最后每个元素的 End block 得到已执行。

无需编写自己的函数即可查看此内容的最简单方法是使用 ForEach-Object，虽然它最常仅与 Process block 一起使用，但也可以运行 Begin 和 End block 。

演示(使用单个用户定义函数):

function Invoke-MyPipeline {
[CmdletBinding()]
param(
    [Parameter(ValueFromPipeline=$true)]
    $Value
)

    Begin {
        Write-Verbose -Message 'Begin Invoke-MyPipeline' -Verbose
    }

    Process {
        $Value * 2
    }

    End {
        Write-Verbose -Message 'End Invoke-MyPipeline' -Verbose
    }
}

1..10 | 
    Invoke-MyPipeline | 
    ForEach-Object -Begin { 
        Write-Verbose -Message 'ForEach (1) Begin' -Verbose
    } -Process {
        "~$_~"
    } -End {
        Write-Verbose -Message 'ForEach (1) End' -Verbose
    } |
    ForEach-Object -Begin { 
        Write-Verbose -Message 'ForEach (2) Begin' -Verbose
    } -Process {
        "@$_@"
        Start-Sleep -Milliseconds 500  # watch this effect on the whole pipeline
    } -End {
        Write-Verbose -Message 'ForEach (2) End' -Verbose
    }

Try it online! (但将其粘贴到 ISE 中以查看时序延迟的影响)

这和你有什么关系？

您可以将它们视为数组，而不是命名脚本 block 。然后您可以以与 ForEach-Object 相同的方式解释它们(如果有 1 个脚本 block ，则为 Process，如果有 2 个，则第一个为 Begin code>，第二个是Process，如果有3个，就是Begin、Process、End)。

ForEach-Object 还接受其他脚本 block 。我认为它对它们的管理有点奇怪。如果有 1 个额外的 block ，它(第 4 个)将被视为第二个 End block 。如果有 2 个以上的额外内容，则 N-1 个额外内容将被视为额外的 Process 和 End block ，并且last 额外部分仅被视为额外的 End block 。:

1,2,3|%{write-verbose 'A' -Verbose}{$_}{write-verbose 'B' -Verbose}{Write-Verbose 'Extra1' -Verbose}{Write-Verbose 'Extra2' -Verbose}{Write-Verbose 'Extra3' -Verbose}{Write-Verbose 'Extra4' -Verbose}

“好吧，但是，这有什么用呢？”

因为您无需重新实现这些规则(或您自己的规则)，只需让 ForEach-Object 为您完成即可:

function Invoke-DoSomethingMethod {
[CmdletBinding()]
param (
    [Parameter(Mandatory = $true)]
    [ValidateNotNullOrEmpty()]
    [hashtable[]]
    $ScriptBlock # renaming to follow PowerShell conventions
)
    1..10 | 
        ForEach-Object -Process { $_*10 } | # this replaces your foreach
        ForEach-Object @ScriptBlock  # Callbacks invoked here
}

$myHostCallbacks = @(
     { write-host "started" }
    ,{ write-host "processing $_%" } # bonus $_ usage
    ,{ write-host "finished" }
)

Invoke-DoSomethingMethod -ScriptBlock $myHostCallbacks

奖金

您可以使用 $_，这是 PowerShell 中常见且易于理解的模式，无需执行任何额外操作。

注意

您仍然可以接受它作为哈希表，并且如果哈希表键与 ForEach-Object 的参数匹配，则相同的代码将起作用，这在这方面可能不太灵活案例。