乐趣区

学习笔记Java集合12-Set-CopyOnWriteArraySet源码分析

介绍

CopyOnWriteArraySet 底层是使用 CopyOnWriteArrayList 存储元素的,所以它并不是使用 Map 来存储元素的。

但是,我们知道 CopyOnWriteArrayList 底层其实是一个数组,它是允许元素重复的,那么用它来实现 CopyOnWriteArraySet 怎么保证元素不重复呢?

源码分析

Set 类的源码一般都比较短,所以我们直接贴源码上来一行一行分析吧。


public class CopyOnWriteArraySet<E> extends AbstractSet<E>
        implements java.io.Serializable {
    private static final long serialVersionUID = 5457747651344034263L;

    // 内部使用 CopyOnWriteArrayList 存储元素
    private final CopyOnWriteArrayList<E> al;

    // 构造方法
    public CopyOnWriteArraySet() {al = new CopyOnWriteArrayList<E>();
    }

    // 将集合 c 中的元素初始化到 CopyOnWriteArraySet 中
    public CopyOnWriteArraySet(Collection<? extends E> c) {if (c.getClass() == CopyOnWriteArraySet.class) {
            // 如果 c 是 CopyOnWriteArraySet 类型,说明没有重复元素,// 直接调用 CopyOnWriteArrayList 的构造方法初始化
            @SuppressWarnings("unchecked") CopyOnWriteArraySet<E> cc =
                (CopyOnWriteArraySet<E>)c;
            al = new CopyOnWriteArrayList<E>(cc.al);
        }
        else {
            // 如果 c 不是 CopyOnWriteArraySet 类型,说明有重复元素
            // 调用 CopyOnWriteArrayList 的 addAllAbsent() 方法初始化
            // 它会把重复元素排除掉
            al = new CopyOnWriteArrayList<E>();
            al.addAllAbsent(c);
        }
    }

    // 获取元素个数
    public int size() {return al.size();
    }

    // 检查集合是否为空
    public boolean isEmpty() {return al.isEmpty();
    }

    // 检查是否包含某个元素
    public boolean contains(Object o) {return al.contains(o);
    }

    // 集合转数组
    public Object[] toArray() {return al.toArray();
    }

    // 集合转数组,这里是可能有 bug 的,详情见 ArrayList 中分析
    public <T> T[] toArray(T[] a) {return al.toArray(a);
    }

    // 清空所有元素
    public void clear() {al.clear();
    }

    // 删除元素
    public boolean remove(Object o) {return al.remove(o);
    }

    // 添加元素
    // 这里是调用 CopyOnWriteArrayList 的 addIfAbsent() 方法
    // 它会检测元素不存在的时候才添加
    // 还记得这个方法吗?当时有分析过的,建议把 CopyOnWriteArrayList 拿出来再看看
    public boolean add(E e) {return al.addIfAbsent(e);
    }

    // 是否包含 c 中的所有元素
    public boolean containsAll(Collection<?> c) {return al.containsAll(c);
    }

    // 并集
    public boolean addAll(Collection<? extends E> c) {return al.addAllAbsent(c) > 0;
    }

    // 单方向差集
    public boolean removeAll(Collection<?> c) {return al.removeAll(c);
    }

    // 交集
    public boolean retainAll(Collection<?> c) {return al.retainAll(c);
    }

    // 迭代器
    public Iterator<E> iterator() {return al.iterator();
    }

    // equals() 方法
    public boolean equals(Object o) {
        // 如果两者是同一个对象,返回 true
        if (o == this)
            return true;
        // 如果 o 不是 Set 对象,返回 false
        if (!(o instanceof Set))
            return false;
        Set<?> set = (Set<?>)(o);
        Iterator<?> it = set.iterator();

        // 集合元素数组的快照
        Object[] elements = al.getArray();
        int len = elements.length;

        // 我觉得这里的设计不太好
        // 首先,Set 中的元素本来就是不重复的,所以不需要再用个 matched[] 数组记录有没有出现过
        // 其次,两个集合的元素个数如果不相等,那肯定不相等了,这个是不是应该作为第一要素先检查
        boolean[] matched = new boolean[len];
        int k = 0;
        // 从 o 这个集合开始遍历
        outer: while (it.hasNext()) {
            // 如果 k >len 了,说明 o 中元素多了
            if (++k > len)
                return false;
            // 取值
            Object x = it.next();
            // 遍历检查是否在当前集合中
            for (int i = 0; i < len; ++i) {if (!matched[i] && eq(x, elements[i])) {matched[i] = true;
                    continue outer;
                }
            }
            // 如果不在当前集合中,返回 false
            return false;
        }
        return k == len;
    }

    // 移除满足过滤条件的元素
    public boolean removeIf(Predicate<? super E> filter) {return al.removeIf(filter);
    }

    // 遍历元素
    public void forEach(Consumer<? super E> action) {al.forEach(action);
    }

    // 分割的迭代器
    public Spliterator<E> spliterator() {
        return Spliterators.spliterator
            (al.getArray(), Spliterator.IMMUTABLE | Spliterator.DISTINCT);
    }

    // 比较两个元素是否相等
    private static boolean eq(Object o1, Object o2) {return (o1 == null) ? o2 == null : o1.equals(o2);
    }
}

可以看到,在添加元素时调用了 CopyOnWriteArrayList 的 addIfAbsent() 方法来保证元素不重复。

总结

(1)CopyOnWriteArraySet 是用 CopyOnWriteArrayList 实现的;

(2)CopyOnWriteArraySet 是有序的,因为底层其实是数组,数组是有序的

(3)CopyOnWriteArraySet 是并发安全的,而且实现了读写分离;

(4)CopyOnWriteArraySet 通过调用 CopyOnWriteArrayList 的 addIfAbsent() 方法来保证元素不重复;

如何比较两个 Set 中的元素是否完全相等

假设有两个 Set,一个是 A,一个是 B。

最简单的方式就是判断是否 A 中的元素都在 B 中,B 中的元素是否都在 A 中,也就是两次两层循环。

其实,并不需要。

因为 Set 中的元素并不重复,所以只要先比较两个 Set 的元素个数是否相等,再作一次两层循环就可以了,需要仔细体味。代码如下:


public class CopyOnWriteArraySetTest {public static void main(String[] args) {Set<Integer> set1 = new CopyOnWriteArraySet<>();
        set1.add(1);
        set1.add(5);
        set1.add(2);
        set1.add(7);
//        set1.add(3);
        set1.add(4);

        Set<Integer> set2 = new HashSet<>();
        set2.add(1);
        set2.add(5);
        set2.add(2);
        set2.add(7);
        set2.add(3);

        System.out.println(eq(set1, set2));

        System.out.println(eq(set2, set1));
    }

    private static <T> boolean eq(Set<T> set1, Set<T> set2) {if (set1.size() != set2.size()) {return false;}

        for (T t : set1) {
            // contains 相当于一层 for 循环
            if (!set2.contains(t)) {return false;}
        }

        return true;
    }
}

(2)那么,如何比较两个 List 中的元素是否完全相等呢?

我们知道,List 中元素是可以重复的,一次也可以搞定,设定一个标记数组,标记某个位置的元素是否找到过,请仔细体味。

public class ListEqTest {public static void main(String[] args) {List<Integer> list1 = new ArrayList<>();
        list1.add(1);
        list1.add(3);
        list1.add(6);
        list1.add(3);
        list1.add(8);
        list1.add(5);

        List<Integer> list2 = new ArrayList<>();
        list2.add(3);
        list2.add(1);
        list2.add(3);
        list2.add(8);
        list2.add(5);
        list2.add(6);

        System.out.println(eq(list1, list2));
        System.out.println(eq(list2, list1));
    }

    private static <T> boolean eq(List<T> list1, List<T> list2) {if (list1.size() != list2.size()) {return false;}

        // 标记某个元素是否找到过,防止重复
        boolean matched[] = new boolean[list2.size()];

        outer: for (T t : list1) {for (int i = 0; i < list2.size(); i++) {
                // i 这个位置没找到过才比较大小
                if (!matched[i] && list2.get(i).equals(t)) {matched[i] = true;
                    continue outer;
                }
            }
            return false;
        }

        return true;
    }
}
退出移动版