about_Pipeline_Chain_Operators

简短说明

介绍将管道与 PowerShell 中的 &&|| 运算符链接在一起。

详细说明

从 PowerShell 7 开始,PowerShell 实现 &&|| 运算符,以有条件地链接管道。 这些运算符在 PowerShell 中称为 管道链运算符,类似于 POSIX shell(如 bash、zsh 和 sh)中的 AND-OR 列表,以及 Windows Command Shell(cmd.exe)中 条件处理符号。

如果左侧管道成功,&& 运算符将执行右侧管道。 相反,如果左侧管道失败,|| 运算符将执行右侧管道。

这些运算符使用 $?$LASTEXITCODE 变量来确定管道是否失败。 这样,就可以将它们与本机命令一起使用,而不仅仅是 cmdlet 或函数。 例如:

# Create an SSH key pair - if successful copy the public key to clipboard
ssh-keygen -t rsa -b 2048 && Get-Content -Raw ~\.ssh\id_rsa.pub | clip

例子

两个成功的命令

Write-Output 'First' && Write-Output 'Second'
First
Second

第一个命令失败,导致第二个命令无法执行

Write-Error 'Bad' && Write-Output 'Second'
Write-Error: Bad

第一个命令成功,因此不会执行第二个命令

Write-Output 'First' || Write-Output 'Second'
First

第一个命令失败,因此执行第二个命令

Write-Error 'Bad' || Write-Output 'Second'
Write-Error: Bad
Second

管道成功由 $? 变量的值定义,PowerShell 根据管道的执行状态自动设置该变量。 这意味着管道链运算符具有以下等效性:

Test-Command '1' && Test-Command '2'

工作方式与

Test-Command '1'; if ($?) { Test-Command '2' }

Test-Command '1' || Test-Command '2'

工作方式与

Test-Command '1'; if (-not $?) { Test-Command '2' }

从管道链分配

从管道链分配变量将采用链中所有管道的串联:

$result = Write-Output '1' && Write-Output '2'
$result
1
2

如果从管道链分配期间发生脚本终止错误,则分配不会成功:

try
{
    $result = Write-Output 'Value' && $(throw 'Bad')
}
catch
{
    # Do nothing, just squash the error
}

"Result: $result"
Result:

运算符语法和优先级

与其他运算符不同,例如,&&|| 在管道上运行,而不是对 +-and等表达式进行作。

&&|| 的优先级低于管道(|)或重定向(>),但优先级高于作业运算符(&)、赋值(=)或分号(;)。 这意味着可以单独重定向管道链中的管道,并且可以对整个管道链进行后台处理、分配给变量或分隔为语句。

若要在管道链中使用优先级较低的语法,请考虑使用括号 (...)。 同样,若要在管道链中嵌入语句,可以使用子表达式 $(...)。 这可用于将本机命令与控制流组合在一起:

foreach ($file in 'file1','file2','file3')
{
    # When find succeeds, the loop breaks
    find $file && Write-Output "Found $file" && $(break)
}
find: file1: No such file or directory
file2
Found file2

从 PowerShell 7 起,这些语法的行为已更改,以便在命令在括号或子表达式内成功或失败时按预期方式设置 $?

与 PowerShell 中的大多数其他运算符一样,&&||左关联,这意味着它们从左侧分组。 例如:

Get-ChildItem -Path ./file.txt ||
    Write-Error "file.txt doesn't exist" &&
    Get-Content -Raw ./file.txt

将分组为:

(Get-ChildItem -Path ./file.txt || Write-Error "file.txt doesn't exist") &&
    Get-Content -Raw ./file.txt

等效于:

Get-ChildItem -Path ./file.txt

if (-not $?) { Write-Error "file.txt does not exist" }

if ($?) { Get-Content -Raw ./file.txt }

错误交互

管道链运算符不会吸收错误。 当管道链中的语句引发脚本终止错误时,管道链将终止。

例如:

$(throw 'Bad') || Write-Output '2'
Exception: Bad

即使捕获了错误,管道链也会终止:

try
{
    $(throw 'Bad') || Write-Output '2'
}
catch
{
    Write-Output "Caught: $_"
}
Write-Output 'Done'
Caught: Bad
Done

如果错误是非终止的,或只终止管道,则管道链会继续,并遵循 $?的值:

function Test-NonTerminatingError
{
    [CmdletBinding()]
    param()

    $exception = [System.Exception]::new('BAD')
    $errorId = 'BAD'
    $errorCategory = 'NotSpecified'

    $errorRecord = [System.Management.Automation.ErrorRecord]::new(
        $exception, $errorId, $errorCategory, $null
    )

    $PSCmdlet.WriteError($errorRecord)
}

Test-NonTerminatingError || Write-Output 'Second'
Test-NonTerminatingError: BAD
Second

链接管道而不是命令

管道链运算符的名称可用于链接管道,而不仅仅是命令。 这与其他 shell 的行为匹配,但可能会使成功更难确定:

function Test-NotTwo
{
    [CmdletBinding()]
    param(
      [Parameter(ValueFromPipeline)]
      $Input
    )

    process
    {
        if ($Input -ne 2)
        {
            return $Input
        }

        $exception = [System.Exception]::new('Input is 2')
        $errorId = 'InputTwo'
        $errorCategory = 'InvalidData'

        $errorRecord = [System.Management.Automation.ErrorRecord]::new(
            $exception, $errorId, $errorCategory, $null
        )

        $PSCmdlet.WriteError($errorRecord)
    }
}

1,2,3 | Test-NotTwo && Write-Output 'All done!'
1
Test-NotTwo : Input is 2
3

请注意,不会执行 Write-Output 'All done!',因为生成非终止错误后,Test-NotTwo 被视为失败。

另请参阅