Java Hashtable 源码注释说明
jopen
11年前
package java.util; import java.io.*; public class Hashtable<K,V> extends Dictionary<K,V> implements Map<K,V>, Cloneable, java.io.Serializable { // Hashtable保存的是key-value的数组 // Hashtbale是采用拉链法实现的，每一个Entry本质上是一个单向链表 // 拉链法的本质：当散列表冲突时 ，我们重开一条链表。 // transient 序列化时忽略该字段。 // 数组存放的是实体的引用，序列化时必须遍历该字段逐个实体序列化。 private transient Entry[] table; // Hashtable中元素的实际数量 private transient int count; // 扩容临界值 // 用于判断是否需要调整Hashtable的容量(threshold=容量*加载因子) private int threshold; //加载因子 private float loadFactor; // Hashtable被改变的次数 private transient int modCount = 0; //序列版本号 private static final long serialVersionUID = 1421746759512286392L; //指定容量大小和加载因子的构造方法 public Hashtable(int initialCapacity, float loadFactor) { // 参数校验 if (initialCapacity < 0) throw new IllegalArgumentException("Illegal Capacity: "+ initialCapacity); if (loadFactor <= 0 || Float.isNaN(loadFactor)) throw new IllegalArgumentException("Illegal Load: "+loadFactor); //如果初始化容量等于0，默认设置为1 if (initialCapacity==0) initialCapacity = 1; //设置加载因子 this.loadFactor = loadFactor; //创建存储数组 table = new Entry[initialCapacity]; //设置扩容临界值 threshold = (int)(initialCapacity * loadFactor); } //指定容量大小的构造函数(构造因子默认是0.75f) public Hashtable(int initialCapacity) { this(initialCapacity, 0.75f); } //默认构造函数 public Hashtable() { // 默认构造函数，指定大的容量大小是11；加载因子是0.75 this(11, 0.75f); } //包含“子map”的构造函数 public Hashtable(Map<? extends K, ? extends V> t) { this(Math.max(2*t.size(), 11), 0.75f); //将“子Map”的全部元素都添加到Hashtable中 putAll(t); } //返回Hashtable存储键值对的数目 public synchronized int size() { return count; } // 判断HashTable是否为空 public synchronized boolean isEmpty() { return count == 0; } // 返回“所有key”的枚举对象 public synchronized Enumeration<K> keys() { return this.<K>getEnumeration(KEYS); } // 返回“所有的value”的枚举对象 public synchronized Enumeration<V> elements() { return this.<V>getEnumeration(VALUES); } // 判断Hashtable是否包含“值(value)” public synchronized boolean contains(Object value) { // Hashtable中“键值对”的value不能是null， // 若是null的话，抛出异常! if (value == null) { throw new NullPointerException(); } Entry tab[] = table; //从后向前遍历table数组中的元素(entry) for (int i = tab.length ; i-- > 0 ;) { //对于每个Entry(单向链表)，逐个遍历，判断节点的值是否等于value for (Entry<K,V> e = tab[i] ; e != null ; e = e.next) { if (e.value.equals(value)) { return true; } } } return false; } // 判断Hashtable是否包含“值(value)” public boolean containsValue(Object value) { return contains(value); } // 判断Hashtable是否包含key public synchronized boolean containsKey(Object key) { Entry tab[] = table; int hash = key.hashCode(); //计算索引值 // % tab.length 是为了防止数组越界 int index = (hash & 0x7FFFFFFF) % tab.length; // 找到“key对应的Entry(链表)”，然后在链表中找出“哈希值”和“键值”与key都相等的元素 for (Entry<K,V> e = tab[index] ; e != null ; e = e.next) { if ((e.hash == hash) && e.key.equals(key)) { return true; } } return false; } // 返回key对应的value，没有的话返回null public synchronized V get(Object key) { Entry tab[] = table; int hash = key.hashCode(); //计算索引值 int index = (hash & 0x7FFFFFFF) % tab.length; // 找到“key对应的Entry(链表)”，然后在链表中找出“哈希值”和“键值”与key都相等的元素 for (Entry<K,V> e = tab[index] ; e != null ; e = e.next) { if ((e.hash == hash) && e.key.equals(key)) { return e.value; } } return null; } //调整HashTable的长度，将长度变成原来的(2倍+1) protected void rehash() { //临时保存旧容量，旧数据 int oldCapacity = table.length; Entry[] oldMap = table; //创建新容量，新数据 int newCapacity = oldCapacity * 2 + 1; Entry[] newMap = new Entry[newCapacity]; //更新 修改次数、扩容临界值、table数组 modCount++; threshold = (int)(newCapacity * loadFactor); table = newMap; //将旧数组中的数据依次添加到新table数组中 for (int i = oldCapacity ; i-- > 0 ;) { //添加链表 for (Entry<K,V> old = oldMap[i] ; old != null ; ) { Entry<K,V> e = old; old = old.next; //计算扩容后的索引值 int index = (e.hash & 0x7FFFFFFF) % newCapacity; e.next = newMap[index]; newMap[index] = e; } } } // 将“key-value”键值对添加到Hashtable中 public synchronized V put(K key, V value) { // HashTable中不能插入value为null的元素 if (value == null) { throw new NullPointerException(); } // 若HashTable中已存在键为key的键值对， // 则用新的value替换旧的value Entry tab[] = table; int hash = key.hashCode(); //计算索引值 int index = (hash & 0x7FFFFFFF) % tab.length; // 根据索引遍历对应的Entry链表 for (Entry<K,V> e = tab[index] ; e != null ; e = e.next) { if ((e.hash == hash) && e.key.equals(key)) { V old = e.value; e.value = value; return old; } } // 若HashTable中不存在键为key的键值对 // 更新修改统计数 modCount++; // 如果HashTable实际容量 > 扩容临界值 (扩容临界值=总容量*加载因子) // 则调整HashTable的大小 if (count >= threshold) { // 扩容并按新容量设置hash分布 rehash(); //更具新容量计算索引 tab = table; index = (hash & 0x7FFFFFFF) % tab.length; } // 将Hashtable中index位置的Entry(链表)保存到e中 Entry<K,V> e = tab[index]; // 将键值对插进entry链表中 tab[index] = new Entry<K,V>(hash, key, value, e); // 实际容量+1 count++; return null; } // 删除Hashtable中键为key的元素 public synchronized V remove(Object key) { Entry tab[] = table; int hash = key.hashCode(); //计算索引值 int index = (hash & 0x7FFFFFFF) % tab.length; // 根据索引遍历对应的链表 for (Entry<K,V> e = tab[index], prev = null ; e != null ; prev = e, e = e.next) { //找到要删除的节点并删除该节点 if ((e.hash == hash) && e.key.equals(key)) { modCount++; if (prev != null) { prev.next = e.next; } else { tab[index] = e.next; } count--; V oldValue = e.value; e.value = null; return oldValue; } } return null; } // 将“Map t”中的全部元素注意添加到Hashtable中 public synchronized void putAll(Map<? extends K, ? extends V> t) { for (Map.Entry<? extends K, ? extends V> e : t.entrySet()) put(e.getKey(), e.getValue()); } // 清空HashTable // 将HashTable的table数组的值全部设置为null public synchronized void clear() { Entry tab[] = table; modCount++; //将引用设置为空 for (int index = tab.length; --index >= 0; ) tab[index] = null; count = 0; } // 克隆一个Hashtable，并以Object的形式返回。 public synchronized Object clone() { try { Hashtable<K,V> t = (Hashtable<K,V>) super.clone(); t.table = new Entry[table.length]; for (int i = table.length ; i-- > 0 ; ) { t.table[i] = (table[i] != null) ? (Entry<K,V>) table[i].clone() : null; } t.keySet = null; t.entrySet = null; t.values = null; t.modCount = 0; return t; } catch (CloneNotSupportedException e) { // this shouldn't happen, since we are Cloneable throw new InternalError(); } } public synchronized String toString() { int max = size() - 1; if (max == -1) return "{}"; StringBuilder sb = new StringBuilder(); Iterator<Map.Entry<K,V>> it = entrySet().iterator(); sb.append('{'); for (int i = 0; ; i++) { Map.Entry<K,V> e = it.next(); K key = e.getKey(); V value = e.getValue(); sb.append(key == this ? "(this Map)" : key.toString()); sb.append('='); sb.append(value == this ? "(this Map)" : value.toString()); if (i == max) return sb.append('}').toString(); sb.append(", "); } } // 获取Hashtable的枚举对象 // 若Hashtable的实际大小为0，则返回“空枚举类”对象 // 否则，返回征程的Enumerator的对象。(Enumerator实现了迭代器和枚举两个接口) private <T> Enumeration<T> getEnumeration(int type) { if (count == 0) { return (Enumeration<T>)emptyEnumerator; } else { return new Enumerator<T>(type, false); } } // 获取Hashtable的迭代器 // 若Hashtable的实际大小为0，则返回空迭代器对象 // 否则，返回正常的Enumerator的对象。(Enumerator实现了迭代器和枚举两个接口) private <T> Iterator<T> getIterator(int type) { if (count == 0) { return (Iterator<T>) emptyIterator; } else { return new Enumerator<T>(type, true); } } // Views // Hashtable的“key的集合”。它是一个set，意味着没有重复元素 private transient volatile Set<K> keySet = null; // Hashtable的“key-value集合”，元素不重复 private transient volatile Set<Map.Entry<K,V>> entrySet = null; // Hashtable的"key-value集合"。它是一个Collection，有可能有重复 private transient volatile Collection<V> values = null; // 返回一个被synchronizedSet封装后的KeySet对象 // synchronizedSet封装的目的是实现多线程同步(对KeySet的所有方法都添加synchronized) public Set<K> keySet() { if (keySet == null) keySet = Collections.synchronizedSet(new KeySet(), this); return keySet; } // Hashtable的key的set集合 // keySet继承于AbstractSet，所以，keySet中的元素没有重复 private class KeySet extends AbstractSet<K> { public Iterator<K> iterator() { return getIterator(KEYS); } public int size() { return count; } public boolean contains(Object o) { return containsKey(o); } public boolean remove(Object o) { return Hashtable.this.remove(o) != null; } public void clear() { Hashtable.this.clear(); } } // 返回一个被synchronizedSet封装后的EntrySet对象 // synchronizedSet封装的目的实现多线程同步(对EntrySet的所有方法都添加synchronized) public Set<Map.Entry<K,V>> entrySet() { if (entrySet==null) entrySet = Collections.synchronizedSet(new EntrySet(), this); return entrySet; } // HashTabled的Entry的set集合 // EntrySet继承于AbstractSet，所以，EntrySet中的元素没有重复的。 private class EntrySet extends AbstractSet<Map.Entry<K,V>> { public Iterator<Map.Entry<K,V>> iterator() { return getIterator(ENTRIES); } public boolean add(Map.Entry<K,V> o) { return super.add(o); } // 是否包含目标对象 public boolean contains(Object o) { // 如果o不是Map.Entry类型 则返回false if (!(o instanceof Map.Entry)) return false; Map.Entry entry = (Map.Entry)o; Object key = entry.getKey(); Entry[] tab = table; int hash = key.hashCode(); //计算索引值 int index = (hash & 0x7FFFFFFF) % tab.length; //根据索引遍历链表 //查找链表中是否存在Object o for (Entry e = tab[index]; e != null; e = e.next) if (e.hash==hash && e.equals(entry)) return true; return false; } //删除元素o public boolean remove(Object o) { // 如果o不是Map.Entry类型 则返回false if (!(o instanceof Map.Entry)) return false; Map.Entry<K,V> entry = (Map.Entry<K,V>) o; K key = entry.getKey(); Entry[] tab = table; int hash = key.hashCode(); //计算索引值 int index = (hash & 0x7FFFFFFF) % tab.length; //遍历索引值对应的entry链表 for (Entry<K,V> e = tab[index], prev = null; e != null; prev = e, e = e.next) { //找到删除 if (e.hash==hash && e.equals(entry)) { modCount++; if (prev != null) prev.next = e.next; else tab[index] = e.next; count--; e.value = null; return true; } } return false; } public int size() { return count; } public void clear() { Hashtable.this.clear(); } } // 返回一个被synchronizedCollection封装后的ValueCollection对象 // synchronizedCollection封装的目的是实现多线程同步(对ValueCollection的所有方法都添加synchronized) public Collection<V> values() { if (values==null) values = Collections.synchronizedCollection(new ValueCollection(), this); return values; } // Hashtable的value的Collection集合。 // ValueCollection继承于AbstractCollection，所以，ValueCollection中的元素可以重复的。 private class ValueCollection extends AbstractCollection<V> { public Iterator<V> iterator() { return getIterator(VALUES); } public int size() { return count; } public boolean contains(Object o) { return containsValue(o); } public void clear() { Hashtable.this.clear(); } } // Comparison and hashing // 覆写equals()方法 // 若两个Hashtable的所有key-value键值对都相等，则判断它们两个相等 public synchronized boolean equals(Object o) { if (o == this) return true; if (!(o instanceof Map)) return false; Map<K,V> t = (Map<K,V>) o; if (t.size() != size()) return false; try { // 通过迭代器依次取出当前Hashtable的key-value键值对 // 并判断该键值对，存在于Hashtable(o)中。 // 若不存在，则立即返回false；否则，遍历完“当前Hashtable”并返回true。 Iterator<Map.Entry<K,V>> i = entrySet().iterator(); while (i.hasNext()) { Map.Entry<K,V> e = i.next(); K key = e.getKey(); V value = e.getValue(); if (value == null) { if (!(t.get(key)==null && t.containsKey(key))) return false; } else { if (!value.equals(t.get(key))) return false; } } } catch (ClassCastException unused) { return false; } catch (NullPointerException unused) { return false; } return true; } // 计算Hashtable的哈希值 public synchronized int hashCode() { int h = 0; // 若 Hashtable的实际大小为0 或者 加载因子<0，则返回0。 if (count == 0 || loadFactor < 0) return h; // Returns zero // 否则，返回“Hashtable中的每个Entry的key和value的异或值 的总和”。 loadFactor = -loadFactor; // Mark hashCode computation in progress Entry[] tab = table; for (int i = 0; i < tab.length; i++) for (Entry e = tab[i]; e != null; e = e.next) h += e.key.hashCode() ^ e.value.hashCode(); loadFactor = -loadFactor; // Mark hashCode computation complete return h; } // java.io.Serializable的写入函数 // 将Hashtable的“总的容量，实际容量，所有的Entry”都写入到输出流中 private synchronized void writeObject(java.io.ObjectOutputStream s) throws IOException { // Write out the length, threshold, loadfactor s.defaultWriteObject(); // Write out length, count of elements and then the key/value objects // 写入总容量 s.writeInt(table.length); // 写入实际容量 s.writeInt(count); // 写入所有实体数据 for (int index = table.length-1; index >= 0; index--) { Entry entry = table[index]; while (entry != null) { s.writeObject(entry.key); s.writeObject(entry.value); entry = entry.next; } } } // java.io.Serializable的读取函数：根据写入方式读出 // 将Hashtable的“总的容量，实际容量，所有的Entry”依次读出 private void readObject(java.io.ObjectInputStream s) throws IOException, ClassNotFoundException { // Read in the length, threshold, and loadfactor s.defaultReadObject(); // Read the original length of the array and number of elements //读取总容量 int origlength = s.readInt(); //读取实际容量 int elements = s.readInt(); // Compute new size with a bit of room 5% to grow but // no larger than the original size. Make the length // odd if it's large enough, this helps distribute the entries. // Guard against the length ending up zero, that's not valid. int length = (int)(elements * loadFactor) + (elements / 20) + 3; if (length > elements && (length & 1) == 0) length--; if (origlength > 0 && length > origlength) length = origlength; Entry[] table = new Entry[length]; count = 0; // Read the number of elements and then all the key/value objects // 读取所有entry实体数据 for (; elements > 0; elements--) { K key = (K)s.readObject(); V value = (V)s.readObject(); // synch could be eliminated for performance reconstitutionPut(table, key, value); } this.table = table; } // 重建Entry[] table数组，只有readObject调用该方法 private void reconstitutionPut(Entry[] tab, K key, V value) throws StreamCorruptedException { if (value == null) { throw new java.io.StreamCorruptedException(); } // Makes sure the key is not already in the hashtable. // This should not happen in deserialized version. int hash = key.hashCode(); int index = (hash & 0x7FFFFFFF) % tab.length; for (Entry<K,V> e = tab[index] ; e != null ; e = e.next) { if ((e.hash == hash) && e.key.equals(key)) { throw new java.io.StreamCorruptedException(); } } // Creates the new entry. Entry<K,V> e = tab[index]; tab[index] = new Entry<K,V>(hash, key, value, e); count++; } // Hashtable的Entry节点，它本质上是一个单向链表。 // 因此，我们才能推断出Hashtable是由拉链法实现的散列表 private static class Entry<K,V> implements Map.Entry<K,V> { // 哈希值 int hash; K key; V value; // 指向的下一个Entry，即链表的下一个节点 Entry<K,V> next; // 构造函数 protected Entry(int hash, K key, V value, Entry<K,V> next) { this.hash = hash; this.key = key; this.value = value; this.next = next; } protected Object clone() { return new Entry<K,V>(hash, key, value, (next==null ? null : (Entry<K,V>) next.clone())); } // Map.Entry Ops public K getKey() { return key; } public V getValue() { return value; } //设置value。若value是null，则抛出异常 public V setValue(V value) { if (value == null) throw new NullPointerException(); V oldValue = this.value; this.value = value; return oldValue; } // 覆盖equals()方法，判断两个Entry是否相等。 // 若两个Entry的key和value都相等，则认为它们相等。 public boolean equals(Object o) { if (!(o instanceof Map.Entry)) return false; Map.Entry e = (Map.Entry)o; return (key==null ? e.getKey()==null : key.equals(e.getKey())) && (value==null ? e.getValue()==null : value.equals(e.getValue())); } public int hashCode() { return hash ^ (value==null ? 0 : value.hashCode()); } public String toString() { return key.toString()+"="+value.toString(); } } // Types of Enumerations/Iterations private static final int KEYS = 0; private static final int VALUES = 1; private static final int ENTRIES = 2; // Enumerator的作用是提供了“通过elements()遍历Hashtable的接口” 和 “通过entrySet()遍历Hashtable的接口”。 // 因为，它同时实现了 “Enumerator接口”和“Iterator接口”。 private class Enumerator<T> implements Enumeration<T>, Iterator<T> { // 指向Hashtable的table Entry[] table = Hashtable.this.table; // Hashtable的总容量 int index = table.length; Entry<K,V> entry = null; Entry<K,V> lastReturned = null; int type; // Enumerator是 “迭代器(Iterator)” 还是 “枚举类(Enumeration)”的标志 // iterator为true，表示它是迭代器；否则，是枚举类。 boolean iterator; // 在将Enumerator当作迭代器使用时会用到，用来实现fail-fast机制。 protected int expectedModCount = modCount; Enumerator(int type, boolean iterator) { this.type = type; this.iterator = iterator; } // 从遍历table的数组的末尾向前查找， // 直到找到不为null的Entry。 public boolean hasMoreElements() { Entry<K,V> e = entry; //index初始值为数组长度 int i = index; Entry[] t = table; /* Use locals for faster loop iteration */ //从尾向头遍历 while (e == null && i > 0) { e = t[--i]; } entry = e; index = i; return e != null; } // 获取下一个元素 // 注意：从hasMoreElements() 和nextElement() // 可以看出“Hashtable的elements()遍历方式” // 首先，从后向前的遍历table数组。table数组的每个节点都是一个单向链表(Entry)。 // 然后，依次向后遍历单向链表Entry。 public T nextElement() { Entry<K,V> et = entry; //index初始值为数组长度 int i = index; Entry[] t = table; /* Use locals for faster loop iteration */ //从后向前遍历 while (et == null && i > 0) { et = t[--i]; } entry = et; index = i; if (et != null) { Entry<K,V> e = lastReturned = entry; entry = e.next; return type == KEYS ? (T)e.key : (type == VALUES ? (T)e.value : (T)e); } throw new NoSuchElementException("Hashtable Enumerator"); } // 迭代器Iterator的判断是否存在下一个元素 // 实际上，它是调用的hasMoreElements() public boolean hasNext() { return hasMoreElements(); } // 迭代器获取下一个元素 // 实际上，它是调用的nextElement() public T next() { if (modCount != expectedModCount) throw new ConcurrentModificationException(); return nextElement(); } // 迭代器的remove()接口。 // 首先，它在table数组中找出要删除元素所在的Entry， // 然后，删除单向链表Entry中的元素 public void remove() { if (!iterator) throw new UnsupportedOperationException(); if (lastReturned == null) throw new IllegalStateException("Hashtable Enumerator"); if (modCount != expectedModCount) throw new ConcurrentModificationException(); synchronized(Hashtable.this) { Entry[] tab = Hashtable.this.table; //删除lastReturned，计算索引 int index = (lastReturned.hash & 0x7FFFFFFF) % tab.length; //遍历列表删除 for (Entry<K,V> e = tab[index], prev = null; e != null; prev = e, e = e.next) { if (e == lastReturned) { modCount++; expectedModCount++; if (prev == null) tab[index] = e.next; else prev.next = e.next; count--; lastReturned = null; return; } } throw new ConcurrentModificationException(); } } } private static Enumeration emptyEnumerator = new EmptyEnumerator(); private static Iterator emptyIterator = new EmptyIterator(); // 空枚举类 // 当Hashtable的实际大小为0；此时， // 又要通过Enumeration遍历Hashtable时，返回的是“空枚举类”的对象。 private static class EmptyEnumerator implements Enumeration<Object> { EmptyEnumerator() { } // 空枚举类的hasMoreElements() 始终返回false public boolean hasMoreElements() { return false; } // 空枚举类的nextElement() 抛出异常 public Object nextElement() { throw new NoSuchElementException("Hashtable Enumerator"); } } // 空迭代器 // 当Hashtable的实际大小为0；此时， // 又要通过迭代器遍历Hashtable时，返回的是“空迭代器”的对象。 private static class EmptyIterator implements Iterator<Object> { EmptyIterator() { } //空迭代器的hasNext，始终返回false public boolean hasNext() { return false; } //空迭代器的next，抛出异常 public Object next() { throw new NoSuchElementException("Hashtable Iterator"); } public void remove() { throw new IllegalStateException("Hashtable Iterator"); } } }