如何在PowerShell中使用自定义对象（PsCustomObject）？

PowerShell 是一个功能强大的工具，可让您自动执行任务并更有效地管理系统。 PowerShell 最有用的功能之一是它能够创建自定义对象。 PowerShell 的自定义对象使您能够使用属性和方法创建自己的数据结构，并且可以轻松查询和操作。这些对象类似于面向对象编程语言中的类，但它们的创建和使用要简单得多。它们可用于整理来自不同来源的数据、转换数据以进行报告或用作流程的临时容器。在本文中，我们将详细探讨 PowerShell 自定义对象，包括基础知识、如何创建它们、操作它们、将它们与数组组合以及最佳实践。

了解 PowerShell 中的数组和对象

在深入研究 PSCustomObject 之前，了解 PowerShell 中数组和对象的概念非常重要。数组是值的集合，而对象是属性及其对应值的集合。

在 PowerShell 中，数组用方括号表示，数组中的各个值用逗号分隔。例如：

$Array = 1, 2, 3, 4, 5

另一方面，对象是使用 PSCustomObject 类型加速器创建的。属性及其值使用 @{property=value} 格式在哈希表中定义。例如：

$employee = [PSCustomObject]@{
    FirstName = 'John'
    LastName = 'Doe'
    Title = 'Software Engineer'
    Department = 'IT'
    HireDate = '2020-01-01'
}

在此示例中，我们创建一个名为 $employee 的自定义对象，它存储有关员工的信息，包括他们的名字、姓氏、职位、部门和雇用日期。

了解数组和对象至关重要，因为 PSCustomObjects 可以存储在数组中，使您可以同时有效地管理和操作多个对象。

PowerShell 自定义对象的基础知识

您可以通过不同的方式在 PowerShell 中创建自定义对象。其中一种方法是使用哈希表，该哈希表通过 [PSCustomObject] 类型加速器定义对象的属性和值。您可以在哈希表中定义属性及其值，并将其转换为 PSCustomObject 类型加速器。

[PSCustomObject]@{
    Property1 = 'Value1'
    Property2 = 'Value2'
}

在此语法中，Property1 和 Property2 是您定义的名称，而“Value1”和“Value2”是它们对应的值。例如，以下代码创建一个具有两个属性的自定义对象：

$person = [PSCustomObject]@{
    FirstName = 'John'
    LastName = 'Doe'
}

在此示例中，我们创建一个名为 $person 的自定义对象，它具有两个属性：FirstName 和 LastName。我们使用哈希表为这些属性分配值。请注意，PSCustomObject 类型加速器用于创建自定义对象。我们现在可以使用点运算符访问自定义对象的属性。例如，您可以通过在 PowerShell 脚本中键入“$Person.FirstName”来访问“Person”对象的“FirstName”属性。

使用 PSCustomObject 创建 PowerShell 自定义对象

使用 PSCustomObject 创建 PowerShell 自定义对象非常简单明了。您可以创建具有任意数量属性的自定义对象，并使用哈希表为这些属性分配值。例如，以下代码创建一个具有三个属性的自定义对象：

$Car = [PSCustomObject]@{
    Make = 'Toyota'
    Model = 'Corolla'
    Year = 2021
}

在此示例中，我们创建一个名为 $car 的自定义对象，它具有三个属性：Make、Model 和 Year代码>.我们使用哈希表为这些属性分配值。典型的自定义对象由一个或多个属性组成，这些属性用于存储数据。您还可以向自定义对象添加方法，用于对数据执行操作。

订购属性

如果需要维护属性的顺序，请使用 [ordered] 类型加速器：

[PSCustomObject][ordered]@{
    Name = "John"
    Age = 30
    Address = "123 Main St"
}

使用 New-Object PSCustomObject 创建 PowerShell 自定义对象

创建 PowerShell 自定义对象的另一种方法是使用 New-Object cmdlet，并将 -TypeName 参数设置为 PSCustomObject。例如，以下代码创建一个具有两个属性的自定义对象：

$person = New-Object -TypeName PSCustomObject -Property @{
    FirstName = 'John'
    LastName = 'Doe'
}

在此示例中，我们创建一个名为 $person 的自定义对象，它具有两个属性：FirstName 和 LastName。我们使用哈希表为这些属性分配值。

从现有对象初始化

您还可以从现有对象初始化自定义对象。例如，如果您只需要 Get-Process 中的特定属性，您可以这样做：

$Processes = Get-Process | Select-Object @{Name='ProcessName'; Expression={$_.Name}}, ID

将属性添加到自定义对象

创建 PSCustomObject 后，您可能需要动态添加其他属性。 PowerShell 提供了一种使用 Add-Member cmdlet 将属性添加到现有 PSCustomObject 的简单方法。下面是如何向 PSCustomObject 动态添加属性的示例。

让我们创建一个新的 PSObject

$Person = New-Object -TypeName PSCustomObject
$Person | Add-Member -MemberType NoteProperty -Name "FirstName" -Value "John"
$Person | Add-Member -MemberType NoteProperty -Name "LastName" -Value "Doe"
$Person | Add-Member -MemberType NoteProperty -Name "Age" -Value 30

然后稍后在脚本中向其添加新的自定义属性：

$Person | Add-Member -MemberType NoteProperty -Name "Country" -Value "United States"

在上面的示例中，我们向“$Person”对象添加了新属性“Country”。执行脚本后，“$Person”对象将包含“Country”属性以及之前定义的其他属性。您可以通过为“$Person”对象运行“Get-Member”cmdlet 来验证这一点。

使用 PSCustomObject 创建 PowerShell 自定义对象数组

PowerShell 自定义对象数组允许您在单个变量中存储多个自定义对象。您可以使用 PSCustomObject 创建自定义对象数组，就像创建单个自定义对象一样。例如，以下代码创建自定义对象的数组：

$Cars = @(
    [PSCustomObject]@{
        Make = 'Toyota'
        Model = 'Corolla'
        Year = 2021
    },
    [PSCustomObject]@{
        Make = 'Honda'
        Model = 'Civic'
        Year = 2022
    }
)

在此示例中，我们创建一个名为 $cars 的数组，其中包含两个自定义对象。每个自定义对象都具有三个属性：Make、Model 和 Year。

如何使用 PSCustomObject 数组并将数据导出到 CSV？

让我们考虑这样一个场景：您是系统管理员，正在收集环境中服务器的信息。您想要跟踪服务器名称、IP 地址及其主要角色。当您收集信息时，将其添加到 PSCustomObjects 数组中。最后，您希望将此数据导出到 CSV 以用于记录。

# Initialize an empty array to store server details
$serverList = @()

# Information for the first server
$server1 = [PSCustomObject]@{
    ServerName = "ServerA"
    IPAddress  = "192.168.1.10"
    Role       = "Web Server"
}

# Add the first server to the array
$serverList += $server1

# Information for the second server
$server2 = [PSCustomObject]@{
    ServerName = "ServerB"
    IPAddress  = "192.168.1.11"
    Role       = "Database Server"
}

# Add the second server to the array
$serverList += $server2

# Export the array to a CSV
$serverList | Export-Csv -Path "C:\Reports\output.csv" -NoTypeInformation

# Feedback to console
Write-Host "Server data exported successfully to C:\Reports\output.csv"

这是另一个现实世界的示例，您希望收集有关 PC 上已停止服务的信息：

# Fetch stopped services
$stoppedServices = Get-Service | Where-Object { $_.Status -eq "Stopped" }

# Initialize an empty array to store service details
$serviceDetailsList = @()

# Process each stopped service
foreach ($service in $stoppedServices) {
    $serviceDetail = [PSCustomObject]@{
        ServiceName     = $service.ServiceName
        DisplayName    = $service.DisplayName
        StartType      = $service.StartType
    }

    # Add the service detail to the array
    $serviceDetailsList += $serviceDetail
}

# Export the array to a CSV
$serviceDetailsList | Export-Csv -Path "C:\Temp\stoppedServices.csv" -NoTypeInformation

输出 ：

组合 PowerShell 自定义对象和数组

PowerShell 自定义对象和数组可以组合起来创建复杂的数据结构。例如，您可以创建自定义对象数组，其中每个自定义对象都有一个数组属性。以下代码创建一个自定义对象数组，其中每个自定义对象都有一个数组属性：

$people = @(
    [PSCustomObject]@{
        FirstName = 'John'
        LastName = 'Doe'
        Addresses = @(
            [PSCustomObject]@{
                Street = '123 Main St'
                City = 'Anytown'
                State = 'CA'
                Zip = '12345'
            },
            [PSCustomObject]@{
                Street = '456 Oak St'
                City = 'Anytown'
                State = 'CA'
                Zip = '12345'
            }
        )
    },
    [PSCustomObject]@{
        FirstName = 'Jane'
        LastName = 'Doe'
        Addresses = @(
            [PSCustomObject]@{
                Street = '789 Elm St'
                City = 'Anytown'
                State = 'CA'
                Zip = '12345'
            }
        )
    }
)

在此示例中，我们创建一个名为 $people 的数组，其中包含两个自定义对象。每个自定义对象都具有三个属性：FirstName、LastName 和 Addresses。 Addresses 属性是一个自定义对象数组，代表人员的地址。

如何将 PSCustomObject 与 ForEach 循环一起使用？

假设我们有一个仅包含全名的用户列表，我们希望将这些名称分为名字和姓氏，然后将每个用户表示为 PSCustomObject。

# Sample list of users
$userNames = @("John Doe", "Jane Smith", "Alice Johnson")

# Convert to custom objects
$customUserObjects = $userNames | ForEach-Object {
    # Split name into first and last
    $splitName = $_ -split ' '
    $firstName = $splitName[0]
    $lastName = $splitName[1]

    # Create custom object
    [PSCustomObject]@{
        FirstName = $firstName
        LastName  = $lastName
    }
}

# Display the result
$customUserObjects | Format-Table -AutoSize

输出 ：

FirstName LastName
--------- --------
John      Doe     
Jane      Smith   
Alice     Johnson

上面的示例展示了使用 PowerShell 中的 PSCustomObject 和 ForEach-Object 将简单字符串转换为结构化数据。

将 PSCustomObject 导出为 CSV 以进行数据分析

从 PowerShell 导出数据可能是一项繁琐的任务，尤其是在处理复杂的数据集时。但是，PowerShell 自定义对象使导出此数据变得更加容易。 PowerShell 对象可以轻松导出为各种文件格式，例如 CSV、XML 和 JSON，从而更轻松地与其他系统或应用程序共享数据。以下是将员工数据导出到 CSV 文件的示例：

$Employee | Export-Csv -Path C:\Temp\Employees.csv -NoTypeInformation

上面的示例使用 Export-Csv cmdlet 将 $employee 对象导出到 CSV 文件。请注意，我们使用 -NoTypeInformation 参数从文件中排除类型信息。通过将 PSCustomObject 转换为 CSV，您可以利用 Excel 或其他数据分析工具的强大功能进行进一步处理和可视化。

如何使用 PowerShell 自定义对象操作和转换数据？

创建自定义 PowerShell 对象后，您可以使用它以适合您需求的方式操作和转换数据。例如，您可以使用 Select-Object cmdlet 筛选和重新排序对象的属性，使用 Sort-Object cmdlet 按属性对对象进行排序，或使用 Group-Object cmdlet 按属性对对象进行分组。

例如，假设您有一个员工对象的集合，每个对象都具有姓名、年龄和部门等属性。您可以将这些对象存储在数组中并对它们执行各种操作，例如过滤、排序或分组。这是一个例子：

$Employees = @(
    [PSCustomObject]@{ Name = "John"; Age = 30; Department = "IT" }
    [PSCustomObject]@{ Name = "Jane"; Age = 35; Department = "HR" }
    [PSCustomObject]@{ Name = "Michael"; Age = 40; Department = "Finance" }
    [PSCustomObject]@{ Name = "Emily"; Age = 25; Department = "Marketing" }
)

# Filter employees by age greater than 30
$filteredEmployees = $employees | Where-Object { $_.Age -gt 30 }
$filteredEmployees

# Sort employees by name
$sortedEmployees = $employees | Sort-Object Name
$sortedEmployees

# Group employees by department
$groupedEmployees = $employees | Group-Object Department
$groupedEmployees

在此示例中，我们创建了一个员工对象数组，并演示了如何使用 PowerShell cmdlet 对对象进行筛选、排序和分组。通过利用 PSCustomObjects 数组，您可以简化数据管理任务并轻松执行复杂的操作。

PowerShell 自定义对象的高级技术

PowerShell 自定义对象可以通过多种方式使用来创建复杂的数据结构并执行高级任务。以下是一些使用 PowerShell 自定义对象的高级技术：

向自定义对象添加方法

您可以使用 Add-Member cmdlet 将方法添加到自定义对象。方法是可以在自定义对象上调用以对其数据执行操作的函数。例如，以下代码将方法添加到自定义对象：

$person = [PSCustomObject]@{
    FirstName = 'John'
    LastName = 'Doe'
}

$person | Add-Member -MemberType ScriptMethod -Name GetFullName -Value {
    return $this.FirstName + ' ' + $this.LastName
}

$person.GetFullName()

在此示例中，我们创建一个名为 $person 的自定义对象，它具有两个属性：FirstName 和 LastName。然后，我们向名为 GetFullName 的自定义对象添加一个方法，该方法返回该人的全名。我们使用 $person.GetFullName() 语法调用该方法。

从 CSV 文件创建自定义对象

您可以使用 Import-Csv cmdlet 从 CSV 文件创建自定义对象。 CSV 文件是存储数据的常见方式，PowerShell 可以轻松地将这些数据转换为自定义对象。例如，以下代码从 CSV 文件创建自定义对象：

$data = Import-Csv -Path 'data.csv'

$data | ForEach-Object {
    [PSCustomObject]@{
        FirstName = $_.First
        LastName = $_.Last
        Age = $_.Age
    }
}

在此示例中，我们使用 Import-Csv cmdlet 从 CSV 文件导入数据。然后，我们使用 ForEach-Object cmdlet 为 CSV 文件中的每一行创建一个自定义对象。自定义对象具有三个属性：FirstName、LastName 和 Age，这些属性是从 CSV 文件填充的。

PowerShell 中的嵌套 PSCustomObject

另一种高级技术是使用嵌套 PSCustomObjects。嵌套 PSCustomObject 允许您通过将一个 PSCustomObject 嵌入另一个 PSCustomObject 来创建复杂的数据结构。当您需要分层组织数据或表示对象之间的关系时，这非常有用。这是一个例子：

$company = [PSCustomObject]@{
    Name = "ACME Corporation"
    Employees = @(
        [PSCustomObject]@{
            Name = "John Doe"
            Age = 30
        },
        [PSCustomObject]@{
            Name = "Jane Smith"
            Age = 35
        }
    )
}

在此示例中，我们创建了一个名为 $company 的嵌套 PSCustomObject，它代表一个具有员工列表的虚构公司。

使用 PowerShell 自定义对象的好处

与传统数据结构（例如数组和哈希表）相比，PowerShell 自定义对象具有多种优势。以下是使用 PowerShell 自定义对象的一些好处：

• 提高可读性：自定义对象提供了一种以更易读和更容易理解的方式构建数据的方法。自定义对象的每个属性都可以被赋予一个有意义的名称，这使得更容易理解数据表示的内容。
• 简化数据操作：自定义对象通过提供一致且结构化的方式来访问数据，从而使数据操作变得更加容易。自定义对象不使用复杂的嵌套数组或哈希表，而是提供了一种简单直观的方式来访问和操作数据。
• 改进的代码可重用性：自定义对象可以在不同的 PowerShell 脚本和模块中使用，这使得它们成为存储和操作数据的可重用且模块化的方式。这使得编写高效且可维护的 PowerShell 脚本变得更加容易。

使用 PowerShell 自定义对象的最佳实践

以下是使用 PowerShell 自定义对象的一些最佳实践：

• 使用有意义的属性名称：定义自定义对象时，请使用有意义的属性名称来准确描述所存储的数据。
• 使用一致的属性类型：在所有自定义对象中使用一致的属性类型，以确保数据始终采用一致的格式。这使得排序、过滤和处理数据变得更加容易。
• 将自定义对象用于复杂数据结构：将自定义对象用于需要结构化且一致的方式来存储和操作数据的复杂数据结构。
• 使用 CSV 文件存储自定义对象：使用 CSV 文件存储需要在 PowerShell 会话中保留的自定义对象。
• 避免创建过多的属性：过多的属性会使对象变得繁琐并降低脚本性能。

如果您有兴趣了解有关 PowerShell 自定义对象的更多信息，您可能会发现这很有帮助：Microsoft Docs 上的 PowerShell 自定义对象

包起来

PowerShell 自定义对象提供了一致且结构化的方式来访问和操作数据，这使得编写高效且可维护的 PowerShell 脚本变得更加容易。通过利用 PowerShell 对象，您可以创建高效的结构化数据，这些数据可以轻松操作、导出并与其他 PowerShell 功能（例如筛选器和函数）一起使用。通过遵循最佳实践并使用高级技术，您可以创建复杂的数据结构并使用 PowerShell 自定义对象执行高级任务。如果您不熟悉 PowerShell 自定义对象，请花一些时间探索本文中提供的示例和资源，并开始在您自己的 PowerShell 脚本中尝试自定义对象！