收到乱序的 PowerShell 事件

Question

从同一个线程触发的事件应该按照触发顺序被接收，这听起来像是一个合理的期望。然而，情况似乎并非如此。这是一种已知/记录在案的行为，是否有任何补救措施来纠正它？

以下是两个可运行的代码 sn-ps，它们在 Win7 和 Win10 下使用 PS v5.1 进行了测试。

(a) 从单独作业（即不同进程）中的线程触发的事件。

$events = 1000
$recvd = 0
$ooseq = 0

$job = Register-EngineEvent -SourceIdentifier 'Posted' -Action {
    $global:recvd++ 
    if($global:recvd -ne $event.messageData) {
        $global:ooseq++
        ("-?- event #{0} received as #{1}" -f $event.messageData, $global:recvd)
} }

$run = Start-Job -ScriptBlock {
    Register-EngineEvent -SourceIdentifier 'Posted' -Forward
    for($n = 1; $n -le $using:events; $n++) {
        [void] (New-Event -SourceIdentifier 'Posted' -MessageData $n)
} }
Receive-Job -Job $run -Wait -AutoRemoveJob

Unregister-Event -SourceIdentifier 'Posted'
Receive-Job -Job $job -Wait -AutoRemoveJob

if($events -eq $script:recvd) {
    ("total {0} events" -f $events)
} else {
    ("total {0} events events, {1} received" -f $events, $recvd)
}
if($ooseq -ne 0) {
    ("{0} out-of-sequence events" -f $ooseq)
}

来自失败案例的样本输出（在一批 100 次连续运行中）。

   -?- event #545 received as #543
   -?- event #543 received as #544
   -?- event #546 received as #545
   -?- event #544 received as #546
   total 1000 events
   4 out-of-sequence events

(b) 从单独的运行空间（即不同的线程）触发的事件。

$recvd = 0
$ooseq = 0

$job = Register-EngineEvent -SourceIdentifier 'Posted' -Action {
    $global:recvd++ 
    if($recvd -ne $event.messageData) {
        $global:ooseq++
        ("-?- event #{0} received as #{1}" -f $event.messageData, $recvd)
}}

$sync = [hashTable]::Synchronized(@{})
$sync.Host = $host
$sync.events = 1000
$sync.posted = 0

$rs = [runspaceFactory]::CreateRunspace()
$rs.ApartmentState = "STA"
$rs.ThreadOptions = "ReUseThread"
$rs.Open()
$rs.SessionStateProxy.SetVariable("sync",$sync)

$ps = [powerShell]::Create().AddScript({
    for($n = 1; $n -le $sync.events; $n++) {
        $sync.Host.Runspace.Events.GenerateEvent('Posted', $null, $null, $n)
        $sync.posted++
}})
$ps.runspace = $rs
$thd = $ps.BeginInvoke()
$ret = $ps.EndInvoke($thd)
$ps.Dispose()

Unregister-Event -SourceIdentifier 'Posted'
Receive-Job -Job $job -Wait -AutoRemoveJob

if($sync.events -eq $recvd) {
    ("total {0} events" -f $sync.events)
} else {
    ("total {0} events fired, {1} posted, {2} received" -f $sync.events, $sync.posted, $recvd)
}
if($ooseq -ne 0) {
    ("{0} out-of-sequence events" -f $ooseq)
}

失败案例类似于上面 (a) 下发布的示例，除了一些运行也完全丢弃了事件。然而，这更有可能与另一个问题Action-based object events sometimes lost有关。

total 1000 events fired, 1000 posted, 999 received
484 out-of-sequence events

---

[ EDIT ] 我专门针对案例 (b) 进行了一些额外的测试，并确认：

• 接收动作（$global:recvd++）总是在同一个托管线程上调用（这通过保存和比较调用之间的[System.Threading.Thread]::CurrentThread.ManagedThreadId得到确认）；

• 在执行期间未重新输入接收动作（这已通过添加全局“嵌套”计数器来确认，将动作包装在 [System.Threading.Interlocked]::Increment/Decrement 调用之间并检查计数器永远不会取除0 和1 以外的任何值。

这些消除了几个可能的竞争条件，但仍然没有解释观察到的行为发生的原因或如何纠正它，因此原始问题仍然悬而未决。

Answer 1

这是一种已知/记录在案的行为吗？

“通常”事件处理是异步的设计。在 PowerShell 中使用 Register-EngineEvent -Action 之类的 cmdlet 就是这种情况。这确实是已知的和预期的行为。您可以阅读有关 PowerShell 事件 here 和 here 的更多信息。微软的两个消息来源都指出，这种事件处理方式是异步的：

PowerShell 事件允许您响应异步通知 那么多对象都支持。

和

注意 这些 cmdlet 只能用于异步 .NET 事件。它的 无法使用 PowerShell 事件 cmdlet。这是因为所有同步事件 在同一线程上执行，并且 cmdlet 期望（要求） 事件将发生在另一个线程上。没有第二个线程， PowerShell 引擎只会阻塞主线程，什么都不会 永远被处决。

所以这基本上就是你正在做的事情。您将后台作业中的事件转发给定义了操作的事件订阅者，并在不阻塞后台作业的情况下执行该操作。据我所知，没有什么可期待的了。没有指定以任何特殊顺序处理转发的事件的要求。甚至-Forward 开关也不能确保更多，除了传递事件：

表示 cmdlet 将此订阅的事件发送到 本地计算机上的会话。使用此参数时 在远程计算机或远程会话中注册事件。

很难甚至不可能找到有关 cmdlet 内部的任何文档。请记住，Microsoft 不会发布任何关于过去的内部结构的文档，而是由 MVP 来猜测内部发生的事情并写关于它的书籍（激烈地表达）。

因此，由于不需要按特定顺序处理事件，而 PowerShell 仅具有对事件队列执行操作的任务，因此也允许并行执行这些操作以加速事件队列的处理.

在只有一个 vCPU 的 VM 上测试您的脚本。错误的顺序有时仍然会发生，但很少发生。所以更少的（真正的）并行性，更少的扰乱顺序的可能性。当然，您不能阻止逻辑并行性，由在一个物理内核上执行的不同线程实现。所以仍然存在一些“错误”。

有办法改正吗？

我将“通常”放在引号中，因为有一些方法可以同步实现它。您必须实现自己的System.EventHandler 类型的事件处理程序。我建议阅读this article 以获取实现示例。

另一种解决方法是将事件存储在自己的事件队列中，并在收集后对它们进行排序（在 ISE 中运行，尚未在 PS 中运行）：

$events = 10000
$recvd = 0
$ooseq = 0
$myEventQueue = @()

$job = Register-EngineEvent -SourceIdentifier 'Posted' -Action {$global:myEventQueue += $event}

$run = Start-Job -ScriptBlock {
    Register-EngineEvent -SourceIdentifier 'Posted' -Forward
    for($n = 1; $n -le $using:events; $n++) {
        [void] (New-Event -SourceIdentifier 'Posted' -MessageData $n)
    }
}
Receive-Job -Job $run -Wait -AutoRemoveJob
Unregister-Event -SourceIdentifier 'Posted'
Receive-Job -Job $job -Wait -AutoRemoveJob

Write-Host "Wrong event order in unsorted queue:"
$i = 1
foreach ($event in $myEventQueue) {
    if ($i -ne $event.messageData) {
        Write-Host "Event $($event.messageData) received as event $i"
    }
    $i++
}

$myEventQueue = $myEventQueue | Sort-Object -Property EventIdentifier

Write-Host "Wrong event order in sorted queue:"
$i = 1
foreach ($event in $myEventQueue) {
    if ($i -ne $event.messageData) {
        Write-Host "Event $($event.messageData) received as event $i"
    }
    $i++
}

---

存档链接：

• PowerShell eventing async 1
• PowerShell eventing async 2
• PowerShell eventing sync