SparseArray HashMap 稀疏数组 二分法

简介

HashMap是java里比较常用的一个集合类，我们常用其来缓存一些处理后的结果，但是在Android项目中，Eclipse却给出了一个 performance 警告。意思就是说用SparseArray<E>来替代，以获取更好性能。按住Ctrl点击进入SparseArray的源码，可以看出他是Android提供的一个工具类。路径为：android.util.SparseArray。

SparseArray是android里为<Interger,Object>这样的HashMap而专门写的类，目的是提高效率，其核心是折半查找函数（binarySearch）。
SparseBooleanArray、SparseIntArray、SparseLongArray都是SparseArray的特殊形式（不带泛型），其key为Interget，value为特定的类型。
在Android中，当我们需要定义HashMap<Integer,E>时，我们可以使用SparseArray<E>来取得更好的性能。
总体来说，它们都是类似map这样key-value的存储方式，但是由于查找的算法不一样，因此效率也各不同。
但要明白，没有说哪个一定是最好的，只有根据不同需求在不同场景去应用，才能获取较优的结果。

官方文档

/
 * SparseArrays 利用integer去管理object对象。不像一个正常的object对象数组，它能在索引数中快速的查找到所需的结果。（这
 * 句话是意译，原意是能在众多索引数中“撕开一个缺口”，为什么原文这么表达？下面会慢慢说清楚。）它比HashMap去通过Integer索引
 * 查找object对象时在内存上更具效率，不仅因为它避免了用来查找的自动“装箱”的keys，并且它的数据结构不依赖额外的对象去
 * 各个映射中查找匹配。
 * 
 * SparseArrays map integers to Objects.  Unlike a normal array of Objects,
 * there can be gaps in the indices.  It is intended to be more memory efficient
 * than using a HashMap to map Integers to Objects, both because it avoids
 * auto-boxing keys and its data structure doesn't rely on an extra entry object
 * for each mapping.
 *
 * 请注意，这个容器会保持它的映射关系在一个数组的数据结构中，通过二分检索法去查找key。（这里我们终于知道，为何这个工具类中，
 * 提供的添加映射关系的操作中，key的类型必须是integer。因为二分检索法，将从中间“切开”，integer的数据类型是实现这种检索过程的保证。）
 * 
 * 如果保存大量的数据，这种数据结构是不适合的，换言之，SparseArray这个工具类并不应该用于存储大量的数据。这种情况下，它的效率
 * 通常比传统的HashMap更低，因为它的查找方法并且增加和移除操作（任意一个操作）都需要在数组中插入和删除（两个步骤才能实现）。
 * 
 * 如果存储的数据在几百个以内，它们的性能差异并不明显，低于50%。
 * 
 * （OK，那么光看Android官方的介绍我们就有初步结论了，大量的数据我们相对SparseArray会优先选择HashMap，如果数据在几百个这个数目，
 *  那么选择它们任意一个去实现区别不大，如果数量较少，就选择SparseArray去实现。 其实如果我们理解了二分法，就很容易了SparseArray的
 *  实现原理，以及SparseArray和HashMap它们之间的区别了。）
 * 
 * <p>Note that this container keeps its mappings in an array data structure,
 * using a binary search to find keys.  The implementation is not intended to be appropriate for
 * data structures
 * that may contain large numbers of items.  It is generally slower than a traditional
 * HashMap, since lookups require a binary search and adds and removes require inserting
 * and deleting entries in the array.  For containers holding up to hundreds of items,
 * the performance difference is not significant, less than 50%.</p>
 *    
 * 为了提高性能，这个容器包含了一个实现最优的方法：当移除keys后为了立刻使它的数组紧密，它会“遗留”已经被移除（标记了要删除）的条目（entry） 。
 * 所被标记的条目（entry）（还未被当作垃圾回收掉前）可以被相同的key复用，也会在垃圾回收机制当作所有要回收的条目的一员被回收，从而使存储的数组更紧密。
 * 
 * （我们下面看源码就会发现remove()方法其实是调用delete()方法的。印证了上面这句话所说的这种优化方法。
 * 因为这样，能在每次移除元素后一直保持数组的数据结构是紧密不松散的。）
 * 
 * 垃圾回收的机制会在这些情况执行：数组需要扩充，或者映射表的大小被恢复，或者条目值被重新检索后恢复的时候。
 *    
 * <p>To help with performance, the container includes an optimization when removing
 * keys: instead of compacting its array immediately, it leaves the removed entry marked
 * as deleted.  The entry can then be re-used for the same key, or compacted later in
 * a single garbage collection step of all removed entries.  This garbage collection will
 * need to be performed at any time the array needs to be grown or the the map size or
 * entry values are retrieved.</p>
 *
 * 当调用keyAt(int)去获取某个位置的key的键的值，或者调用valueAt(int)去获取某个位置的值时，可能是通过迭代容器中的元素
 * 去实现的。
 *
 * <p>It is possible to iterate over the items in this container using
 * {@link #keyAt(int)} and {@link #valueAt(int)}. Iterating over the keys using
 * <code>keyAt(int)</code> with ascending values of the index will return the
 * keys in ascending order, or the values corresponding to the keys in ascending
 * order in the case of <code>valueAt(int)<code>.</p>
 */
public class SparseArray<E> implements Cloneable

稀疏数组

单纯从字面上来理解，SparseArray指的是稀疏数组(Sparse array)，所谓稀疏数组就是数组中大部分的内容值都未被使用（或都为零），在数组中仅有少部分的空间使用。因此造成内存空间的浪费，为了节省内存空间，并且不影响数组中原有的内容值，我们可以采用一种压缩的方式来表示稀疏数组的内容。

假设有一个9*7的数组，其内容如下：
 
在此数组中，共有63个空间，但却只使用了5个元素，造成58个元素空间的浪费。以下我们就使用稀疏数组重新来定义这个数组：

在稀疏数组中，第一部分所记录的是原数组的【行数】、【列数】以及【元素的使用个数】，第二部分所记录的是所使用的元素在原数组中的【位置】和【内容】。
经过压缩之后，原来需要声明大小为63的数组，而使用压缩后，只需要声明大小为6*3的数组，仅需18个存储空间。

SparseIntArray API

public class SparseIntArray implements Cloneable {
public SparseIntArray()//默认的大小是10
public SparseIntArray(int initialCapacity)
public SparseIntArray clone()
public int get(int key)//当找不到的时候，默认返回null。
public int get(int key, int valueIfKeyNotFound)//当找不到的时候，返回valueIfKeyNotFound
public void delete(int key)
public void removeAt(int index)//直接调用的delete(int key)
public void put(int key, int value)//在put数据之前，会先查找要put的数据是否已经存在，如果存在就是修改，不存在就添加
public int size()
public int keyAt(int index)//采用二分法查找键的位置，所以找不到时返回小于0的数值，而不是返回-1。返回的负值是表示它在找不到时所在的位置
public int valueAt(int index)
public int indexOfKey(int key)
public int indexOfValue(int value)//查看值所在位置，没有的话返回-1
public void clear()
public void append(int key, int value)
public String toString() 

来自为知笔记(Wiz)