【Java代碼之美】 -- 通過Value獲取Map中的鍵值Key的四種方法

1.簡介

最近在項目中遇到一個EasyExcel中需要取invokeHeadMap中headMap裏面的具體列名的集合Index，就遇到了需要從Map從反向通過Value取對應的Key的值。

通過搜索了網上比較好的文章案例，於是我寫出了下面的Stream流式處理方法代碼：

@Override
public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) {
    if (Objects.equals(context.getCurrentSheet().getSheetName(), DATA_LIST_WHITE_SHEET)) {
        headColIndexSet = headMap.entrySet().stream().filter(entry -> Objects.equals(entry.getValue(), "文檔名稱") ||
                Objects.equals(entry.getValue(), "文檔描述"))
                .map(Map.Entry::getKey).collect(Collectors.toSet());
    }
    if (Objects.equals(context.getCurrentSheet().getSheetName(), DEV_TOOL_WHITE_SHEET)) {
        headColIndexSet = headMap.entrySet().stream().filter(entry -> Objects.equals(entry.getValue(), "文檔名稱") ||
                Objects.equals(entry.getValue(), "文檔描述"))
                .map(Map.Entry::getKey).collect(Collectors.toSet());
    }

    headMap.forEach((key, value) -> headColIndexMap.put(value, key));
}

平常中我們經常也會遇到在Map中通過Value查找出對應的Key的情況，下面總結出比較好的方式是下面四種，排序依次遞進。

 

2.四種方法

2.1.循環法

循環法就是通過遍歷Map裏的Entry，一個個比較，把符合條件的找出來。會有三種情況：

• （1）找到一個值
• （2）找到多個值
• （3）找不到

具體代碼如下：

@Test
public void loop() {
  Map<String, Integer> map = ImmutableMap.of("A", 1, "B", 2, "C", 3, "D", 2);
  //找到一個值
  assertEquals("A", getKeyByLoop(map, 1));
  //找到多個值
  assertEquals(ImmutableSet.of("B", "D"), getKeysByLoop(map, 2));
  //找不到
  assertEquals(null, getKeyByLoop(map, 4));
}

private <K, V> K getKeyByLoop(Map<K, V> map, V value) {
  for (Map.Entry<K, V> entry : map.entrySet()) {
    if (Objects.equals(entry.getValue(), value)) {
      return entry.getKey();
    }
  }
  return null;
}

private <K, V> Set<K> getKeysByLoop(Map<K, V> map, V value) {
  Set<K> set = Sets.newHashSet();
  for (Map.Entry<K, V> entry : map.entrySet()) {
    if (Objects.equals(entry.getValue(), value)) {
      set.add(entry.getKey());
    }
  }
  return set;
}

想特別說的一點是，在對比是否相等的時候，使用了Objects.equals(a, b)方法，而不是用a.equals(b)方法。這樣可以避免空指針異常。

 

2.2.Stream方法

Stream總是在多種集合操作上都能提供優雅直觀的方法，易寫易理解。通過一個過濾器，即可把滿足相等條件的值取出來，代碼如下：

@Test
public void stream() {
  Map<String, Integer> map = ImmutableMap.of("A", 1, "B", 2, "C", 3, "D", 2);
  assertEquals(ImmutableSet.of("B", "D"), getKeysByStream(map, 2));
}

private <K, V> Set<K> getKeysByStream(Map<K, V> map, V value) {
  return map.entrySet()
    .stream()
    .filter(kvEntry -> Objects.equals(kvEntry.getValue(), value))
    .map(Map.Entry::getKey)
    .collect(Collectors.toSet());
}

 

2.3.Guava的BiMap

Google的Guava提供了BiMap這樣一個雙向Map，調用inverse()方法會返回一個反向的關聯的BiMap，然後便可以通過get()方法獲取key值了。

代碼如下：

@Test
public void guava() {
  BiMap<String, Integer> biMap = HashBiMap.create();
  biMap.put("A", 1);
  biMap.put("B", 2);
  biMap.put("C", null);
  biMap.put("D", 4);
  assertEquals("D", biMap.inverse().get(4));
}

需要注意的是，BiMap作爲一個雙向的Map，它不能存儲多對一的關係；而HashMap是可以的。其實很好理解，因爲是雙向的，所以即要滿足Key值的唯一性，也要滿足Value值的唯一性。如果往裏存放同樣的Value，會拋異常：java.lang.IllegalArgumentException: value already present。

2.4.Apache Commons Collections的BidiMap

類似地，Apache Commons Collections也提供了雙向Map的類BidiMap，它也是維持一對一的關係，不能多對一。它提供了getKey(value)方法返回Key值。代碼如下：

@Test
public void apacheCommons() {
  BidiMap<String, Integer> bidiMap = new DualHashBidiMap<>();
  bidiMap.put("A", 1);
  bidiMap.put("B", 2);
  bidiMap.put("C", null);
  bidiMap.put("D", 4);
  assertEquals("D", bidiMap.getKey(4));
}

與Guava的BiMap不同的是，當存放同樣的Value時，它不會拋異常，而是覆蓋原有的數據。

 

3.總結

本文介紹了四種通過Value值獲取Map中的Key值的方法，分別是循環法、Stream、Guava、Apache Commons Collections，這四種方法類似但不盡相同。

(1)循環法和使用Stram本質上都是要遍歷的，如果一個Map經常需要反向取Key值，則不建議使用，可以考慮Guava和Apache Commons提供的雙向Map；
(2)雙向Map其實是一種空間換取時間的思想，雖然能較快的找到滿足條件的Key值，但它也使用了更多的空間來儲存雙向Map；
(3)雙向Map並不支持多對一的關係。
如何選擇，就看具體需求來取捨了。

原文轉載至：通過Value獲取Map中Key的四種方法