ImmutableMap报错的原因是什么？-HCRM博客

ImmutableMap报错详解

一、ImmutableMap

ImmutableMap是Java中一种不可变的Map实现，适用于创建不可修改的键值对集合，它的主要特点包括：

（图片来源网络，侵权删除）

1、不可变性：一旦创建，ImmutableMap的内容就不能被修改（例如添加、删除或更新元素）。

2、线程安全：由于其不可变性，ImmutableMap在多线程环境中是线程安全的。

3、内存效率不可变，ImmutableMap可以进行某些内存优化。

4、防御性编程：可以防止外部代码修改内部数据结构，提高代码的安全性和可靠性。

二、ImmutableMap的常用方法

1. of()方法

ImmutableMap.of()方法用于创建一个包含特定键值对的不可变Map，这个方法有多个重载版本，最多支持10个键值对。

（图片来源网络，侵权删除）

ImmutableMap<String, Integer> map = ImmutableMap.of("a", 1, "b", 2, "c", 3);

2. copyOf()方法

ImmutableMap.copyOf(Map<? extends K, ? extends V>)方法用于从现有的Map创建一个不可变Map。

Map<String, Integer> mutableMap = new HashMap<>();
mutableMap.put("x", 10);
mutableMap.put("y", 20);
ImmutableMap<String, Integer> immutableMap = ImmutableMap.copyOf(mutableMap);

3. builder()方法

ImmutableMap.Builder<K,V>类用于构建一个不可变Map，可以使用put()方法添加键值对，并最终通过build()方法生成不可变Map。

ImmutableMap<String, Integer> immutableMap = new ImmutableMap.Builder<String, Integer>()
    .put("key1", 1)
    .put("key2", 2)
    .build();

三、常见报错及解决方案

1. UnsupportedOperationException

当尝试修改ImmutableMap时（例如添加、删除或更新元素），会抛出UnsupportedOperationException异常，这是因为ImmutableMap是不可变的，不允许任何修改操作。

解决方案：确保不尝试修改ImmutableMap的内容，如果需要可变的Map，请使用其他实现如HashMap。

2. IllegalArgumentException

当使用of()方法时，如果提供的键值对中包含重复的键或超过规定数量的键值对，会抛出IllegalArgumentException异常。

解决方案：确保每个键都是唯一的，并且使用的of()方法支持所需的键值对数量，如果需要超过限制的键值对，可以使用builder()方法。

3. NullPointerException

当尝试将null键或null值插入ImmutableMap时，会抛出NullPointerException异常，ImmutableMap不允许null键或null值。

解决方案：确保在创建ImmutableMap时不使用null键或null值，可以在插入前进行检查。

四、使用场景及注意事项

1. 使用场景

配置信息：存储固定不变的配置项。

常量集合：作为常量集合传递给其他方法或模块。

多线程环境：在多线程环境中共享不可变的数据结构。

防御性编程：防止外部代码修改内部数据结构。

2. 注意事项

不可变性：一旦创建，无法修改ImmutableMap的内容。

空键值对：不允许null键或null值。

性能考虑：虽然ImmutableMap是线程安全的，但在频繁读写的场景下，可变的并发集合（如ConcurrentHashMap）可能更高效。

适用方法：根据具体需求选择合适的创建方法（如of()、copyOf()或builder()）。

五、常见问题解答（FAQs）

Q1: 为什么在使用ImmutableMap时会遇到UnsupportedOperationException？

A1:UnsupportedOperationException是由于尝试修改ImmutableMap的内容（如添加、删除或更新元素）导致的，ImmutableMap的设计目的就是为了确保其内容在创建后不能被修改，遇到这个异常时，应检查代码是否有试图修改ImmutableMap的操作，并确保所有操作都在允许的范围内。

Q2: 如果需要超过10个键值对怎么办？

A2: 如果需要超过10个键值对，可以使用ImmutableMap.Builder来构建ImmutableMap。Builder模式允许添加任意数量的键值对，并且在构建过程中可以进行更多的定制操作。

ImmutableMap<String, Integer> immutableMap = new ImmutableMap.Builder<String, Integer>()
    .put("one", 1)
    .put("two", 2)
    .put("three", 3)
    // ...可以继续添加更多键值对
    .build();