java-HashSet 源码分析 1

## 深入分析 Java 中的 `HashSet` 源码

`HashSet` 是 Java 集合框架中的一个重要类，它基于哈希表实现，用于存储不重复的元素。`HashSet` 允许 `null` 元素，并且不保证元素的顺序。本文将详细分析 `HashSet` 的源码，包括其数据结构、构造方法、核心操作、内部实现机制等。

### 1. `HashSet` 的基本数据结构

`HashSet` 是基于 `HashMap` 实现的，每个 `HashSet` 内部都维护了一个 `HashMap` 实例，用于存储元素。`HashSet` 的元素作为 `HashMap` 的键，所有键对应的值为一个常量对象。

`HashSet` 类的基本结构如下：

```java
public class HashSet<E> extends AbstractSet<E>
        implements Set<E>, Cloneable, java.io.Serializable {
    static final long serialVersionUID = -5024744406713321676L;

    // 底层使用的 HashMap
    private transient HashMap<E, Object> map;

    // HashSet 中所有键对应的值
    private static final Object PRESENT = new Object();

    // 默认构造方法
    public HashSet() {
        map = new HashMap<>();
    }

    // 其他构造方法和方法定义
}
```

- `map`：底层使用的 `HashMap` 实例，用于存储元素。
- `PRESENT`：`HashMap` 中所有键对应的值，这是一个常量对象。

### 2. 构造方法

`HashSet` 提供了多个构造方法，以满足不同的初始化需求。

#### 2.1 默认构造方法

```java
public HashSet() {
    map = new HashMap<>();
}
```

默认构造方法使用默认初始容量（16）和加载因子（0.75）创建一个空的 `HashMap` 实例。

#### 2.2 指定初始容量和加载因子的构造方法

```java
public HashSet(int initialCapacity, float loadFactor) {
    map = new HashMap<>(initialCapacity, loadFactor);
}
```

此构造方法允许用户指定 `HashMap` 的初始容量和加载因子。

#### 2.3 指定初始容量的构造方法

```java
public HashSet(int initialCapacity) {
    map = new HashMap<>(initialCapacity);
}
```

此构造方法允许用户指定 `HashMap` 的初始容量，加载因子使用默认值 0.75。

#### 2.4 从另一个集合创建 `HashSet`

```java
public HashSet(Collection<? extends E> c) {
    map = new HashMap<>(Math.max((int) (c.size() / .75f) + 1, 16));
    addAll(c);
}
```

此构造方法从另一个集合创建 `HashSet`，并将集合中的所有元素添加到 `HashSet` 中。

### 3. 核心操作方法

#### 3.1 添加元素

`HashSet` 提供了添加元素的方法 `add(E e)`：

```java
public boolean add(E e) {
    return map.put(e, PRESENT) == null;
}
```

- `add(E e)`：将元素 `e` 添加到 `HashSet` 中。实际上是将元素 `e` 作为键，`PRESENT` 作为值存入 `HashMap` 中。如果键 `e` 已存在，则返回 `false`；否则返回 `true`。

#### 3.2 删除元素

`HashSet` 提供了删除元素的方法 `remove(Object o)`：

```java
public boolean remove(Object o) {
    return map.remove(o) == PRESENT;
}
```

- `remove(Object o)`：从 `HashSet` 中删除指定的元素 `o`。如果 `HashMap` 中存在键 `o`，则删除并返回 `true`；否则返回 `false`。

#### 3.3 判断是否包含元素

`HashSet` 提供了判断是否包含某个元素的方法 `contains(Object o)`：

```java
public boolean contains(Object o) {
    return map.containsKey(o);
}
```

- `contains(Object o)`：判断 `HashSet` 中是否包含指定的元素 `o`。实际上是调用 `HashMap` 的 `containsKey(Object key)` 方法。

#### 3.4 清空 `HashSet`

`HashSet` 提供了清空所有元素的方法 `clear()`：

```java
public void clear() {
    map.clear();
}
```

- `clear()`：清空 `HashSet` 中的所有元素。实际上是调用 `HashMap` 的 `clear()` 方法。

### 4. 内部实现机制

#### 4.1 `HashMap` 的工作原理

为了更好地理解 `HashSet` 的实现，有必要了解 `HashMap` 的工作原理。`HashMap` 是基于哈希表的数据结构，通过散列函数将键映射到数组中的位置，从而实现快速查找、插入和删除操作。

#### 4.2 `HashMap` 的核心操作

- **计算哈希值**：`HashMap` 使用键的 `hashCode()` 方法计算哈希值，并进一步对哈希值进行处理，以减少哈希冲突。
- **处理哈希冲突**：当两个不同的键映射到同一个位置时，`HashMap` 使用链地址法（即在数组的每个位置存储一个链表）处理冲突。
- **扩容**：当 `HashMap` 的负载因子超过阈值时（默认 0.75），`HashMap` 会进行扩容，将数组大小增加一倍，并重新分配所有键值对的位置。

#### 4.3 `HashSet` 中的元素存储

在 `HashSet` 中，所有元素都作为 `HashMap` 的键存储在哈希表中。由于 `HashMap` 的键不允许重复，因此 `HashSet` 中的元素也是唯一的。

### 5. 迭代器支持

`HashSet` 实现了 `Iterable` 接口，提供了支持迭代的功能：

```java
public Iterator<E> iterator() {
    return map.keySet().iterator();
}
```

- `iterator()`：返回一个迭代器，用于遍历 `HashSet` 中的元素。实际上是调用 `HashMap` 的 `keySet()` 方法返回键集合的迭代器。