powershell - 如何在 PowerShell 中创建自定义类型以供我的脚本使用？

Question

我希望能够在我的一些 PowerShell 脚本中定义和使用自定义类型。例如，假设我需要一个具有以下结构的对象:

Contact
{
    string First
    string Last
    string Phone
}

我将如何创建它，以便我可以在如下函数中使用它:

function PrintContact
{
    param( [Contact]$contact )
    "Customer Name is " + $contact.First + " " + $contact.Last
    "Customer Phone is " + $contact.Phone 
}

这样的事情可能吗，甚至在 PowerShell 中推荐吗？

Answer 1

PowerShell 3 之前的版本

PowerShell 的可扩展类型系统最初不允许您创建可以根据参数中的方式进行测试的具体类型。如果您不需要该测试，则可以使用上述任何其他方法。

如果您想要一个可以转换为或进行类型检查的实际类型，如示例脚本中所示...如果不使用 C# 或 VB.net 编写并编译，则无法完成。在 PowerShell 2 中，您可以使用“Add-Type”命令来完成非常简单的操作:

add-type @"
public struct contact {
   public string First;
   public string Last;
   public string Phone;
}
"@

历史记录:在 PowerShell 1 中，这甚至更难。你必须手动使用CodeDom，有一个非常古老的函数new-struct PoshCode.org 上的脚本会有所帮助。你的例子变成:

New-Struct Contact @{
    First=[string];
    Last=[string];
    Phone=[string];
}

使用 Add-Type 或 New-Struct 将让您实际测试 param([Contact]$contact) 中的类，并且使用 $contact = new-object Contact 制作新的，依此类推...

在 PowerShell 3 中

如果您不需要可以转换到的“真实”类，则不必使用 Steven and others have demonstrated 那样的添加成员方式。如上所述。

从 PowerShell 2 开始，您可以使用 New-Object 的 -Property 参数:

$Contact = New-Object PSObject -Property @{ First=""; Last=""; Phone="" }

在 PowerShell 3 中，我们能够使用 PSCustomObject 加速器添加 TypeName:

[PSCustomObject]@{
    PSTypeName = "Contact"
    First = $First
    Last = $Last
    Phone = $Phone
}

您仍然只获得一个对象，因此您应该创建一个 New-Contact 函数来确保每个对象都相同，但您现在可以轻松验证参数“是"通过使用 PSTypeName 属性修饰参数来实现其中一种类型:

function PrintContact
{
    param( [PSTypeName("Contact")]$contact )
    "Customer Name is " + $contact.First + " " + $contact.Last
    "Customer Phone is " + $contact.Phone 
}

在 PowerShell 5 中

在 PowerShell 5 中，一切都发生了变化，我们最终得到了 class 和 enum 作为定义类型的语言关键字(没有 struct 但没关系):

class Contact
{
    # Optionally, add attributes to prevent invalid values
    [ValidateNotNullOrEmpty()][string]$First
    [ValidateNotNullOrEmpty()][string]$Last
    [ValidateNotNullOrEmpty()][string]$Phone

    # optionally, have a constructor to 
    # force properties to be set:
    Contact($First, $Last, $Phone) {
       $this.First = $First
       $this.Last = $Last
       $this.Phone = $Phone
    }
}

我们还获得了一种不使用 New-Object 创建对象的新方法:[Contact]::new() - 事实上，如果您保留了您的类简单并且不定义构造函数，您可以通过转换哈希表来创建对象(尽管没有构造函数，将无法强制必须设置所有属性):

class Contact
{
    # Optionally, add attributes to prevent invalid values
    [ValidateNotNullOrEmpty()][string]$First
    [ValidateNotNullOrEmpty()][string]$Last
    [ValidateNotNullOrEmpty()][string]$Phone
}

$C = [Contact]@{
   First = "Joel"
   Last = "Bennett"
}