Java putIfAbsent() 详解

Java `putIfAbsent()` 方法详解

在 Java 中，putIfAbsent() 是 Map 接口中的一个方法，从 Java 8 开始引入。它用于向映射中添加一个键值对，只有在该键尚未存在时才进行添加操作。如果键已存在，则不会覆盖原有值。

1. 方法定义

方法签名

default V putIfAbsent(K key, V value)

参数

key：要插入的键。
value：与键关联的值。

返回值

如果键不存在，插入后返回 null。
如果键已存在，则返回该键当前的值，插入操作不会执行。

2. 功能描述

检查键是否存在：
- 如果键不存在，则将键值对插入到映射中。
- 如果键已存在，则保持原有键值对不变。
线程安全：
- 对于并发映射（如 ConcurrentHashMap），putIfAbsent() 是线程安全的，保证了原子性。
- 对于普通 HashMap，则不是线程安全的。
避免覆盖现有值：
- 与直接调用 put() 不同，putIfAbsent() 不会覆盖现有的值。

3. 示例代码

3.1 基本用法

import java.util.HashMap;
import java.util.Map;public class PutIfAbsentExample {public static void main(String[] args) {Map<String, String> map = new HashMap<>();// 初始插入map.put("A", "Apple");// 插入新键map.putIfAbsent("B", "Banana");System.out.println(map); // 输出：{A=Apple, B=Banana}// 尝试插入已存在的键map.putIfAbsent("A", "Avocado");System.out.println(map); // 输出：{A=Apple, B=Banana}}
}

分析：

初次插入键 A 和 B。
对于键 A，putIfAbsent() 不会覆盖原值，因此保持不变。

3.2 结合返回值

import java.util.HashMap;
import java.util.Map;public class PutIfAbsentReturnExample {public static void main(String[] args) {Map<String, String> map = new HashMap<>();// 尝试插入新键String result1 = map.putIfAbsent("C", "Cat");System.out.println(result1); // 输出：null（键 "C" 不存在）// 再次尝试插入相同键String result2 = map.putIfAbsent("C", "Carrot");System.out.println(result2); // 输出：Cat（键 "C" 已存在，值保持为 "Cat"）System.out.println(map); // 输出：{C=Cat}}
}

3.3 使用 `ConcurrentHashMap`

putIfAbsent() 在 ConcurrentHashMap 中非常有用，可以实现线程安全的惰性初始化。

import java.util.concurrent.ConcurrentHashMap;public class ConcurrentPutIfAbsent {public static void main(String[] args) {ConcurrentHashMap<String, Integer> map = new ConcurrentHashMap<>();// 多线程同时尝试插入map.putIfAbsent("key", 1);map.putIfAbsent("key", 2);System.out.println(map); // 输出：{key=1}（只插入一次）}
}

4. `putIfAbsent()` 和 `put()` 的区别

特性	`put()`	`putIfAbsent()`
覆盖值	如果键已存在，则覆盖旧值。	如果键已存在，则不覆盖旧值。
返回值	返回旧值（如果存在），否则返回 `null`。	如果键已存在，返回旧值，否则返回 `null`。
性能	直接插入操作，可能覆盖原值。	需要额外检查键是否存在（线程安全时也加锁）。
线程安全（ConcurrentMap）	不是线程安全的，需要额外同步。	线程安全，尤其适用于 `ConcurrentHashMap`。

5. 使用场景

5.1 避免覆盖已存在值

当希望保持某个键的初始值，避免被后续操作覆盖时：

map.putIfAbsent("key", "initialValue");

5.2 延迟初始化

在多线程环境中，putIfAbsent() 可以安全地初始化共享资源：

public static ConcurrentHashMap<String, String> cache = new ConcurrentHashMap<>();public static String getValue(String key) {return cache.putIfAbsent(key, "DefaultValue");
}

5.3 统计或计数

可以用 putIfAbsent() 初始化键的默认值，用于统计场景：

map.putIfAbsent("count", 0);
map.put("count", map.get("count") + 1);

6. 注意事项

线程安全
- 对普通的 HashMap 使用 putIfAbsent() 并不能实现线程安全。
- 如果需要线程安全，请使用 ConcurrentHashMap 或其他并发集合。
返回值的使用
- 返回值可以用来判断键是否已存在，从而决定后续操作。
性能开销
- 对于并发集合（如 ConcurrentHashMap），putIfAbsent() 内部使用了锁来保证原子性，可能有一定性能开销。
不可用于 null 值
- putIfAbsent() 不允许插入 null 值，ConcurrentHashMap 会抛出 NullPointerException。