Javaでの2つのHashMapの比較

投稿日: 2019-10-19 2022-10-17
タグ: Java, Java Collections, Java Map

1. 概要

このチュートリアルでは、Javaの2つのハッシュマップを比較するさまざまな方法を検討します。

2つのHashMapsが類似しているかどうかを確認する複数の方法について説明します。また、Java 8 Stream APIとGuavaを使用して、さまざまなHashMaps間の詳細な違いを取得します。

**2. Map.equals（）を使用する**

まず、 Map.equals（）を使用して、2つのHashMapsに同じエントリがあるかどうかを確認します。

@Test
public void whenCompareTwoHashMapsUsingEquals_thenSuccess() {
    Map<String, String> asiaCapital1 = new HashMap<String, String>();
    asiaCapital1.put("Japan", "Tokyo");
    asiaCapital1.put("South Korea", "Seoul");

    Map<String, String> asiaCapital2 = new HashMap<String, String>();
    asiaCapital2.put("South Korea", "Seoul");
    asiaCapital2.put("Japan", "Tokyo");

    Map<String, String> asiaCapital3 = new HashMap<String, String>();
    asiaCapital3.put("Japan", "Tokyo");
    asiaCapital3.put("China", "Beijing");

    assertTrue(asiaCapital1.equals(asiaCapital2));
    assertFalse(asiaCapital1.equals(asiaCapital3));
}

ここでは、3つの HashMap オブジェクトを作成し、エントリを追加しています。次に、 Map.equals（）を使用して、2つのHashMapsに同じエントリがあるかどうかを確認します。

Map.equals（）が機能する方法は、 Object.equals（）メソッド。を使用してキーと値を比較することです。キーオブジェクトと値オブジェクトの両方がequals（）を適切に実装している場合にのみ機能します。

たとえば、 Map.equals（）は、値の型が配列の場合は機能しません。配列の equals（）メソッドは、配列の内容ではなくIDを比較するためです。

@Test
public void whenCompareTwoHashMapsWithArrayValuesUsingEquals_thenFail() {
    Map<String, String[]> asiaCity1 = new HashMap<String, String[]>();
    asiaCity1.put("Japan", new String[] { "Tokyo", "Osaka" });
    asiaCity1.put("South Korea", new String[] { "Seoul", "Busan" });

    Map<String, String[]> asiaCity2 = new HashMap<String, String[]>();
    asiaCity2.put("South Korea", new String[] { "Seoul", "Busan" });
    asiaCity2.put("Japan", new String[] { "Tokyo", "Osaka" });

    assertFalse(asiaCity1.equals(asiaCity2));
}

**3. Java StreamAPIを使用する**

Java 8 Stream APIを使用して、HashMapsを比較する独自のメソッドを実装することもできます。

private boolean areEqual(Map<String, String> first, Map<String, String> second) {
    if (first.size() != second.size()) {
        return false;
    }

    return first.entrySet().stream()
      .allMatch(e -> e.getValue().equals(second.get(e.getKey())));
}

簡単にするために、 は同じ（） 比較に使用できるメソッド HashMap オブジェクト：

@Test
public void whenCompareTwoHashMapsUsingStreamAPI_thenSuccess() {
    assertTrue(areEqual(asiaCapital1, asiaCapital2));
    assertFalse(areEqual(asiaCapital1, asiaCapital3));
}

ただし、 Arrays.equals（）を使用して2つの配列を比較することにより、独自のメソッド areEqualWithArrayValue（）をカスタマイズして配列値を処理することもできます。

private boolean areEqualWithArrayValue(Map<String, String[]> first, Map<String, String[]> second) {
    if (first.size() != second.size()) {
        return false;
    }

    return first.entrySet().stream()
      .allMatch(e -> Arrays.equals(e.getValue(), second.get(e.getKey())));
}

Map.equals（）とは異なり、独自のメソッドはHashMapsを配列値と正常に比較します。

@Test
public void whenCompareTwoHashMapsWithArrayValuesUsingStreamAPI_thenSuccess() {
    assertTrue(areEqualWithArrayValue(asiaCity1, asiaCity2)); 
    assertFalse(areEqualWithArrayValue(asiaCity1, asiaCity3));
}

**4. HashMapのキーと値の比較**

次に、2つのHashMapキーとそれに対応する値を比較する方法を見てみましょう。

**4.1. HashMapキーの比較**

まず、 KeySet（）を比較するだけで、2つのHashMapsが同じキーを持っているかどうかを確認できます。

@Test
public void whenCompareTwoHashMapKeys_thenSuccess() {
    assertTrue(asiaCapital1.keySet().equals(asiaCapital2.keySet())); 
    assertFalse(asiaCapital1.keySet().equals(asiaCapital3.keySet()));
}

**4.2. HashMap値の比較**

次に、HashMapの値を1つずつ比較する方法を見ていきます。

Stream APIを使用して、両方のHashMapsで同じ値を持つキーを確認する簡単なメソッドを実装します。

private Map<String, Boolean> areEqualKeyValues(Map<String, String> first, Map<String, String> second) {
    return first.entrySet().stream()
      .collect(Collectors.toMap(e -> e.getKey(), 
        e -> e.getValue().equals(second.get(e.getKey()))));
}

これで、 areEqualKeyValues（）を使用して2つの異なる HashMaps を比較し、どのキーが同じ値を持ち、どのキーが異なる値を持つかを詳細に確認できます。

@Test
public void whenCompareTwoHashMapKeyValuesUsingStreamAPI_thenSuccess() {
    Map<String, String> asiaCapital3 = new HashMap<String, String>();
    asiaCapital3.put("Japan", "Tokyo");
    asiaCapital3.put("South Korea", "Seoul");
    asiaCapital3.put("China", "Beijing");

    Map<String, String> asiaCapital4 = new HashMap<String, String>();
    asiaCapital4.put("South Korea", "Seoul");
    asiaCapital4.put("Japan", "Osaka");
    asiaCapital4.put("China", "Beijing");

    Map<String, Boolean> result = areEqualKeyValues(asiaCapital3, asiaCapital4);

    assertEquals(3, result.size());
    assertThat(result, hasEntry("Japan", false));
    assertThat(result, hasEntry("South Korea", true));
    assertThat(result, hasEntry("China", true));
}

5. Guavaを使用したマップの違い

最後に、 Guava Maps.difference（）。を使用して2つのHashMap間の詳細な違いを取得する方法を説明します。

このメソッドは、マップ間の違いを分析するためのいくつかの便利なメソッドを持つMapDifferenceオブジェクトを返します。これらのいくつかを見てみましょう。

5.1. MapDifference.entriesDiffering（）

まず、MapDifference.entriesDiffering（）を使用して、各HashMapで異なる値を持つ共通キーを取得します。

@Test
public void givenDifferentMaps_whenGetDiffUsingGuava_thenSuccess() {
    Map<String, String> asia1 = new HashMap<String, String>();
    asia1.put("Japan", "Tokyo");
    asia1.put("South Korea", "Seoul");
    asia1.put("India", "New Delhi");

    Map<String, String> asia2 = new HashMap<String, String>();
    asia2.put("Japan", "Tokyo");
    asia2.put("China", "Beijing");
    asia2.put("India", "Delhi");

    MapDifference<String, String> diff = Maps.difference(asia1, asia2);
    Map<String, ValueDifference<String>> entriesDiffering = diff.entriesDiffering();

    assertFalse(diff.areEqual());
    assertEquals(1, entriesDiffering.size());
    assertThat(entriesDiffering, hasKey("India"));
    assertEquals("New Delhi", entriesDiffering.get("India").leftValue());
    assertEquals("Delhi", entriesDiffering.get("India").rightValue());
}

itemsDiffering（）メソッドは、共通キーのセットとValueDifferenceオブジェクトを値のセットとして含む新しいMapを返します。

各ValueDifferenceオブジェクトには、2つのマップの値をそれぞれ返すleftValue（）メソッドとrightValue（）メソッドがあります。

5.2. MapDifference.entriesOnlyOnRight（）および MapDifference.entriesOnlyOnLeft（）

次に、 MapDifference.entriesOnlyOnRight（）および MapDifference.entriesOnlyOnLeft（）：を使用して、1つのHashMapにのみ存在するエントリを取得できます。

@Test
public void givenDifferentMaps_whenGetEntriesOnOneSideUsingGuava_thenSuccess() {
    MapDifference<String, String> diff = Maps.difference(asia1, asia2);
    Map<String, String> entriesOnlyOnRight = diff.entriesOnlyOnRight();
    Map<String, String> entriesOnlyOnLeft = diff.entriesOnlyOnLeft();
    
    assertEquals(1, entriesOnlyOnRight.size());
    assertEquals(1, entriesOnlyOnLeft.size());
    assertThat(entriesOnlyOnRight, hasEntry("China", "Beijing"));
    assertThat(entriesOnlyOnLeft, hasEntry("South Korea", "Seoul"));
}

5.3. MapDifference.entriesInCommon（）

次に、 MapDifference.entriesInCommon（）：を使用して共通エントリを取得します

@Test
public void givenDifferentMaps_whenGetCommonEntriesUsingGuava_thenSuccess() {
    MapDifference<String, String> diff = Maps.difference(asia1, asia2);
    Map<String, String> entriesInCommon = diff.entriesInCommon();

    assertEquals(1, entriesInCommon.size());
    assertThat(entriesInCommon, hasEntry("Japan", "Tokyo"));
}

5.4. Maps.difference（）の動作のカスタマイズ

Maps.difference（）はデフォルトで equals（）と hashCode（）を使用してエントリを比較するため、実装されていないオブジェクトでは機能しませんそれらを適切に：

@Test
public void givenSimilarMapsWithArrayValue_whenCompareUsingGuava_thenFail() {
    MapDifference<String, String[]> diff = Maps.difference(asiaCity1, asiaCity2);
    assertFalse(diff.areEqual());
}

ただし、 Equivalence を使用して、比較に使用する方法をカスタマイズできます。

たとえば、タイプ String[]のEquivalentを定義して、HashMapsのString[]値を好きなように比較します。

@Test
public void givenSimilarMapsWithArrayValue_whenCompareUsingGuavaEquivalence_thenSuccess() {
    Equivalence<String[]> eq = new Equivalence<String[]>() {
        @Override
        protected boolean doEquivalent(String[] a, String[] b) {
            return Arrays.equals(a, b);
        }

        @Override
        protected int doHash(String[] value) {
            return value.hashCode();
        }
    };

    MapDifference<String, String[]> diff = Maps.difference(asiaCity1, asiaCity2, eq);
    assertTrue(diff.areEqual());

    diff = Maps.difference(asiaCity1, asiaCity3, eq); 
    assertFalse(diff.areEqual());
}

6. 結論

この記事では、JavaでHashMapsを比較するさまざまな方法について説明しました。 2つのHashMapsが等しいかどうかを確認する複数の方法と、詳細な違いを取得する方法も学びました。

完全なソースコードは、GitHubでから入手できます。

getdocs

13036