Java ImmutableMap|极客笔记

Java ImmutableMap

介绍

在Java编程中，Map是一种常见的数据结构，用于存储键值对。Map接口的实现类有HashMap、TreeMap、LinkedHashMap等。其中，HashMap是最常用的Map实现类之一。

然而，在某些情况下，我们可能需要使用不可变的Map，即无法修改其内容的Map。Java提供了ImmutableMap类来满足这一需求。本文将详细介绍ImmutableMap的特性、用法和示例代码。

特性

ImmutableMap是Guava库中的一个类，它实现了Map接口，并具有以下特性：

不可修改性：一旦ImmutableMap对象被创建，就无法修改其内容。这意味着无法添加、删除或修改ImmutableMap中的键值对。
线程安全性：ImmutableMap是线程安全的，多个线程可以同时访问和使用同一个ImmutableMap对象，而无需担心数据竞争或并发问题。
高效性：由于ImmutableMap是不可修改的，因此它在内部使用了一些优化策略来提高性能。例如，ImmutableMap在创建时可能使用了一种更轻量级的数据结构，以提高查询速度。

用法

创建ImmutableMap对象

要创建一个ImmutableMap对象，可以使用其静态方法of()、copyOf()、builder()或builderWithExpectedSize()。

使用of()方法创建ImmutableMap时需要指定键值对作为参数，例如：

ImmutableMap<String, Integer> map = ImmutableMap.of("apple", 1, "banana", 2, "orange", 3);

使用copyOf()方法创建ImmutableMap时需要指定一个已有的Map对象作为参数，例如：

Map<String, Integer> originalMap = new HashMap<>();
originalMap.put("apple", 1);
originalMap.put("banana", 2);
originalMap.put("orange", 3);

ImmutableMap<String, Integer> map = ImmutableMap.copyOf(originalMap);

使用builder()方法创建ImmutableMap时，需要先创建一个Builder对象，并使用其put()方法来添加键值对，最后调用build()方法生成ImmutableMap对象，例如：

ImmutableMap<String, Integer> map = ImmutableMap.<String, Integer>builder()
    .put("apple", 1)
    .put("banana", 2)
    .put("orange", 3)
    .build();

使用ImmutableMap对象

一旦ImmutableMap对象被创建，就无法对其进行修改。但我们仍然可以使用ImmutableMap对象来进行一些常用操作。

获取键值对

要获取ImmutableMap中的键值对，可以使用get()方法，例如：

int value = map.get("apple");
System.out.println(value);  // 1

如果键不存在，get()方法将返回null。

判断键是否存在

要判断ImmutableMap中是否包含某个键，可以使用containsKey()方法，例如：

boolean containsKey = map.containsKey("apple");
System.out.println(containsKey);  // true

获取所有键或值

要获取ImmutableMap中的所有键，可以使用keySet()方法，返回一个不可修改的Set对象。要获取ImmutableMap中的所有值，可以使用values()方法，返回一个不可修改的Collection对象，例如：

Set<String> keys = map.keySet();
System.out.println(keys);  // [apple, banana, orange]

Collection<Integer> values = map.values();
System.out.println(values);  // [1, 2, 3]

获取所有键值对

要获取ImmutableMap中的所有键值对，可以使用entrySet()方法，返回一个不可修改的Set对象。每个键值对都表示为Map.Entry对象，可以使用getKey()和getValue()方法获取键和值，例如：

Set<Map.Entry<String, Integer>> entries = map.entrySet();
for (Map.Entry<String, Integer> entry : entries) {
    String key = entry.getKey();
    Integer value = entry.getValue();
    System.out.println(key + ": " + value);
}

示例代码运行结果如下：

apple: 1
banana: 2
orange: 3

注意事项

由于ImmutableMap是不可修改的，因此在创建时需要确保所有键和值都已经确定，无需在运行时进行修改。否则，可以先创建可修改的Map对象，然后使用copyOf()方法将其转换为ImmutableMap对象。

另外需要注意的是，ImmutableMap对象的键和值必须是不可修改的，否则在创建ImmutableMap时可能会抛出异常。如果键和值可能被修改，请先对其进行复制或克隆操作。

示例代码

以下示例演示了如何使用ImmutableMap。

import com.google.common.collect.ImmutableMap;

import java.util.Collection;
import java.util.Map;
import java.util.Set;

public class ImmutableMapExample {

    public static void main(String[] args) {
        ImmutableMap<String, Integer> map = ImmutableMap.<String, Integer>builder()
                .put("apple", 1)
                .put("banana", 2)
                .put("orange", 3)
                .build();

        // 获取键值对
        int value = map.get("apple");
        System.out.println(value);

        // 判断键是否存在
        boolean containsKey = map.containsKey("apple");
        System.out.println(containsKey);

        // 获取所有键
        Set<String> keys = map.keySet();
        System.out.println(keys);

        // 获取所有值
        Collection<Integer> values = map.values();
        System.out.println(values);

        // 获取所有键值对
        Set<Map.Entry<String, Integer>> entries = map.entrySet();
        for (Map.Entry<String, Integer> entry : entries) {
            String key = entry.getKey();
            Integer val = entry.getValue();
            System.out.println(key + ": " + val);
        }
    }
}

运行结果如下：

1
true
[apple, banana, orange]
[1, 2, 3]
apple: 1
banana: 2
orange: 3

结论

ImmutableMap是Java中用于表示不可修改的键值对集合的一种实现。它提供了不可修改性、线程安全性和高效性的特性，能够满足多线程环境下的安全访问需求。通过本文的介绍，你应该已经了解了ImmutableMap的特性、用法和示例代码。在实际编程中，如果你需要创建一个无法修改的Map对象，可以考虑使用ImmutableMap来实现。