深入理解Java集合之Set

Set笔录

Set是Java集合中的一个类别，存入Set的每一个接口都必须是唯一的，因为Set不保存重复元素。加入Set的元素必须定义equals()方法以确保对象的唯一性。Set和Collection有完全一样的接口。Set不保证维护元素的次序。

HashSet

 为快速查找而设计的Set。存入HashSet的元素必须定义hashCode()。因为HashSet数据结构是哈希表，哈希表依赖两个方法
分别是hashCode()和equals()。性能总是比TreeSet好，特别是在添加和查询元素时，而这个两个操作也是最重要的操作。
 
底层原理：
HashSet底层是由HashMap实现的，它利用HashMap来保存所有的元素，因此HashSet实现比较简单，它的许多方法都是调用了HashMap的方法。
     定义：

public class HashSet<E>
extends AbstractSet<E>
implements Set<E>, Cloneable, java.io.Serializable

     私有属性： // 底层使用HashMap来保存HashSet中所有元素。
private transient HashMap<E,Object> map;

// 定义一个虚拟的Object对象作为HashMap的value，将此对象定义为static final。
private static final Object PRESENT = new Object();     构造方法： /**
* 默认的无参构造器，构造一个空的HashSet。
*
* 实际底层会初始化一个空的HashMap，并使用默认初始容量为16和加载因子0.75。
*/
public HashSet() {
map = new HashMap<E, Object>();
}

/**
* 构造一个包含指定collection中的元素的新set。
*
* 实际底层使用默认的加载因子0.75和足以包含指定 collection中所有元素的初始容量来创建一个HashMap。
*
* @param c
* 其中的元素将存放在此set中的collection。
*/
public HashSet(Collection<? extends E> c) {
map = new HashMap<E, Object>(Math.max((int) (c.size() / .75f) + 1, 16));
addAll(c);
}

/**
* 以指定的initialCapacity和loadFactor构造一个空的HashSet。
*
* 实际底层以相应的参数构造一个空的HashMap。
*
* @param initialCapacity
* 初始容量。
* @param loadFactor
* 加载因子。
*/
public HashSet(int initialCapacity, float loadFactor) {
map = new HashMap<E, Object>(initialCapacity, loadFactor);
}

/**
* 以指定的initialCapacity构造一个空的HashSet。
*
* 实际底层以相应的参数及加载因子loadFactor为0.75构造一个空的HashMap。
*
* @param initialCapacity
* 初始容量。
*/
public HashSet(int initialCapacity) {
map = new HashMap<E, Object>(initialCapacity);
}

/**
* 以指定的initialCapacity和loadFactor构造一个新的空链接哈希集合。
* 此构造函数为包访问权限，不对外公开，实际只是是对LinkedHashSet的支持。
*
* 实际底层会以指定的参数构造一个空LinkedHashMap实例来实现。
*
* @param initialCapacity
* 初始容量。
* @param loadFactor
* 加载因子。
* @param dummy
* 标记。
*/
HashSet(int initialCapacity, float loadFactor, boolean dummy) {
map = new LinkedHashMap<E, Object>(initialCapacity, loadFactor);
}     迭代器的创建： /**
* 返回对此set中元素进行迭代的迭代器。返回元素的顺序并不是特定的。
*
* 底层实际调用底层HashMap的keySet来返回所有的key。 可见HashSet中的元素，只是存放在了底层HashMap的key上，
* value使用一个static final的Object对象标识。
*
* @return 对此set中元素进行迭代的Iterator。
*/
public Iterator<E> iterator() {
return map.keySet().iterator();
}返回Set的集合元素数量： /**
* 返回此set中的元素的数量（set的容量）。
*
* 底层实际调用HashMap的size()方法返回Entry的数量，就得到该Set中元素的个数。
*
* @return 此set中的元素的数量（set的容量）。
*/
public int size() {
return map.size();
}    判断集合是否为空： /**
* 如果此set不包含任何元素，则返回true。
*
* 底层实际调用HashMap的isEmpty()判断该HashSet是否为空。
*
* @return 如果此set不包含任何元素，则返回true。
*/
public boolean isEmpty() {
return map.isEmpty();
}     判断元素是否存在： /**
* 如果此set包含指定元素，则返回true。 更确切地讲，当且仅当此set包含一个满足(o==null ? e==null :
* o.equals(e)) 的e元素时，返回true。
*
* 底层实际调用HashMap的containsKey判断是否包含指定key。
*
* @param o
* 在此set中的存在已得到测试的元素。
* @return 如果此set包含指定元素，则返回true。
*/
public boolean contains(Object o) {
return map.containsKey(o);
}      元素的增加： /**
* 如果此set中尚未包含指定元素，则添加指定元素。 更确切地讲，如果此 set 没有包含满足(e==null ? e2==null :
* e.equals(e2)) 的元素e2，则向此set 添加指定的元素e。 如果此set已包含该元素，则该调用不更改set并返回false。
*
* 底层实际将将该元素作为key放入HashMap。
* 由于HashMap的put()方法添加key-value对时，当新放入HashMap的Entry中key
* 与集合中原有Entry的key相同（hashCode()返回值相等，通过equals比较也返回true），
* 新添加的Entry的value会将覆盖原来Entry的value，但key不会有任何改变，
* 因此如果向HashSet中添加一个已经存在的元素时，新添加的集合元素将不会被放入HashMap中，
* 原来的元素也不会有任何改变，这也就满足了Set中元素不重复的特性。
*
* @param e
* 将添加到此set中的元素。
* @return 如果此set尚未包含指定元素，则返回true。
*/
public boolean add(E e) {
return map.put(e, PRESENT) == null;
}  元素移除：  /**
* 如果指定元素存在于此set中，则将其移除。 更确切地讲，如果此set包含一个满足(o==null ? e==null :
* o.equals(e))的元素e， 则将其移除。如果此set已包含该元素，则返回true
* （或者：如果此set因调用而发生更改，则返回true）。（一旦调用返回，则此set不再包含该元素）。
*
* 底层实际调用HashMap的remove方法删除指定Entry。
*
* @param o
* 如果存在于此set中则需要将其移除的对象。
* @return 如果set包含指定元素，则返回true。
*/
public boolean remove(Object o) {
return map.remove(o) == PRESENT;
}

/**
* 从此set中移除所有元素。此调用返回后，该set将为空。
*
* 底层实际调用HashMap的clear方法清空Entry中所有元素。
*/
public void clear() {
map.clear();
}<
cd8c
strong>    元素复制：[/b] /**
* 返回此HashSet实例的浅表副本：并没有复制这些元素本身。
*
* 底层实际调用HashMap的clone()方法，获取HashMap的浅表副本，并设置到HashSet中。
*/
public Object clone() {
try {
HashSet<E> newSet = (HashSet<E>) super.clone();
newSet.map = (HashMap<E, Object>) map.clone();
return newSet;
} catch (CloneNotSupportedException e) {
throw new InternalError();
}
}

TreeSet

保持次序的Set，底层为树结构。使用它可以从Set中提取有序的序列。元素必须实现Comparable接口。它存在的唯一原因就是
它可以维持元素的排序顺序，所以当需要一个排好序的Set时才使用TreeSet。
TreeSet能够对元素进行某种规则进行排序，它的排序方法有两种：一、自然排序，二、比较器排序。
TreeSet的特点是排序跟唯一性：由它的底层数据结构红黑树决定，因为红黑树是一种自平衡的二叉树。
    底层原理：
    定义： public class TreeSet<E> extends AbstractSet<E>
implements NavigableSet<E>, Cloneable, java.io.Serializable     私有属性： private transient NavigableMap<E,Object> m;

private static final Object PRESENT = new Object(); 第一个属性的NavigableMap接口，是TreeMap的父接口，第二个参数是以Object对象，与HashSet中的这个属性完全相同，即TreeSet虽然底层是基于TreeMap的，但是同样只是用来保存Key而Value值全部为默认值PRESENT。 
    构造方法： //私有构造器，对外部程序不公开
TreeSet(NavigableMap<E, Object> m) {
this.m = m;
}
//调用了第一个构造器，并且创建了一个TreeMap对象作为参数传入，这也表示TreeSet的底层基于TreeMap
public TreeSet() {
this(new TreeMap<E, Object>());
}

public TreeSet(Collection<? extends E> c) {
this();
addAll(c);
}

public TreeSet(Collection<? extends E> c) {
this();
addAll(c);
}

public TreeSet(SortedSet<E> s) {
this(s.comparator());
addAll(s);
}最后三个构造器是调用了addAll()方法,以下是addAll()方法的实现： public boolean addAll(Collection<? extends E> c) {
// Use linear-time version if applicable
//先判断c集合是否为空并且c集合是否为SortedSet或其子类
//若参数c不为空，且是SortedSet或者其子类，那么执行addAllForTreeSet()方法
//否则直接返回addAll()方法的结果
if (m.size() == 0 && c.size() > 0 && c instanceof SortedSet
&& m instanceof TreeMap) {
SortedSet<? extends E> set = (SortedSet<? extends E>) c;
TreeMap<E, Object> map = (TreeMap<E, Object>) m;
Comparator<?> cc = set.comparator();
Comparator<? super E> mc = map.comparator();
if (cc == mc || (cc != null && cc.equals(mc))) {
map.addAllForTreeSet(set, PRESENT);
return true;
}
}
return super.addAll(c);
}

public boolean addAll(Collection<? extends E> c) {
boolean modified = false;
for (E e : c)
if (add(e))
modified = true;
return modified;
}

public boolean add(E e) {
return m.put(e, PRESENT) == null;
}TreeSet底层是基于TreeMap的（而TreeMap是基于红黑树的），但是仅仅用来保存Key，而不保存Value，因为TreeSet的add()方法在调用TreeMap的put方法的时候第二个参数传入的都是PRESENT这个固定的Object对象。

以下是addAllForTreeSet()方法的实现： void addAllForTreeSet(SortedSet<? extends K> set, V defaultVal) {
try {
buildFromSorted(set.size(), set.iterator(), null, defaultVal);
} catch (java.io.IOException cannotHappen) {
} catch (ClassNotFoundException cannotHappen) {
}
}

private void buildFromSorted(int size, Iterator<?> it,
java.io.ObjectInputStream str, V defaultVal)
throws java.io.IOException, ClassNotFoundException {
this.size = size;
root = buildFromSorted(0, 0, size - 1, computeRedLevel(size), it, str,
defaultVal);
}addAllForTreeSet方法中调用了buildFromSorted(int size, Iterator<?> it, java.io.ObjectInputStream str,V defaultVal)，该方法的作用即是在线性时间内对数据进行排序（Linear time tree building algorithm from sorted data），看到这里我们就明白TreeSet排序的原理了，即当使用一个TreeMap集合作为参数构造一个TreeSet的时候，TreeSet会将Map中的元素先排序，然后将排序后的元素add到TreeSet中。也就是说TreeSet中的元素都是排过序的，另外正因为存在排序过程，所以TreeSet不允许插入null值，因为null值不能排序。
 以下TreeSet的重要方法都调用了TreeMap的方法来实现：
     增加数据： public boolean add(E e) {
return m.put(e, PRESENT) == null;
}添加的执行顺序：首先判断hashCode()值是否相同，若是，则继续执行equals()，看返回值是true，说明元素重复，不添加返回值是false，则直接添加到集合；若否，则直接添加到集合。（ps：所以使用对象作为键的时候，需要重写hashCode()和equals(),详情请看深入理解集合之Map中的解释）移除数据： public boolean remove(Object o) {
return m.remove(o) == PRESENT;
}

public void clear() {
m.clear();
}可以看到TreeSet中的add与remove等方法均无synchronized关键字修饰，即TreeSet不是线程安全的，如果要使用同步的TreeSet需要使用Collections集合类的静态方法，即Set s=Collections.synchronizedSet(new TreeSet());
     查看是否存在数据： public boolean contains(Object o) {
return m.containsKey(o);
}     获得首尾Key： public E first() {
return m.firstKey();
}

public E last() {
return m.lastKey();
}

LinkedHashSet

具有HashSet的查询速度，且内部使用链表维护元素的顺序（插入的次序）。于是在使用迭代器遍历Set时，结果会按照元素插
入的次序显示，元素也必须定义hashCode()。
以下几乎是LinkedHashSet的全部源代码：
public class LinkedHashSet<E> extends HashSet<E> implements Set<E>,
Cloneable, java.io.Serializable {

private static final long serialVersionUID = -2851667679971038690L;

/**
* 构造一个带有指定初始容量和加载因子的新空链接哈希set。
*
* 底层会调用父类的构造方法，构造一个有指定初始容量和加载因子的LinkedHashMap实例。
*
* @param initialCapacity
* 初始容量。
* @param loadFactor
* 加载因子。
*/
public LinkedHashSet(int initialCapacity, float loadFactor) {
super(initialCapacity, loadFactor, true);
}

/**
* 构造一个带指定初始容量和默认加载因子0.75的新空链接哈希set。
*
* 底层会调用父类的构造方法，构造一个带指定初始容量和默认加载因子0.75的LinkedHashMap实例。
*
* @param initialCapacity
* 初始容量。
*/
public LinkedHashSet(int initialCapacity) {
super(initialCapacity, .75f, true);
}

/**
* 构造一个带默认初始容量16和加载因子0.75的新空链接哈希set。
*
* 底层会调用父类的构造方法，构造一个带默认初始容量16和加载因子0.75的LinkedHashMap实例。
*/
public LinkedHashSet() {
super(16, .75f, true);
}

/**
* 构造一个与指定collection中的元素相同的新链接哈希set。
*
* 底层会调用父类的构造方法，构造一个足以包含指定collection
* 中所有元素的初始容量和加载因子为0.75的LinkedHashMap实例。
*
* @param c
* 其中的元素将存放在此set中的collection。
*/
public LinkedHashSet(Collection<? extends E> c) {
super(Math.max(2 * c.size(), 11), .75f, true);
addAll(c);
}
}从源码看LinkedHashSet都调用了父类HashSet的以下的构造方法： HashSet(int initialCapacity, float loadFactor, boolean dummy) {
map = new LinkedHashMap<E, Object>(initialCapacity, loadFactor);
}从调用的这个父类构造方法看，LinkedHashSet内部是基于LinkedHashMap的，所以LinkedHashSet是通过LinkedHashMap来保存元素的，又是继承HashSet，所以方法操作本身并没有实现，而是跟父类HashSet相同。