如何在Powershell中转换为JSON时排除非值对象属性

时间:2015-10-09 12:55:05

标签: json powershell powershell-v4.0

我有一段可行的代码,但我想知道是否有更好的方法。到目前为止我找不到任何相关内容。以下是事实:

  • 我有一个有n个属性的对象。
  • 我想使用(ConvertTo-Json)将此对象转换为JSON。
  • 我不想在JSON中包含那些没有被重视的对象属性。
  

构建对象(不是很重要):

$object = New-Object PSObject
Add-Member -InputObject $object -MemberType NoteProperty -Name TableName -Value "MyTable"
Add-Member -InputObject $object -MemberType NoteProperty -Name Description -Value "Lorem ipsum dolor.."
Add-Member -InputObject $object -MemberType NoteProperty -Name AppArea -Value "UserMgmt"
Add-Member -InputObject $object -MemberType NoteProperty -Name InitialVersionCode -Value ""
  

我需要改进的行(过滤掉非值属性而不是将它们包含在JSON中)

# So I want to 'keep' and deliver to the JSON only the properties that are valued (first 3).
$object | select -Property TableName, Description, AppArea, InitialVersion | ConvertTo-Json
  

这条线提供了什么:

Results:
{
    "TableName":  "MyTable",
    "Description":  "Lorem ipsum dolor..",
    "AppArea":  "UserMgmt",
    "InitialVersion":  null
}

What I want to obtain:
{
    "TableName":  "MyTable",
    "Description":  "Lorem ipsum dolor..",
    "AppArea":  "UserMgmt"
}
  

我尝试过并且有效,但我不喜欢它,因为我有更多属性需要处理:

$JSON = New-Object PSObject

if ($object.TableName){
   Add-Member -InputObject $JSON -MemberType NoteProperty -Name TableName -Value $object.TableName
}

if ($object.Description){
   Add-Member -InputObject $JSON -MemberType NoteProperty -Name Description -Value $object.Description
}

if ($object.AppArea){
   Add-Member -InputObject $JSON -MemberType NoteProperty -Name AppArea -Value $object.AppArea
}

if ($object.InitialVersionCode){
   Add-Member -InputObject $JSON -MemberType NoteProperty -Name InitialVersionCode -Value $object.InitialVersionCode
}

$JSON | ConvertTo-Json

4 个答案:

答案 0 :(得分:10)

这样的东西?

$object = New-Object PSObject

Add-Member -InputObject $object -MemberType NoteProperty -Name TableName -Value "MyTable"
Add-Member -InputObject $object -MemberType NoteProperty -Name Description -Value "Lorem ipsum dolor.."
Add-Member -InputObject $object -MemberType NoteProperty -Name AppArea -Value "UserMgmt"
Add-Member -InputObject $object -MemberType NoteProperty -Name InitialVersionCode -Value ""

# Iterate over objects
$object | ForEach-Object {
    # Get array of names of object properties that can be cast to boolean TRUE
    # PSObject.Properties - https://msdn.microsoft.com/en-us/library/system.management.automation.psobject.properties.aspx
    $NonEmptyProperties = $_.psobject.Properties | Where-Object {$_.Value} | Select-Object -ExpandProperty Name

    # Convert object to JSON with only non-empty properties
    $_ | Select-Object -Property $NonEmptyProperties | ConvertTo-Json
}

结果:

{
    "TableName":  "MyTable",
    "Description":  "Lorem ipsum dolor..",
    "AppArea":  "UserMgmt"
}

答案 1 :(得分:3)

beatcracker's helpful answer提供了有效的解决方案;让我用一个利用PSv4 +功能的简化版本对其进行补充:

# Sample input object
$object = [pscustomobject] @{
  TableName = 'MyTable'
  Description = 'Lorem ipsum dolor...'
  AppArea = 'UserMgmt'
  InitialVersionCode = $null
}

# Start with the list of candidate properties.
# For simplicity we target *all* properties of input object $obj
# but you could start with an explicit list as wellL
#   $candidateProps = 'TableName', 'Description', 'AppArea', 'InitialVersionCode'
$candidateProps = $object.psobject.properties.Name

# Create the filtered list of those properties whose value is non-$null
# The .Where() method is a PSv4+ feature.
$nonNullProps = $candidateProps.Where({ $null -ne $object.$_ })

# Extract the list of non-null properties directly from the input object
# and convert to JSON.
$object | Select-Object $nonNullProps | ConvertTo-Json

答案 2 :(得分:1)

为此,我的个人资料中具有以下功能。优点:我可以通过管道将对象集合传递给它,并从管道上的所有对象中删除空值。

beneficiary_id

一些用法示例:

Function Remove-Null {
    [cmdletbinding()]
    param(
        # Object to remove null values from
        [parameter(ValueFromPipeline,Mandatory)]
        [object[]]$InputObject,
        #By default, remove empty strings (""), specify -LeaveEmptyStrings to leave them.
        [switch]$LeaveEmptyStrings
    )
    process {
        foreach ($obj in $InputObject) {
            $AllProperties = $obj.psobject.properties.Name
            $NonNulls = $AllProperties |
                where-object {$null -ne $obj.$PSItem} |
                where-object {$LeaveEmptyStrings.IsPresent -or -not [string]::IsNullOrEmpty($obj.$PSItem)}
            $obj | Select-Object -Property $NonNulls
        }
    }
}

答案 3 :(得分:1)

我制作了自己的batmanama's answer修改版,它接受一个附加参数,使您可以删除该参数中存在的列表中也存在的元素。 例如:

Get-CimInstance -ClassName Win32_UserProfile | 
Remove-Null -AlsoRemove 'Win32_FolderRedirectionHealth' | Format-Table

我已经发布了gist版本,其中包括PowerShell文档。

Function Remove-Null {
    [CmdletBinding()]
    Param(
        # Object from which to remove the null values.
        [Parameter(ValueFromPipeline,Mandatory)]
        $InputObject,
        # Instead of also removing values that are empty strings, include them
        # in the output.
        [Switch]$LeaveEmptyStrings,
        # Additional entries to remove, which are either present in the
        # properties list as an object or as a string representation of the
        # object.
        # I.e. $item.ToString().
        [Object[]]$AlsoRemove = @()
    )
    Process {
        # Iterate InputObject in case input was passed as an array
        ForEach ($obj in $InputObject) {
            $obj | Select-Object -Property (
                $obj.PSObject.Properties.Name | Where-Object {
                    -not (
                        # If prop is null, Exclude
                        $null -eq $obj.$_ -or
                        # If -LeaveEmptyStrings is specified and the property
                        # is an empty string, Exclude
                        ($LeaveEmptyStrings.IsPresent -and
                            [string]::IsNullOrEmpty($obj.$_)) -or
                        # If AlsoRemove contains the property, Exclude
                        $AlsoRemove.Contains($obj.$_) -or
                        # If AlsoRemove contains the string representation of
                        # the property, Exclude
                        $AlsoRemove.Contains($obj.$_.ToString())
                    )
                }
            )
        }
    }
}

请注意,此处的流程块会自动迭代管道对象,因此,仅当将一项显式传递到数组中时,例如将其包装在单个元素数组,$array中,ForEach才会多次迭代。 —或作为直接参数提供时,例如Remove-Null -InputObject $(Get-ChildItem)

值得一提的是,我的和batmanama的函数都将从 each 单个对象中删除这些属性。这样便可以正确利用PowerShell管道。此外,这意味着,如果InputObject中的任何对象具有不匹配的属性(例如,它们是 not null),则输出表仍将显示该属性,即使它已从其他 did 匹配项中删除了这些属性。

下面是一个显示该行为的简单示例:

@([pscustomobject]@{Number=1;Bool=$true};
[pscustomobject]@{Number=2;Bool=$false},
[pscustomobject]@{Number=3;Bool=$true},
[pscustomobject]@{Number=4;Bool=$false}) | Remove-Null -AlsoRemove $false

Number Bool
------ ----
     1 True
     2
     3 True
     4