Java中创建不可变和不可修改的Map的方法

2,192 阅读3分钟

在本教程中,我们将学习如何在Java中使用不可修改的和/或不可变的Map。不可变的类有助于避免多线程应用中的许多设计难题。

1.不可变与不可修改的地图

不支持修改操作的地图被称为不可修改的。不可修改的地图通常是其他可改变的地图的只读视图(包装)。我们不能添加、删除或清除它们,但如果我们改变了底层地图,这个地图的视图也会改变。

Map<String, String> mutableMap = new HashMap<>();
mutableMap.put("key1", "value1");

Map<String, String> unmodifiableMap
    = Collections.unmodifiableMap(mutableMap);

//Throws java.lang.UnsupportedOperationException
//unmodifiableMap.put("key2", "value2");

//Changes are visible in both maps
mutableMap.put("key2", "value2");
System.out.println(unmodifiableMap);  //{key1=value1, key2=value2}

不可变的地图保证底层地图对象的任何变化都不会被看到。我们不能改变不可变的地图--它们不会包裹另一个地图--它们有自己的元素。这些不是视图--这些是数据结构。它的内容永远不会改变

Map<String, String> immutableMap = Map.of("key1", "value1");

//throws java.lang.UnsupportedOperationException
immutableMap.put("key2", "value2");

2.不可修改的地图

Java 8中引入了Collectors.unmodifiableMap(),作为Lambda表达式变化的一部分。这个静态 工厂方法接收一个Map作为参数,并返回一个类型为java.util.Collections$UnmodifiableMap的不可修改的视图。

Map<Integer, String> mutableMap = new HashMap<>();
//add few entries
		
Map<Integer, String> unmodifiableMap = Collections.unmodifiableMap(mutableMap);

Apache Commons CollectionsMapUtils类也提供了一个类似的方法。

Map<String, String> unmodifiable = MapUtils.unmodifiableMap(mutableMap);

3.不可变的地图

3.1.使用Map.of()- Java 9

Map.of()方法是在Java 9中引入的。使用这个方法,我们可以创建一个包含0个或最多10个键值对的不可变的地图。创建的地图的类型是 java.util.ImmutableCollections$MapN如果遇到任何null 的键或值,将抛出一个NullPointerException

var unmodifiableMap = Map.of(1, "Mumbai", 2, "Pune", 3, "Bangalore");
var emptyUnmodifiableMap = Map.of();

3.2.使用Guava的ImmutableMap

由于Guava是一个外部库,所以必须将其添加到你的classpath中。如果你使用的是Maven,请按如下步骤添加Guava的依赖项

<dependency>
    <groupId>com.google.guava</groupId>
    <artifactId>guava</artifactId>
    <version>31.1-jre</version>
</dependency>

ImmutableMap是一个不可变的地图实现。与其他不可变的类类似,它拒绝空值。

一个ImmutableMap ,可以通过以下方式创建。

  • 使用copyOf 方法
  • 使用of 方法
  • 使用Builder

ImmutableMap.copyOf()接收一个Map作为输入参数,并创建一个包含与输入Map类似条目的不可变的Map。

Map<Integer, String> mutableMap = new HashMap<>();
mutableMap.put(1, "Mumbai");
mutableMap.put(2, "Pune");
mutableMap.put(3, "Bangalore");

var immutableMap = ImmutableMap.copyOf(mutableMap);

ImmutableMap.of()Map.of()类似,只是它返回一个不可变的Map,要么是空的,要么是最多有10个键值对。它返回com.google.common.collect.RegularImmutableMap类型的一个实例。

var immutableMap = ImmutableMap.of(1, "Mumbai", 2, "Pune", 3, "Bangalore");

var emptyImmutableMap  = ImmutableMap.of();

ImmutableMap.builder()返回一个构建器,帮助创建一个不可变的Map。使用构建器,我们可以向不可变地图添加原始底层地图中不存在的额外条目。

Map<Integer, String> mutableMap = new HashMap<>();
mutableMap.put(1, "Mumbai");
mutableMap.put(2, "Pune");
mutableMap.put(3, "Bangalore");

var immutableMap = ImmutableMap.builder()
	.putAll(mutableMap)
	.put(4, "Delhi")
	.build();

4.性能和效率

不可修改的地图返回原始地图的一个只读视图。它将是原始地图的一个薄的代理。与返回地图的副本相比,不可修改的地图 速度更快,内存效率更高

然而,对原始地图的修改仍然会反映在不可修改的地图中。只有当没有人持有对原始地图的引用时,返回的地图才是真正不可改变的。

另一方面,不可更改的地图会创建一个原始地图的有效副本。当我们不期望修改地图或期望地图保持不变时,将其防御性地复制到一个不可变的地图中是一个好的做法。它给出了一个保证,一旦它被创建,即使底层地图发生变化,也不能对不可变的地图进行修改。

创建防御性副本可能稍微有点贵。因此,如果我们有一个对性能要求很高的应用,我们可能想使用不可修改的地图。然而,如果我们想确保地图保持不变,并且对底层地图的修改不会在应用程序中产生不一致,特别是在多线程环境中,我们可能想选择不可变的地图。

5.总结

这个Java教程探讨了创建不可变和不可修改的地图的各种方法。建议使用我们正在使用的最新Java版本中的解决方案。