Compare-Object

Porównuje dwa zestawy obiektów.

Składnia

Compare-Object
       [-ReferenceObject] <PSObject[]>
       [-DifferenceObject] <PSObject[]>
       [-SyncWindow <Int32>]
       [-Property <Object[]>]
       [-ExcludeDifferent]
       [-IncludeEqual]
       [-PassThru]
       [-Culture <String>]
       [-CaseSensitive]
       [<CommonParameters>]

Opis

Polecenie Compare-Object cmdlet porównuje dwa zestawy obiektów. Jeden zestaw obiektów jest odwołaniem, a drugi zestaw obiektów jest różnicą.

Compare-Object sprawdza dostępne metody porównywania całego obiektu. Jeśli nie może znaleźć odpowiedniej metody, wywołuje metody ToString() obiektów wejściowych i porównuje wyniki ciągu. Do porównania można podać co najmniej jedną właściwości do użycia. Po podaniu właściwości polecenie cmdlet porównuje tylko wartości tych właściwości.

Wynik porównania wskazuje, czy wartość właściwości pojawiła się tylko w obiekcie odwołania (<=), czy tylko w obiekcie różnicy (=>). Jeśli jest używany parametr IncludeEqual, (==) wskazuje, że wartość znajduje się w obu obiektach.

Jeśli odwołanie lub obiekty różnicy mają wartość null ($null), Compare-Object generuje błąd zakończenia.

W niektórych przykładach użyto fragmentowania, aby zmniejszyć długość wiersza przykładów kodu. Aby uzyskać więcej informacji, zobacz about_Splatting.

Przykłady

Przykład 1 — porównanie zawartości dwóch plików tekstowych

W tym przykładzie porównana jest zawartość dwóch plików tekstowych. W przykładzie użyto następujących dwóch plików tekstowych z każdą wartością w osobnym wierszu.

  • Testfile1.txt zawiera wartości: pies, wiewiórka i ptak.
  • Testfile2.txt zawiera wartości: kot, ptak i racoon.

Dane wyjściowe zawierają tylko wiersze, które różnią się między plikami. Testfile1.txtjest obiektem referencyjnym (<=) i Testfile2.txtjest obiektem różnicy (=>). Wiersze z zawartością wyświetlaną w obu plikach nie są wyświetlane.

Compare-Object -ReferenceObject (Get-Content -Path C:\Test\Testfile1.txt) -DifferenceObject (Get-Content -Path C:\Test\Testfile2.txt)

InputObject SideIndicator
----------- -------------
cat         =>
racoon      =>
dog         <=
squirrel    <=

Przykład 2 — porównywanie poszczególnych wierszy zawartości i wykluczanie różnic

W tym przykładzie użyto parametru ExcludeDifferent do porównania każdego wiersza zawartości w dwóch plikach tekstowych.

Od programu PowerShell 7.1, w przypadku korzystania z parametru ExcludeDifferent funkcja IncludeEqual jest wnioskowana, a dane wyjściowe zawierają tylko wiersze zawarte w obu plikach, jak pokazano w module SideIndicator (==).

$objects = @{
  ReferenceObject = (Get-Content -Path C:\Test\Testfile1.txt)
  DifferenceObject = (Get-Content -Path C:\Test\Testfile2.txt)
}
Compare-Object @objects -ExcludeDifferent

InputObject SideIndicator
----------- -------------
bird        ==

Przykład 3 — wyświetlanie różnicy w przypadku używania parametru PassThru

Compare-Object Zwykle zwraca typ PSCustomObject o następujących właściwościach:

  • Porównywany obiekt InputObject
  • Właściwość SideIndicator przedstawiająca obiekt wejściowy, do którego należy dane wyjściowe

Jeśli używasz parametru PassThru, typ obiektu nie zostanie zmieniony, ale zwrócone wystąpienie obiektu ma dodany atrybut NoteProperty o nazwie SideIndicator. Funkcja SideIndicator pokazuje, do którego obiektu wejściowego należy dane wyjściowe.

W poniższych przykładach przedstawiono różne typy danych wyjściowych.

$a = $True
Compare-Object -IncludeEqual $a $a
(Compare-Object -IncludeEqual $a $a) | Get-Member

InputObject SideIndicator
----------- -------------
       True ==

   TypeName: System.Management.Automation.PSCustomObject
Name          MemberType   Definition
----          ----------   ----------
Equals        Method       bool Equals(System.Object obj)
GetHashCode   Method       int GetHashCode()
GetType       Method       type GetType()
ToString      Method       string ToString()
InputObject   NoteProperty System.Boolean InputObject=True
SideIndicator NoteProperty string SideIndicator===

Compare-Object -IncludeEqual $a $a -PassThru
(Compare-Object -IncludeEqual $a $a -PassThru) | Get-Member

True

   TypeName: System.Boolean
Name          MemberType   Definition
----          ----------   ----------
CompareTo     Method       int CompareTo(System.Object obj), int CompareTo(bool value), int IComparable.CompareTo(Syst
Equals        Method       bool Equals(System.Object obj), bool Equals(bool obj), bool IEquatable[bool].Equals(bool ot
GetHashCode   Method       int GetHashCode()
GetType       Method       type GetType()
GetTypeCode   Method       System.TypeCode GetTypeCode(), System.TypeCode IConvertible.GetTypeCode()
ToBoolean     Method       bool IConvertible.ToBoolean(System.IFormatProvider provider)
ToByte        Method       byte IConvertible.ToByte(System.IFormatProvider provider)
ToChar        Method       char IConvertible.ToChar(System.IFormatProvider provider)
ToDateTime    Method       datetime IConvertible.ToDateTime(System.IFormatProvider provider)
ToDecimal     Method       decimal IConvertible.ToDecimal(System.IFormatProvider provider)
ToDouble      Method       double IConvertible.ToDouble(System.IFormatProvider provider)
ToInt16       Method       short IConvertible.ToInt16(System.IFormatProvider provider)
ToInt32       Method       int IConvertible.ToInt32(System.IFormatProvider provider)
ToInt64       Method       long IConvertible.ToInt64(System.IFormatProvider provider)
ToSByte       Method       sbyte IConvertible.ToSByte(System.IFormatProvider provider)
ToSingle      Method       float IConvertible.ToSingle(System.IFormatProvider provider)
ToString      Method       string ToString(), string ToString(System.IFormatProvider provider), string IConvertible.To
ToType        Method       System.Object IConvertible.ToType(type conversionType, System.IFormatProvider provider)
ToUInt16      Method       ushort IConvertible.ToUInt16(System.IFormatProvider provider)
ToUInt32      Method       uint IConvertible.ToUInt32(System.IFormatProvider provider)
ToUInt64      Method       ulong IConvertible.ToUInt64(System.IFormatProvider provider)
TryFormat     Method       bool TryFormat(System.Span[char] destination, [ref] int charsWritten)
SideIndicator NoteProperty string SideIndicator===

W przypadku używania metody PassThru zwracany jest oryginalny typ obiektu (System.Boolean). Zwróć uwagę, że dane wyjściowe wyświetlane domyślnie w obiektach System.Boolean nie wyświetlały właściwości SideIndicator . Zwrócony obiekt System.Boolean ma jednak dodany obiekt NoteProperty.

Przykład 4 — porównanie dwóch prostych obiektów przy użyciu właściwości

W tym przykładzie porównamy dwa różne ciągi o tej samej długości.

Compare-Object -ReferenceObject 'abc' -DifferenceObject 'xyz' -Property Length -IncludeEqual

Length SideIndicator
------ -------------
     3 ==

Przykład 5 — porównywanie złożonych obiektów przy użyciu właściwości

W tym przykładzie pokazano zachowanie podczas porównywania złożonych obiektów. W tym przykładzie przechowujemy dwa różne obiekty procesów dla różnych wystąpień programu PowerShell. Obie zmienne zawierają obiekty procesu o tej samej nazwie. Gdy obiekty są porównywane bez określania parametru Property , polecenie cmdlet uważa, że obiekty są równe. Zwróć uwagę, że wartość obiektu InputObject jest taka sama jak wynik metody ToString(). Ponieważ klasa System.Diagnostics.Process nie ma interfejsu IComparable, polecenie cmdlet konwertuje obiekty na ciągi, a następnie porównuje wyniki.

PS> Get-Process pwsh

 NPM(K)    PM(M)      WS(M)     CPU(s)      Id  SI ProcessName
 ------    -----      -----     ------      --  -- -----------
    101   123.32     139.10      35.81   11168   1 pwsh
     89   107.55      66.97      11.44   17600   1 pwsh

PS> $a = Get-Process -Id 11168
PS> $b = Get-Process -Id 17600
PS> $a.ToString()
System.Diagnostics.Process (pwsh)
PS> $b.ToString()
System.Diagnostics.Process (pwsh)
PS> Compare-Object $a $b -IncludeEqual

InputObject                       SideIndicator
-----------                       -------------
System.Diagnostics.Process (pwsh) ==

PS> Compare-Object $a $b -Property ProcessName, Id, CPU

ProcessName    Id       CPU SideIndicator
-----------    --       --- -------------
pwsh        17600   11.4375 =>
pwsh        11168 36.203125 <=

Podczas określania właściwości do porównania polecenie cmdlet pokazuje różnice.

Przykład 6 — porównywanie złożonych obiektów implementujących IComparable

Jeśli obiekt implementuje interfejs IComparable, polecenie cmdlet wyszukuje sposoby porównywania obiektów. Jeśli obiekty są różnymi typami, obiekt Difference jest konwertowany na typ obiektu ReferenceObject , a następnie porównywany.

W tym przykładzie porównujemy ciąg z obiektem TimeSpan . W pierwszym przypadku ciąg jest konwertowany na wartość TimeSpan , więc obiekty są równe.

Compare-Object ([TimeSpan]"0:0:1") "0:0:1" -IncludeEqual

InputObject SideIndicator
----------- -------------
00:00:01    ==

Compare-Object "0:0:1" ([TimeSpan]"0:0:1")

InputObject SideIndicator
----------- -------------
00:00:01    =>
0:0:1       <=

W drugim przypadku funkcja TimeSpan jest konwertowana na ciąg, aby obiekt był inny.

Parametry

-CaseSensitive

Wskazuje, że w porównaniach powinna być uwzględniana wielkość liter.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Culture

Określa kulturę do użycia na potrzeby porównań.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DifferenceObject

Określa obiekty, które są porównywane z obiektami referencyjnymi .

Type:PSObject[]
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-ExcludeDifferent

Wskazuje, że to polecenie cmdlet wyświetla tylko cechy porównywanych obiektów, które są równe. Różnice między obiektami są odrzucane.

Użyj opcji ExcludeDifferent z właściwością IncludeEqual, aby wyświetlić tylko wiersze pasujące między odwołaniem a obiektami różnicy.

Jeśli wartość ExcludeDifferent jest określona bez elementu IncludeEqual, nie ma danych wyjściowych.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IncludeEqual

IncludeEqual wyświetla dopasowania między odwołaniem a obiektami różnicy.

Domyślnie dane wyjściowe zawierają również różnice między odwołaniami i obiektami różnicy .

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Jeśli używasz parametru PassThru , Compare-Object pomija otokę PSCustomObject wokół porównywanych obiektów i zwraca różne obiekty bez zmian.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Property

Określa tablicę właściwości odwołania i obiektów różnic do porównania.

Wartość parametru Property może być nową właściwością obliczeniową. Właściwość obliczeniowa może być blokiem skryptu lub tabelą skrótów. Prawidłowe pary klucz-wartość to:

  • Wyrażenie — <string> lub <script block>

Aby uzyskać więcej informacji, zobacz about_Calculated_Properties.

Type:Object[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ReferenceObject

Określa tablicę obiektów używanych jako odwołanie do porównania.

Type:PSObject[]
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-SyncWindow

Określa liczbę sąsiednich obiektów, które Compare-Object sprawdzają podczas wyszukiwania dopasowania w kolekcji obiektów. Compare-Object sprawdza sąsiadujące obiekty, gdy nie znajduje obiektu w tej samej pozycji w kolekcji. Wartość domyślna to [Int32]::MaxValue, co oznacza, że Compare-Object sprawdza całą kolekcję obiektów.

Podczas pracy z dużymi kolekcjami wartość domyślna może nie być wydajna, ale jest dokładna. Określenie mniejszej wartości dla systemu SyncWindow może zwiększyć wydajność, ale może mieć niższą dokładność.

Type:Int32
Position:Named
Default value:[Int32]::MaxValue
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Dane wejściowe

PSObject

Obiekt można wysłać w dół potoku do parametru DifferenceObject .

Dane wyjściowe

None

Domyślnie to polecenie cmdlet nie zwraca żadnych danych wyjściowych, gdy obiekt ReferenceObject i obiekt DifferenceObject są takie same.

PSCustomObject

Gdy obiekty są różne, to polecenie cmdlet opakowuje różne obiekty w otoce PSCustomObject z właściwością SideIndicator , aby odwołać się do różnic.

Jeśli używasz parametru IncludeEqual i obiekty są takie same, polecenie cmdlet zwraca obiekty opakowane w obiekcie PSCustomObject z właściwością SideIndicator ustawioną na ==wartość .

Jeśli używasz parametru PassThru, typ obiektu nie zostanie zmieniony, ale zwrócone wystąpienie obiektu ma dodany atrybut NoteProperty o nazwie SideIndicator. Funkcja SideIndicator pokazuje, do którego obiektu wejściowego należy dane wyjściowe.

Uwagi

Program PowerShell zawiera następujące aliasy dla programu Compare-Object:

  • Windows:
    • compare
    • diff

W przypadku korzystania z parametru PassThru dane wyjściowe wyświetlane w konsoli mogą nie zawierać właściwości SideIndicator . Domyślny widok formatu danych wyjściowych Compare-Object typu obiektu nie zawiera właściwości SideIndicator . Aby uzyskać więcej informacji, zobacz Przykład 3 w tym artykule.