Как исключить не имеющие значения свойства объекта при преобразовании в JSON в Powershell

У меня есть кусок кода, который работает, но я хочу знать, есть ли лучший способ сделать это. Я не мог найти ничего связанного до сих пор. Вот факты:

  • У меня есть объект с n свойствами.
  • Я хочу преобразовать этот объект в JSON, используя (ConvertTo-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
Источник

2 ответа

Решение

Что-то вроде этого?

$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"
}
Источник

Для этого в моем профиле есть следующая функция. Преимущество: я могу передать ему коллекцию объектов и удалить нули из всех объектов в конвейере.

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
        }
    }
}

Некоторые примеры использования:

$AnObject = [pscustomobject]@{
    prop1="data"
    prop2="moredata"
    prop5=3
    propblnk=""
    propnll=$null
}
$AnObject | Remove-Null

prop1 prop2    prop5
----- -----    -----
data  moredata     3

$ObjList =@(
    [PSCustomObject]@{
        notnull = "data"
        more = "sure!"
        done = $null
        another = ""
    },
    [PSCustomObject]@{
        notnull = "data"
        more = $null
        done = $false
        another = $true
    }
)
$objList | Remove-Null | fl #format-list because the default table is misleading

notnull : data
more    : sure!

notnull : data
done    : False
another : True
Источник

полезный ответ beatcracker предлагает эффективное решение; Позвольте мне дополнить его упрощенной версией, которая использует преимущества 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
Источник

Я сделал свою собственную модифицированную версию ответа batmanama, который принимает дополнительный параметр, позволяющий удалять элементы, которые также присутствуют в списке, представленном в этом параметре. Например:

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

Я опубликовал основную версию, включая документацию по 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())
                    )
                }
            )
        }
    }
}

Обратите внимание, что блок процесса здесь автоматически выполняет итерацию объекта конвейера, поэтому ForEach будет выполнять итерацию более одного раза, когда элемент либо явно передается в массив, например, путем его упаковки в массив из одного элемента. ,$array- или когда предоставляется в качестве прямого аргумента, например Remove-Null -InputObject $(Get-ChildItem).

Также стоит отметить, что функции mine и batmanama удаляют эти свойства у каждого отдельного объекта. Вот как он может правильно использовать конвейер PowerShell. Кроме того, это означает, что если какой-либо из объектов в InputObject имеет свойство, которое не соответствует (например, они не равны нулю), в выходной таблице все равно будет отображаться это свойство, даже если она удалила эти свойства из других элементов, которые действительно совпали..

Вот простой пример, демонстрирующий такое поведение:

@([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
Источник
Другие вопросы по тегам