powershell - PowerShell和进程退出代码

Question

这个自我解答的问题试图解决在PowerShell中处理process exit codes的两个不同方面:

在PowerShell代码中，如何查询由外部进程(对外部程序的调用)设置的退出代码，以及这些退出代码如何与PowerShell的错误处理集成？

当其他人通过其CLI， pwsh (PowerShell Core)/ powershell.exe (Windows PowerShell)调用PowerShell时，由什么决定PowerShell进程的退出代码，该成功代码将成功与失败传达给调用进程(可以是build/CI/automation) -服务器任务，计划任务或其他 shell 程序)。

Answer 1

自PowerShell [Core] 7.1.0-preview.6起最新。
PowerShell内部使用的退出代码:
PowerShell –在内部，本机PowerShell命令通常在进程内运行，而运行外部程序的子进程的退出代码在中的作用非常有限:

本机PowerShell命令通常不设置退出代码，也不对它们执行操作。

PowerShell具有一个抽象的对应代码，用于退出代码:automatic, Boolean success-status variable $? :

它反射(reflect)了最近执行的命令是否有任何错误，但是在实践中很少使用，主要是因为-直到6.x版本-在(...)中加入命令似乎无足轻重，将$?重置为$true-请参见this GitHub issue-并且由于在用户函数中使用Write-Error不会将$?设置为$false-请参见this GitHub issue;但是，最终providing the ability for user code to set $? explicitly has been green-lit是将来的版本。

尽管$?也(立即)反射(reflect)出外部程序是否报告了0的退出代码(信号成功，使$?报告$true)或非零退出代码(通常表示信号失败，使$?成为$false)，但这是自动的$LASTEXICODE变量包含特定的退出代码(作为整数)，并且该值一直保留到在同一 session 中调用另一个外部程序(如果有)为止。

此外，在v7.0以及更高版本中，如果外部程序报告退出代码$?并生成stderr输出，则0可以报告错误否定消息，并且还存在涉及2>或*>的PowerShell重定向-请参见this answer和this GitHub issue；从PowerShell 7.1.0-preview.6开始;纠正后的行为可以通过experimental feature PSNotApplyErrorActionToStderr获得。

与PowerShell本地命令报告的终止错误或非终止错误不同，$ErrorActionPreference首选项变量不能自 Action 用于外部程序的非零退出代码。也就是说，您不能使用该变量来使外部程序的stderr输出静音，更重要的是，当外部程序报告非零退出代码时，您不能选择通过值'Stop'中止脚本。

在this RFC中提出了将外部程序更好地集成到PowerShell的错误处理中的建议。

当从外部调用PowerShell时，如何控制PowerShell报告为退出代码的内容:
设置退出代码，至少可以传达成功(0)与失败(通常为非零)的交流，这是重要的机制，用于让外部调用者知道您的PowerShell代码总体上是否成功，例如从计划中调用时任务或从自动化服务器(如Jenkins)通过PowerShellt命令行界面(命令行界面)-PowerShell [Core]的 pwsh 与Windows PowerShell的 powershell.exe 。
CLI提供了两种执行PowerShell代码的方法，您可以使用exit <n>设置退出代码，其中<n>是所需的退出代码:

-File <script> [args...]希望执行脚本文件(*.ps1)的路径，并可选地后面跟参数。

在这样的脚本文件中直接执行exit <n>(而不是在您从该脚本调用的另一个脚本中)执行，使PowerShell进程将其退出代码报告为<n>。

-Command <powershell-code>需要一个包含一个或多个PowerShell命令的字符串。

为了安全起见，请将exit <n>用作该命令字符串的直接部分-通常用作最后一条语句。

如果从通过退出代码检查成功的工具中调用了您的代码，请确保所有代码路径都明确使用exit <n>终止。
警告:如果PowerShell进程由于未处理的脚本终止错误而终止，则无论CLI是用-File还是-Command调用，退出代码始终为1 。

使用throw语句从PowerShell代码生成脚本终止(线程终止)错误，或者通过使用-ErrorAction Stop或$ErrorActionPreference = 'Stop'升级不太严重的本机PowerShell错误，或者通过按Ctrl-C强制终止脚本来生成脚本终止(线程终止)错误。

如果退出代码1不够具体(通常是这样，因为通常只需要传达成功与失败的信息)，则可以将代码包装在try/catch语句中，并使用exit <n>块中的catch 。

PowerShell如何设置其进程退出代码的确切规则很复杂；在下面找到摘要。

PowerShell如何设置其进程退出代码:

如果发生未处理的脚本终止错误，则退出代码始终为1。

使用 -File ，执行脚本文件(*.ps1):

如果脚本直接执行exit <n> ，则<n>成为退出代码(嵌套调用中的此类语句无效)。

否则，即使脚本执行过程中发生非终止或语句终止错误，也为0 。

使用 -Command ，执行包含一个或多个语句的命令字符串:

如果作为命令字符串中传递的语句之一(通常是最后一条语句)直接执行，则直接执行 exit <n>语句，则<n>成为退出代码。

否则，决定退出代码的是$? 所隐含的最后执行的语句的成功状态。

如果$?是:

$true->退出代码0

$false->退出代码1-即使在最后执行的语句是报告了不同的非零退出代码的外部程序的情况下。

鉴于命令字符串中的最后一条语句可能不是您要表示成功与失败的语句，因此明确使用exit <n>来可靠地控制退出代码，这也允许您报告特定的非零退出代码。

例如，要忠实地中继外部程序报告的退出代码，请将; exit $LASTEXITCODE附加到传递给-Command的字符串上。

从PowerShell 7.0开始的不一致和陷阱:

可以说，-Command(-c)应该报告最后一条语句的特定退出代码(如果它有一个)，而不是抽象的0与1。例如，pwsh -c 'findstr'; $LASTEXITCODE应该报告2，它是findstr.exe的特定退出代码，而不是抽象的1-请参阅this GitHub issue。

使用*.ps1文件/-File CLI参数的退出代码报告:

这只是一个显式的exit <n>语句，可以有意义地设置退出代码。相反，它应该再次是确定退出代码的脚本中执行的最后一条语句(当然，它可以是exit语句)，与POSIX兼容的shell和-Command一样(尽管讨论的不是最佳方式) 。

当您通过*.ps1调用-File脚本或通过-Command作为最后一条语句时，在没有通过exit语句退出脚本的情况下，PowerShell的退出代码始终为0(在特殊的Ctrl-C/throw情况下，该代码将变为1 )。

相反，当在 session 中调用

时，再次在没有exit的情况下，$LASTEXICODE反射(reflect)了最后执行的任何外部程序(或其他*.ps1，如果设置了退出代码)的退出代码-无论是在脚本内还是之前执行。

换句话说:

与-File不同，使用-Command时，在没有0语句的情况下(除非异常终止)，将退出代码分类设置为exit。

在 session 中，在没有$LASTEXITCODE语句的情况下，整个脚本根本没有设置退出代码(如exit所示)。

请参阅GitHub issue #11712。