通过

about_Calculated_Properties

  • 项目

简短说明

PowerShell 提供动态添加新属性和更改对象输出到管道的格式设置的功能。

长说明

许多 PowerShell cmdlet 使用允许向这些输出对象添加新属性的参数，将输入对象转换、聚合或处理到输出对象中。 这些参数可用于基于输入对象的值在输出对象上生成新的计算属性。 计算属性由哈希表定义，该 哈希表 包含指定新属性名称的键值对、用于计算值的表达式以及可选的格式设置信息。

受支持的 cmdlet

以下 cmdlet 支持 Property 参数的计算属性值。 cmdlet Format-* 还支持 GroupBy 参数的计算值。

以下列表逐项列出了支持计算属性的 cmdlet 和每个 cmdlet 支持的键值对。

  • Compare-Object

    • expression

  • ConvertTo-Html

    • name/label - PowerShell 6.x) 中添加了可选 (
    • expression
    • width -选
    • alignment -选

  • Format-Custom

    • expression
    • depth -选

  • Format-List

    • name/label -选
    • expression
    • formatstring -选

    这组相同的键值对也适用于传递给所有 Format-* cmdlet 的 GroupBy 参数的计算属性值。

  • Format-Table

    • name/label -选
    • expression
    • formatstring -选
    • width -选
    • alignment -选

  • Format-Wide

    • expression
    • formatstring -选

  • Group-Object

    • expression

  • Measure-Object

    • 仅支持表达式的脚本块，不支持哈希表。
    • 在 PowerShell 5.1 和更早版本中不受支持。

  • Select-Object

    • name/label -选
    • expression

  • Sort-Object

    • expression
    • ascending/descending -选

注意

的值 expression 可以是脚本块，而不是哈希表。 有关详细信息，请参阅说明部分。

哈希表键定义

  • name/label - 指定要创建的属性的名称。 可以互换使用 name 或其别名 label。
  • expression - 用于计算新属性的值的脚本块。
  • alignment - 由生成表格输出的 cmdlet 用来定义值在列中的显示方式。 值必须为 'left'、'center' 或 'right'。
  • formatstring - 指定一个格式字符串，该字符串定义如何为输出设置值的格式。 有关格式字符串的详细信息，请参阅 .NET 中的格式类型。
  • width - 指定显示值时表中的最大宽度列。 该值必须大于 0。
  • depth- 的 Format-CustomDepth 参数指定所有属性的扩展深度。 使用 depth 键可以指定每个属性的扩展深度。
  • ascending / descending - 允许指定一个或多个属性的排序顺序。 这些是布尔值。

只要指定的名称前缀是明确的，哈希表键就不需要拼写出来。 例如， n 可用于代替 Name ， e 可用于代替 Expression。

示例

Compare-Object

使用计算属性，可以控制如何比较输入对象的属性。 在此示例中，将值与算术运算的结果进行比较，而不是直接比较这些值， (取模为 2) 。

Compare-Object @{p=1} @{p=2} -property @{ Expression = { $_.p % 2 } }

 $_.p % 2  SideIndicator
---------- -------------
         0 =>
         1 <=

ConvertTo-Html

ConvertTo-Html 可以将 对象的集合转换为 HTML 表。 计算属性允许你控制表的显示方式。

Get-Alias |
  ConvertTo-Html Name,
                 Definition,
                 @{
                    name='ParameterCount'
                    expr={$_.Parameters.Keys.Count}
                    align='center'
                 } |
    Out-File .\aliases.htm -Force

此示例创建一个 HTML 表，其中包含 PowerShell 别名列表以及每个别名命令的数字参数。 ParameterCount 列的值居中。

Format-Custom

Format-Custom 以类似于类定义的格式提供对象的自定义视图。 更复杂的对象可以包含与复杂类型深度嵌套的成员。 的 Format-CustomDepth 参数指定所有属性的扩展深度。 使用 depth 键可以指定每个属性的扩展深度。

在此示例中， depth 键简化了 cmdlet 的 Get-Date 自定义输出。 Get-Date 返回 DateTime 对象。 此对象的 Date 属性也是 DateTime 对象，因此该对象是嵌套的。

Get-Date | Format-Custom @{expr={$_.Date};depth=1},TimeOfDay

class DateTime
{
  $_.Date =
    class DateTime
    {
      Date = 8/7/2020 12:00:00 AM
      Day = 7
      DayOfWeek = Friday
      DayOfYear = 220
      Hour = 0
      Kind = Local
      Millisecond = 0
      Minute = 0
      Month = 8
      Second = 0
      Ticks = 637323552000000000
      TimeOfDay = 00:00:00
      Year = 2020
      DateTime = Friday, August 07, 2020 12:00:00 AM
    }
  TimeOfDay =
    class TimeSpan
    {
      Ticks = 435031592302
      Days = 0
      Hours = 12
      Milliseconds = 159
      Minutes = 5
      Seconds = 3
      TotalDays = 0.503508787386574
      TotalHours = 12.0842108972778
      TotalMilliseconds = 43503159.2302
      TotalMinutes = 725.052653836667
      TotalSeconds = 43503.1592302
    }
}

Format-List

在此示例中，我们使用计算属性更改 的 Get-ChildItem输出的名称和格式。

Get-ChildItem *.json -File |
  Format-List Fullname,
              @{
                 name='Modified'
                 expression={$_.LastWriteTime}
                 formatstring='O'
              },
              @{
                 name='Size'
                 expression={$_.Length/1KB}
                 formatstring='N2'
              }

FullName : C:\Git\PS-Docs\PowerShell-Docs\.markdownlint.json
Modified : 2020-07-23T10:26:28.4092457-07:00
Size     : 2.40

FullName : C:\Git\PS-Docs\PowerShell-Docs\.openpublishing.publish.config.json
Modified : 2020-07-23T10:26:28.4092457-07:00
Size     : 2.25

FullName : C:\Git\PS-Docs\PowerShell-Docs\.openpublishing.redirection.json
Modified : 2020-07-27T13:05:24.3887629-07:00
Size     : 324.60

Format-Table

在此示例中，计算属性添加一个 Type 属性，该属性用于按内容类型对文件进行分类。

Get-ChildItem -File |
  Sort-Object extension |
    Format-Table Name, Length -GroupBy @{
      name='Type'
      expression={
        switch ($_.extension) {
          '.md'   {'Content'}
          ''      {'Metacontent'}
          '.ps1'  {'Automation'}
          '.yml'  {'Automation'}
          default {'Configuration'}
        }
      }
    }

   Type: Metacontent

Name              Length
----              ------
ThirdPartyNotices   1229
LICENSE-CODE        1106
LICENSE            19047

   Type: Configuration

Name                                Length
----                                ------
.editorconfig                          183
.gitattributes                         419
.gitignore                             228
.markdownlint.json                    2456
.openpublishing.publish.config.json   2306
.openpublishing.redirection.json    332394
.localization-config                   232

   Type: Content

Name            Length
----            ------
README.md         3355
CONTRIBUTING.md    247

   Type: Automation

Name                      Length
----                      ------
.openpublishing.build.ps1    796
build.ps1                   7495
ci.yml                       645
ci-steps.yml                2035
daily.yml                   1271

Format-Wide

cmdlet Format-Wide 允许将集合中对象的一个属性的值显示为多列列表。

对于此示例，我们希望将文件名和大小 (（以千字节为单位）) 查看为宽列表。 由于 Format-Wide 不显示多个属性，因此我们使用计算属性将两个属性的值合并为单个值。

Get-ChildItem -File |
  Format-Wide -Property @{e={'{0} ({1:N2}kb)' -f $_.name,($_.length/1kb)}}

.editorconfig (0.18kb)                          .gitattributes (0.41kb)
.gitignore (0.22kb)                             .localization-config (0.23kb)
.markdownlint.json (2.40kb)                     .openpublishing.build.ps1 (0.78kb)
.openpublishing.publish.config.json (2.25kb)    .openpublishing.redirection.json (324.60kb)
build.ps1 (7.32kb)                              ci.yml (0.63kb)
ci-steps.yml (1.99kb)                           CONTRIBUTING.md (0.24kb)
daily.yml (1.24kb)                              LICENSE (18.60kb)
LICENSE-CODE (1.08kb)                           README.md (3.28kb)
ThirdPartyNotices (1.20kb)

Group-Object

该 Group-Object cmdlet 根据指定属性的值在组中显示对象。 在此示例中， 计算属性计算每个内容类型的文件数。

Get-ChildItem -File |
  Sort-Object extension |
    Group-Object -NoElement -Property @{
      expression={
        switch ($_.extension) {
          '.md'   {'Content'}
          ''      {'Metacontent'}
          '.ps1'  {'Automation'}
          '.yml'  {'Automation'}
          default {'Configuration'}
        }
      }
    }

Count Name
----- ----
    5 Automation
    7 Configuration
    2 Content
    3 Metacontent

Measure-Object

cmdlet Measure-Object 计算 对象的数值属性。 在此示例中，我们使用计算属性来获取介于 1 到 10 之间的数字的计数 (Sum) ，这些数字被 3 均匀地整除。

1..10 | Measure-Object -Property {($_ % 3) -eq 0} -Sum

Count             : 10
Average           :
Sum               : 3
Maximum           :
Minimum           :
StandardDeviation :
Property          : ($_ % 3) -eq 0

注意

与其他 cmdlet 不同， Measure-Object 不接受计算属性的哈希表。 必须使用脚本块。

Select-Object

可以使用计算属性通过 cmdlet 向对象输出 Select-Object 添加其他成员。 在此示例中，我们将列出以字母 C开头的 PowerShell 别名。 使用 Select-Object输出别名、它映射到的 cmdlet 以及为 cmdlet 定义的参数数的计数。 使用计算属性，我们可以创建 ParameterCount 属性。

$aliases = Get-Alias c* |
  Select-Object Name,
                Definition,
                @{
                    name='ParameterCount'
                    expr={$_.Parameters.Keys.Count}
                }
$aliases | Get-Member
$aliases

   TypeName: Selected.System.Management.Automation.AliasInfo

Name           MemberType   Definition
----           ----------   ----------
Equals         Method       bool Equals(System.Object obj)
GetHashCode    Method       int GetHashCode()
GetType        Method       type GetType()
ToString       Method       string ToString()
Definition     NoteProperty string Definition=Get-Content
Name           NoteProperty string Name=cat
ParameterCount NoteProperty System.Int32 ParameterCount=21

Name    Definition         ParameterCount
----    ----------         --------------
cat     Get-Content                    21
cd      Set-Location                   15
cdd     Push-MyLocation                 1
chdir   Set-Location                   15
clc     Clear-Content                  20
clear   Clear-Host                      0
clhy    Clear-History                  17
cli     Clear-Item                     20
clp     Clear-ItemProperty             22
cls     Clear-Host                      0
clv     Clear-Variable                 19
cnsn    Connect-PSSession              29
compare Compare-Object                 20
copy    Copy-Item                      24
cp      Copy-Item                      24
cpi     Copy-Item                      24
cpp     Copy-ItemProperty              23
cvpa    Convert-Path                   13

Sort-Object

使用计算属性，可以按每个属性的不同顺序对数据进行排序。 此示例按 日期的升序对 CSV 文件中的数据进行排序。 但在每个日期内，它按 UnitsSold 按降序对行进行排序。

Import-Csv C:\temp\sales-data.csv |
  Sort-Object Date, @{expr={$_.UnitsSold}; desc=$true}, Salesperson  |
    Select-Object Date, Salesperson, UnitsSold

Date       Salesperson UnitsSold
----       ----------- ---------
2020-08-01 Sally       3
2020-08-01 Anne        2
2020-08-01 Fred        1
2020-08-02 Anne        6
2020-08-02 Fred        2
2020-08-02 Sally       0
2020-08-03 Anne        5
2020-08-03 Sally       3
2020-08-03 Fred        1
2020-08-04 Anne        2
2020-08-04 Fred        2
2020-08-04 Sally       2

备注

  • 可以直接将表达式 脚本块指定为参数，而不是将其指定为哈希表中的 Expression 条目。 例如：

    '1', '10', '2' | Sort-Object { [int] $_ }

    此示例适用于不需要 (或支持) 通过 Name 键命名属性的 cmdlet，例如 Sort-Object、 Group-Object和 Measure-Object。

    对于支持命名属性的 cmdlet，脚本块将转换为字符串，并在输出中用作属性的名称。

  • Expression 脚本块在 子 作用域中运行，这意味着无法直接修改调用方变量。

  • 管道逻辑应用于脚本块的输出 Expression 。 这意味着输出单元素数组会导致该数组解包。

  • 对于大多数 cmdlet，表达式脚本块中的错误会被静默忽略。 对于 Sort-Object，语句终止和脚本终止错误是 输出 ，但它们不会终止语句。

另请参阅