如何在自定义PowerShell Cmdlet中抛出简洁可捕获的脚本终止错误

需求回顾 #

我需要从自定义Cmdlet中抛出满足以下要求的错误：

• 属于脚本终止错误：能让所在脚本终止执行（除非被捕获）
• 在终端中简洁显示：无堆栈跟踪信息
• 无需设置影响运行脚本的偏好变量（Cmdlet要在不受控制的脚本中使用）

已尝试方法的效果 #

可行方案 #

通过抛出自定义ErrorRecord对象，可以同时满足所有需求：

PowerShell脚本Cmdlet实现 #

在你的Cmdlet函数中，创建自定义错误记录并抛出，同时清空堆栈跟踪信息：

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

    # 1. 定义错误信息和异常对象
    $errorMsg = "参数格式错误，请输入有效的ID"
    $exception = [System.Management.Automation.RuntimeException]::new($errorMsg)
    
    # 2. 创建ErrorRecord，指定错误ID和分类
    $errorRecord = [System.Management.Automation.ErrorRecord]::new(
        $exception,
        "InvalidParameterId",
        [System.Management.Automation.ErrorCategory]::InvalidArgument,
        $null
    )

    # 3. 清空脚本堆栈跟踪，避免显示冗余信息
    $errorRecord.Exception.ScriptStackTrace = ""

    # 4. 抛出错误，默认会终止整个脚本
    throw $errorRecord
}

效果验证 #

调用该Cmdlet时，终端只会显示简洁的错误信息，无堆栈跟踪，且脚本会立即终止（未被捕获时）：

参数格式错误，请输入有效的ID

C#编译型Cmdlet实现 #

如果你的Cmdlet是C#编写的，代码如下：

using System;
using System.Management.Automation;

namespace CustomCmdlets
{
    [Cmdlet(VerbsDiagnostic.Test, "CustomError")]
    public class TestCustomErrorCmdlet : Cmdlet
    {
        protected override void ProcessRecord()
        {
            string errorMsg = "参数格式错误，请输入有效的ID";
            Exception exception = new Exception(errorMsg);
            
            ErrorRecord errorRecord = new ErrorRecord(
                exception,
                "InvalidParameterId",
                ErrorCategory.InvalidArgument,
                null
            );

            // 隐藏堆栈跟踪
            exception.Source = string.Empty;
            exception.StackTrace = string.Empty;

            // 抛出终止错误，默认会终止脚本
            ThrowTerminatingError(errorRecord);
        }
    }
}

关键说明 #

• 自定义ErrorRecord允许你完全控制错误的显示内容，通过清空ScriptStackTrace（PowerShell）或StackTrace（C#）来避免堆栈跟踪输出。
• 用throw抛出ErrorRecord时，默认会触发脚本终止行为（除非被try/catch捕获），无需依赖任何偏好变量。
• 错误可以正常被try/catch捕获，不影响调用者的错误处理逻辑。

内容的提问来源于stack exchange，提问作者JHR