Java中直接初始化HashMap的方法

技术背景

在Java编程中，HashMap 是常用的数据结构，用于存储键值对。有时我们需要在创建 HashMap 的同时就初始化一些固定的、不会改变的值。然而，Java并没有像某些动态语言那样的直接字面量初始化语法，因此需要通过一些特定的方式来实现。

实现步骤

所有版本

若只需单个键值对，可使用 Collections.singletonMap("key", "value")。

Java 9及更高版本

Java 9引入了一些工厂方法，简化了 Map 的创建：

• Map.of：适用于最多10个元素的情况。

Map<String, String> test1 = Map.of(
    "a", "b",
    "c", "d"
);

• Map.ofEntries：适用于任意数量元素的情况。

import static java.util.Map.entry;    
Map<String, String> test2 = Map.ofEntries(
    entry("a", "b"),
    entry("c", "d")
);

注意，上述方法创建的 Map 是不可变的。若需要可变的 Map，可以进行复制，如 mutableMap = new HashMap<>(Map.of("a", "b"));。同时，键和值都不能为 null。

Java 8及以下版本

• 使用匿名子类的初始化器：

Map<String, String> myMap = new HashMap<String, String>() {{
    put("a", "b");
    put("c", "d");
}};

不过，匿名子类可能会引入一些不必要的行为，例如生成额外的类，增加内存和磁盘空间消耗以及启动时间；在非静态方法中，它会持有创建方法所在对象的引用，导致外部类对象在创建的 Map 对象仍被引用时无法被垃圾回收。

• 使用函数进行初始化：

Map<String, String> myMap = createMap();

private static Map<String, String> createMap() {
    Map<String,String> myMap = new HashMap<String,String>();
    myMap.put("a", "b");
    myMap.put("c", "d");
    return myMap;
}

使用第三方库（如Guava）

Guava的 ImmutableMap 可以实现类似字面量的简洁初始化：

• 对于最多5个键值对的情况：

Map<String, String> test = ImmutableMap.of("k1", "v1", "k2", "v2");

• 对于更多键值对的情况，使用构建器：

Map<String, String> test = ImmutableMap.<String, String>builder()
    .put("k1", "v1")
    .put("k2", "v2")
    ...
    .build();

需要注意的是，Guava的 ImmutableMap 实现与Java的 HashMap 实现不同，它是不可变的，并且不允许 null 键和值。

Java 8使用Stream和Collectors

import static java.util.stream.Collectors.toMap;
import java.util.AbstractMap.SimpleEntry;

Map<String, String> myMap = Stream.of(
         new SimpleEntry<>("key1", "value1"),
         new SimpleEntry<>("key2", "value2"),
         new SimpleEntry<>("key3", "value3"))
        .collect(toMap(SimpleEntry::getKey, SimpleEntry::getValue));

这种方法的优点是不会创建匿名类。

最佳实践

• 若使用Java 9及以上版本，优先使用 Map.of 或 Map.ofEntries 方法，因为它们简洁且能保证代码的可读性和性能。
• 若需要使用第三方库，Guava的 ImmutableMap 是一个不错的选择，特别是在需要不可变 Map 的场景下。
• 避免过度使用匿名子类初始化，因为它可能会带来不必要的性能开销和内存占用。

常见问题

• 匿名子类初始化的问题：匿名子类会生成额外的类，增加内存和磁盘空间消耗以及启动时间，还可能导致内存泄漏。
• 不可变 Map 的修改问题：使用 Map.of 或 ImmutableMap 创建的 Map 是不可变的，若尝试修改会抛出异常。
• Collectors.toMap 的 null 值问题：Collectors.toMap 依赖于 Map.merge，不允许 null 值，否则会抛出 NullPointerException。若需要处理 null 值，可以使用自定义收集器。

Map<String, String> myMap = Stream.of(
         new SimpleEntry<>("key1", "value1"),
         new SimpleEntry<>("key2", (String) null),
         new SimpleEntry<>("key3", "value3"),
         new SimpleEntry<>("key1", "value1updated"))
        .collect(HashMap::new,
                (map, entry) -> map.put(entry.getKey(),
                                        entry.getValue()),
                HashMap::putAll);