【Java代码之美】 -- 通过Value获取Map中的键值Key的四种方法

2021-12-15 12:08:32

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的四种方法

码农公寓