PowerShell类的高级特性与应用

### PowerShell 类的高级特性与应用 在 PowerShell 中，类具有丰富的功能和特性，能够帮助开发者更高效地处理各种任务。下面将详细介绍 PowerShell 类的一些重要特性和应用场景。 #### 类的基本操作 在 PowerShell 里，类可以实现 `IEquatable` 接口，从而支持使用 `-eq` 运算符来比较两个类的实例。以下是一个示例： ```powershell class MyClass { [int] $Number [int] GetHashCode() { return $this.Number } [bool] Equals( [object] $equalTo ) { return $this.Number -eq $equalTo.Number } } $first = [MyClass]@{ Number = 1 } $second = [MyClass]@{ Number = 1 } $first -eq $second # 输出 True ``` 在上述代码中，`MyClass` 类实现了 `GetHashCode` 和 `Equals` 方法，使得可以直接使用 `-eq` 运算符比较两个 `MyClass` 实例。 #### 类的类型转换 PowerShell 类支持多种类型转换方式，下面分别介绍： - **通过构造函数实现类型转换**：可以创建一个接受特定类型参数的构造函数，来实现从该类型到类的转换。例如，实现从 `Int` 到 `MyClass` 的转换： ```powershell class MyClass { [int] $Number MyClass() { } MyClass([int] $value) { $this.Number = $value } } [MyClass]1 # 输出 Number 为 1 的 MyClass 实例 ``` 在这个例子中，定义了一个接受 `int` 类型参数的构造函数，这样就可以将 `Int32` 值直接转换为 `MyClass` 实例。不过，尝试将 `Int64` 类型的值转换为 `MyClass` 实例会失败，例如 `[MyClass][long]1` 会抛出 `InvalidArgument` 异常。 - **使用 `Parse` 静态方法实现类型转换**：`Parse` 静态方法可以接受任意对象，并尝试将其转换为目标类型。示例如下： ```powershell class MyClass { [int] $Number static [MyClass] Parse( [object] $value ) { if ($value -as [int]) { return [MyClass]@{ Number = $value } } else { throw 'Unsupported value' } } } [MyClass][long]2312 # 输出 Number 为 2312 的 MyClass 实例 ``` 这里的 `Parse` 方法会尝试将传入的对象转换为 `int` 类型，如果成功则返回一个 `MyClass` 实例。 - **使用隐式转换运算符实现类型转换**：通过实现 `op_Implicit` 静态方法，可以实现类到其他类型的隐式转换。示例如下： ```powershell class NewClass { [string] $DayOfWeek } class MyClass { [int] $Number hidden static [NewClass] op_Implicit( [MyClass] $instance ) { return [NewClass]@{ DayOfWeek = [DayOfWeek]$instance.Number } } } [NewClass][MyClass]@{ Number = 1 } # 输出 DayOfWeek 为 Monday 的 NewClass 实例 ``` 在这个例子中，`MyClass` 类实现了 `op_Implicit` 方法，使得可以将 `MyClass` 实例隐式转换为 `NewClass` 实例。不过，这种方法最多只能添加两个 `op_Implicit` 方法，且每个方法的签名（名称和参数）必须唯一。 #### 类与运行空间的亲和性 在 PowerShell 中，类的实例默认与创建它们的运行空间具有亲和性，这意味着在不同运行空间中调用类的方法时，会将调用排队到原始运行空间执行。以下是一个示例： ```powershell class WithAffinity { [void] Run() { [Console]::WriteLine([Runspace]::DefaultRunspace.Id) } } 1..5 | ForEach-Object { $instance = [WithAffinity]::new() [PowerShell]::Create(). AddScript('$args[0].Run()'). AddArgument($instance). Invoke() } ``` 上述代码会显示每个运行空间的 ID，并且由于亲和性，每个方法调用都会在原始运行空间执行。这种亲和性可能会导致两个潜在的问题： - **跨运行空间方法调用可能导致会话状态损坏和死锁**：当遇到这种情况时，PowerShell 进程会挂起，并且不会响应用户输入或使用 `Control + C` 进行取消。 - **操作会串行执行**：因为每个操作都必须等待原始运行空间执行。可以通过以下示例来演示串行执行的问题： ```powershell class WithAffinity { [void] Run() { [Console]::WriteLine( 'Runspace: {0}; Time: {1:HH:mm:ss.fff}' -f @( [Runspace]::DefaultRunspace.Id Get-Date ) ) Start-Sleep -Seconds 2 } } 1..5 | ForEach-Object { $instance = [WithAffinity]::new() [PowerShell]::Create(). AddScript('$args[0].Run()'). AddArgument($instance).BeginInvoke() | Out-Null } ``` 在这个示例中，每个方法调用会间隔约 2 秒开始执行，显示出串行执行的特点。 为了解决这些问题，PowerShell 7.3 引入了 `NoRunspaceAffinity` 属性，使用该属性可以移除类实例与运行空间的亲和性，使方法在新的运行空间中执行。示例如下： ```powershell [NoRunspaceAffinity()] class NoAffinity { [void] Run() { [Console]::WriteLine( 'Runspace: {0}; Time: {1:HH:mm:ss.fff}' -f @( [Runspace]::DefaultRunspace.Id Get-Date ) ) Start-Sleep -Seconds 2 } } 1..5 | ForEach-Object { $instance = [NoAffinity]::new() [PowerShell]::Create(). AddScript('$args[0].Run()'). AddArgument($instance).BeginInvoke() | Out-Null } ``` 在这个示例中，每个方法调用几乎会同时开始执行，显示出并行执行的特点。 #### 参数转换、验证和完成 PowerShell 提供了多种属性来转换、验证变量、参数和类属性的值，并且可以使用类来实现这些属性。 ##### 参数转换属性类 参数转换属性用于在验证和绑定之前转换分配给变量、参数或属性的值。实现参数转换的类必须继承自 `System.Management.Automation.ArgumentTransformationAttribute`，并实现 `Transform` 方法。以下是一个将日期字符串转换为 `DateTime` 类型的示例： ```powershell using namespace System.Management.Automation class DateTimeStringTransformationAttribute : ArgumentTransformationAttribute { [object] Transform( [EngineIntrinsics] $engineIntrinsics, [object] $inputData ) { if ($inputData -is [DateTime]) { return $inputData } $date = Get-Date $isValidDate = [DateTime]::TryParseExact( $inputData, 'yyyyMMddHHmmss', $null, 'None', [ref]$date ) if ($isValidDate) { return $date } throw 'Unexpected date format' } } function Test-Transform { param ( [DateTimeStringTransformation()] [DateTime] $Date ) Write-Host $Date } Test-Transform -Date '20210102090000' # 输出转换后的日期 ``` 在这个例子中，`DateTimeStringTransformationAttribute` 类实现了 `Transform` 方法，将符合 `yyyyMMddHHmmss` 格式的日期字符串转换为 `DateTime` 类型。 ##### 验证属性类 PowerShell 类可以用于构建自定义验证属性，验证属性必须继承自 `ValidateArgumentsAttribute` 或 `ValidateEnumeratedArgumentsAttribute`。 - **`ValidateArgumentsAttribute`**：继承自该属性的验证器会测试整个值。例如，验证一组字符串是否按字母顺序排列： ```powershell using namespace System.Management.Automation class ValidateAlphabeticalOrder : ValidateArgumentsAttribute { [void] Validate( [object] $arguments, [EngineIntrinsics] $engineIntrinsics ) { $values = @($arguments) for ($i = 1; $i -lt $values.Count; $i++) { if ($values[$i] -lt $values[$i - 1]) { throw 'Arguments must be in alphabetical order.' } } } } function Test-Validate { [CmdletBinding()] param ( [ValidateAlphabeticalOrder()] [string[]] $Value ) } Test-Validate -Value 'a', 'c', 'f' # 不会抛出错误 Test-Validate -Value 'a', 'f', 'a' # 会抛出错误 ``` 在这个例子中，`ValidateAlphabeticalOrder` 类实现了 `Validate` 方法，用于验证传入的字符串数组是否按字母顺序排列。 - **`ValidateEnumeratedArgumentsAttribute`**：继承自该属性的类可以测试数组中的每个元素或单个项。例如，验证 IP 地址是否为私有地址： ```powershell using namespace System.Management.Automation class ValidatePrivateIPAddressAttribute : ValidateEnumeratedArgumentsAttribute { hidden [bool] IsPrivateIPAddress( [IPAddress] $address ) { $bytes = $address.GetAddressBytes() $isPrivateIPAddress = switch ($null) { { $bytes[0] -eq 10 } { $true; break } { $bytes[0] -eq 172 -and $ ```