想看我更多文章:【張旭童的部落格】blog.csdn.net/zxt0601
想來gayhub和我gaygayup:【mcxtzhang的Github主頁】github.com/mcxtzhang
1 概述
在上文中，我們已經聊過了HashMap和LinkedHashMap.所以如果沒看過上文，請先閱讀面試必備：HashMap原始碼解析（JDK8） ,面試必備：LinkedHashMap原始碼解析（JDK8
那麼今天換點口味，不看JDK了，我們看看android sdk的原始碼。
本文將從幾個常用方法下手，來閱讀ArrayMap的原始碼。
按照從構造方法->常用API（增、刪、改、查）的順序來閱讀原始碼，並會講解閱讀方法中涉及的一些變數的意義。瞭解ArrayMap的特點、適用場景。
如果本文中有不正確的結論、說法，請大家提出和我討論，共同進步，謝謝。
2 概要
概括的說，ArrayMap 實現了implements Map<K, V>介面，所以它也是一個關聯陣列、雜湊表。儲存以key->value 結構形式的資料。它也是執行緒不安全的，允許key為null,value為null。
它相比HashMap，空間效率更高。
它的內部實現是基於兩個陣列。
一個int[]陣列，用於儲存每個item的hashCode.
一個Object[]陣列，儲存key/value鍵值對。容量是上一個陣列的兩倍。
它可以避免在將資料插入Map中時額外的空間消耗（對比HashMap）。
而且它擴容的更合適，擴容時只需要陣列拷貝工作，不需要重建雜湊表。
和HashMap相比，它不僅有擴容功能，在刪除時，如果集合剩餘元素少於一定閾值，還有收縮（shrunk）功能。減少空間佔用。
對於雜湊衝突的解決，檢視原始碼可以得知採用的是開放地址法。
![圖中存了三組元素，int[]陣列長度為3，Object[]陣列長度為6](https://i.iter01.com/images/7741f546d2d92784fada145054e0077a0d78599d881312669d72f84c56c166dc.jpg)
但是它不適合大容量的資料儲存。儲存大量資料時，它的效能將退化至少50%。
比傳統的HashMap時間效率低。
因為其會對key從小到大排序，使用二分法查詢key對應在陣列中的下標。
在新增、刪除、查詢資料的時候都是先使用二分查詢法得到相應的index，然後通過index來進行新增、查詢、刪除等操作。
所以其是按照key的大小排序儲存的。
適用場景：
- 資料量不大
- 空間比時間重要
- 需要使用
Map - 在Android平臺，相對來說，記憶體容量更寶貴。而且資料量不大。所以當需要使用
key是Object型別的Map時，可以考慮使用ArrayMap來替換HashMap
示例程式碼：
Map<String, String> map = new ArrayMap<>();
map.put("1","1");
map.put(null,"2");
map.put("3",null);
map.put("6",null);
map.put("5",null);
map.put("4",null);
Log.d("TAG", "onCreate() called with: map = [" + map + "]");複製程式碼輸出：
onCreate() called with: map = [{null=2, 1=1, 3=null, 4=null, 5=null, 6=null}]複製程式碼3 建構函式
//擴容預設的size， 4是相對效率較高的大小
private static final int BASE_SIZE = 4;
//表示集合是不可變的
static final int[] EMPTY_IMMUTABLE_INTS = new int[0];
//是否利用System.identityHashCode(key) 獲取唯一HashCode模式。
final boolean mIdentityHashCode;
//儲存hash值的陣列
int[] mHashes;
//儲存key/value的陣列。
Object[] mArray;
//容量
int mSize;
//建立一個空的ArrayMap，預設容量是0.當有Item被新增進來，會自動擴容
public ArrayMap() {
this(0, false);
}
//建立一個指定容量的ArrayMap
public ArrayMap(int capacity) {
this(capacity, false);
}
//指定容量和identityHashCode
public ArrayMap(int capacity, boolean identityHashCode) {
mIdentityHashCode = identityHashCode;
//數量< 0，構建一個不可變的ArrayMap
if (capacity < 0) {
mHashes = EMPTY_IMMUTABLE_INTS;
mArray = EmptyArray.OBJECT;
//數量= 0，構建空的mHashes mArray
} else if (capacity == 0) {
mHashes = EmptyArray.INT;
mArray = EmptyArray.OBJECT;
} else {//數量>0,分配空間初始化陣列
allocArrays(capacity);
}
mSize = 0;
}
//擴容
private void allocArrays(final int size) {
//數量< 0，構建一個不可變的ArrayMap
if (mHashes == EMPTY_IMMUTABLE_INTS) {
throw new UnsupportedOperationException("ArrayMap is immutable");
}//擴容數量是 8
if (size == (BASE_SIZE*2)) {
synchronized (ArrayMap.class) {
//檢視之前是否有快取的 容量為8的int[]陣列和容量為16的object[]陣列
//如果有，複用給mArray mHashes
if (mTwiceBaseCache != null) {
final Object[] array = mTwiceBaseCache;
mArray = array;
mTwiceBaseCache = (Object[])array[0];
mHashes = (int[])array[1];
array[0] = array[1] = null;
mTwiceBaseCacheSize--;
if (DEBUG) Log.d(TAG, "Retrieving 2x cache " + mHashes
+ " now have " + mTwiceBaseCacheSize + " entries");
return;
}
}
} else if (size == BASE_SIZE) {//擴容數量是4
synchronized (ArrayMap.class) {
//檢視之前是否有快取的 容量為4的int[]陣列和容量為8的object[]陣列
//如果有，複用給mArray mHashes
if (mBaseCache != null) {
final Object[] array = mBaseCache;
mArray = array;
mBaseCache = (Object[])array[0];
mHashes = (int[])array[1];
array[0] = array[1] = null;
mBaseCacheSize--;
if (DEBUG) Log.d(TAG, "Retrieving 1x cache " + mHashes
+ " now have " + mBaseCacheSize + " entries");
return;
}
}
}
//構建mHashes和mArray，mArray是mHashes的兩倍。因為它既要存key還要存value。
mHashes = new int[size];
mArray = new Object[size<<1];
}
//利用另一個map構建ArrayMap
public ArrayMap(ArrayMap<K, V> map) {
this();
if (map != null) {
putAll(map);
}
}
//批量put方法：
public void putAll(ArrayMap<? extends K, ? extends V> array) {
final int N = array.mSize;
//確保空間足夠存放
ensureCapacity(mSize + N);
//如果當前是空集合，
if (mSize == 0) {
if (N > 0) {//則直接複製覆蓋陣列內容即可。
System.arraycopy(array.mHashes, 0, mHashes, 0, N);
System.arraycopy(array.mArray, 0, mArray, 0, N<<1);
mSize = N;
}
} else {//否則需要一個一個執行插入put操作
for (int i=0; i<N; i++) {
put(array.keyAt(i), array.valueAt(i));
}
}
}
//確保空間足夠存放 minimumCapacity 個資料
public void ensureCapacity(int minimumCapacity) {
//如果不夠擴容
if (mHashes.length < minimumCapacity) {
//暫存當前的hash array。後面複製需要
final int[] ohashes = mHashes;
final Object[] oarray = mArray;
//擴容空間（開頭講過這個函式）
allocArrays(minimumCapacity);
if (mSize > 0) {//如果原集合不為空，複製原資料到新陣列中
System.arraycopy(ohashes, 0, mHashes, 0, mSize);
System.arraycopy(oarray, 0, mArray, 0, mSize<<1);
}
//釋放回收臨時暫存陣列空間
freeArrays(ohashes, oarray, mSize);
}
}
//釋放回收臨時暫存陣列空間
private static void freeArrays(final int[] hashes, final Object[] array, final int size) {
//如果容量是8， 則將hashes 和array 快取起來，以便下次使用
if (hashes.length == (BASE_SIZE*2)) {
synchronized (ArrayMap.class) {
if (mTwiceBaseCacheSize < CACHE_SIZE) {
//0存，前一個快取的cache
array[0] = mTwiceBaseCache;
//1 存 int[]陣列
array[1] = hashes;
//2+ 元素置空 以便GC
for (int i=(size<<1)-1; i>=2; i--) {
array[i] = null;
}
//更新快取引用為array
mTwiceBaseCache = array;
//增加快取過的Array的數量
mTwiceBaseCacheSize++;
if (DEBUG) Log.d(TAG, "Storing 2x cache " + array
+ " now have " + mTwiceBaseCacheSize + " entries");
}
}//相同邏輯，只不過快取的是int[] 容量為4的陣列
} else if (hashes.length == BASE_SIZE) {
synchronized (ArrayMap.class) {
if (mBaseCacheSize < CACHE_SIZE) {
array[0] = mBaseCache;
array[1] = hashes;
for (int i=(size<<1)-1; i>=2; i--) {
array[i] = null;
}
mBaseCache = array;
mBaseCacheSize++;
if (DEBUG) Log.d(TAG, "Storing 1x cache " + array
+ " now have " + mBaseCacheSize + " entries");
}
}
}
}複製程式碼小結：
- 擴容時，會檢視之前是否有快取的 int[]陣列和object[]陣列
- 如果有，複用給mArray mHashes
4 增 、改
4.1 單個增改 put(K key, V value)
//如果key存在，則返回oldValue
public V put(K key, V value) {
//key的hash值
final int hash;
//下標
int index;
// 如果key為null，則hash值為0.
if (key == null) {
hash = 0;
//尋找null的下標
index = indexOfNull();
} else {
//根據mIdentityHashCode 取到 hash值
hash = mIdentityHashCode ? System.identityHashCode(key) : key.hashCode();
//根據hash值和key 找到合適的index
index = indexOf(key, hash);
}
//如果index>=0,說明是替換（改）操作
if (index >= 0) {
//只需要更新value 不需要更新key。因為key已經存在
index = (index<<1) + 1;
//返回舊值
final V old = (V)mArray[index];
mArray[index] = value;
return old;
}
//index<0,說明是插入操作。 對其取反，得到應該插入的下標
index = ~index;
//如果需要擴容
if (mSize >= mHashes.length) {
//如果容量大於8，則擴容一半。
//否則容量大於4，則擴容到8.
//否則擴容到4
final int n = mSize >= (BASE_SIZE*2) ? (mSize+(mSize>>1))
: (mSize >= BASE_SIZE ? (BASE_SIZE*2) : BASE_SIZE);
//臨時陣列
final int[] ohashes = mHashes;
final Object[] oarray = mArray;
//分配空間完成擴容
allocArrays(n);
//複製臨時陣列中的陣列進新陣列
if (mHashes.length > 0) {
if (DEBUG) Log.d(TAG, "put: copy 0-" + mSize + " to 0");
System.arraycopy(ohashes, 0, mHashes, 0, ohashes.length);
System.arraycopy(oarray, 0, mArray, 0, oarray.length);
}
//釋放臨時陣列空間
freeArrays(ohashes, oarray, mSize);
}
//如果index在中間，則需要移動陣列，騰出中間的位置
if (index < mSize) {
if (DEBUG) Log.d(TAG, "put: move " + index + "-" + (mSize-index)
+ " to " + (index+1));
System.arraycopy(mHashes, index, mHashes, index + 1, mSize - index);
System.arraycopy(mArray, index << 1, mArray, (index + 1) << 1, (mSize - index) << 1);
}
//hash陣列，就按照下標存雜湊值
mHashes[index] = hash;
//array陣列，根據下標，乘以2存key，乘以2+1 存value
mArray[index<<1] = key;
mArray[(index<<1)+1] = value;
mSize++;//修改size
return null;
}
//返回key為null的 下標index
int indexOfNull() {
//N為當前集合size
final int N = mSize;
//如果當前集合是空的，返回~0
if (N == 0) {//
return ~0;
}
//根據hash值=0，通過二分查詢，查詢到目標index
int index = ContainerHelpers.binarySearch(mHashes, N, 0);
//如果index《0，則hash值=0之前沒有儲存過資料
if (index < 0) {
return index;
}
//如果index>=0,說明該hash值，之前儲存過資料，找到對應的key，比對key是否等於null。相等的話，返回index。說明要替換。
//關於array中對應資料的位置，是index*2 = key ,index*2+1 = value.
if (null == mArray[index<<1]) {
return index;
}
//以下兩個for迴圈是在出現hash衝突的情況下，找到正確的index的過程：
//從index+1,遍歷到陣列末尾，找到hash值相等，且key相等的位置，返回
int end;
for (end = index + 1; end < N && mHashes[end] == 0; end++) {
if (null == mArray[end << 1]) return end;
}
//從index-1,遍歷到陣列頭，找到hash值相等，且key相等的位置，返回
for (int i = index - 1; i >= 0 && mHashes[i] == 0; i--) {
if (null == mArray[i << 1]) return i;
}
// key沒有找到，返回一個負數。代表應該插入的位置
return ~end;
}
//根據key和key的hash值，返回index
int indexOf(Object key, int hash) {
//N為當前集合size
final int N = mSize;
//如果當前集合是空的，返回~0
if (N == 0) {
return ~0;
}
//根據hash值，通過二分查詢，查詢到目標index
int index = ContainerHelpers.binarySearch(mHashes, N, hash);
//如果index《0，說明該hash值之前沒有儲存過資料
if (index < 0) {
return index;
}
//如果index>=0,說明該hash值，之前儲存過資料，找到對應的key，比對key是否相等。相等的話，返回index。說明要替換。
if (key.equals(mArray[index<<1])) {
return index;
}
//以下兩個for迴圈是在出現hash衝突的情況下，找到正確的index的過程：
//從index+1,遍歷到陣列末尾，找到hash值相等，且key相等的位置，返回
int end;
for (end = index + 1; end < N && mHashes[end] == hash; end++) {
if (key.equals(mArray[end << 1])) return end;
}
//從index-1,遍歷到陣列頭，找到hash值相等，且key相等的位置，返回
for (int i = index - 1; i >= 0 && mHashes[i] == hash; i--) {
if (key.equals(mArray[i << 1])) return i;
}
// key沒有找到，返回一個負數。代表應該插入的位置
return ~end;
}複製程式碼4.2 批量增 putAll(Map<? extends K, ? extends V> map)
除了上一張介紹過的public void putAll(ArrayMap<? extends K, ? extends V> array),還有一個批量增的方法：
//批量增，接受更為廣泛的Map引數
public void putAll(Map<? extends K, ? extends V> map) {
//確保空間容量足夠
ensureCapacity(mSize + map.size());
for (Map.Entry<? extends K, ? extends V> entry : map.entrySet()) {
//分別呼叫單個增方法 add
put(entry.getKey(), entry.getValue());
}
}複製程式碼小結：
增的流程：1 先根據key得到hash值，2 根據hash值得到index 3 根據index正負，得知是插入還是替換 4 如果是替換直接替換值即可 5 如果是插入，則先判斷是否需要擴容，並進行擴容 6 挪動陣列位置，插入元素（類似ArrayList）
插入允許key為null，value為null。
- 每次插入時，根據key的雜湊值，利用二分查詢，去尋找key在
int[] mHashes陣列中的下標位置。 - 如果出現了hash衝突，則從需要從目標點向兩頭遍歷，找到正確的index。
- 如果index>=0,說明之前已經存在該key，需要替換（改）。
- 如果index<0,說明沒有找到。（也是二分法特性）對index去反，可以得到這個index應該插入的位置。
- 根據
key的hash值在mHashs中的index，如何得到key、value在mArray中的下標位置呢？key的位置是index*2，value的位置是index*2+1,也就是說mArray是利用連續的兩位空間去存放key、value。 - 根據
hash值的index計算，key、value的index也利用了位運算。index<<1 和 (index<<1)+1
5 刪
5.1 單個刪
//如果對應key有元素存在，返回value。否則返回null
public V remove(Object key) {
//根據key，找到下標
final int index = indexOfKey(key);
if (index >= 0) {
//如果index>=0,說明key有對應的元素存在，則去根據下標刪除
return removeAt(index);
}
//否則返回null
return null;
}複製程式碼 //根據下標刪除元素
public V removeAt(int index) {
//根據index，得到value
final Object old = mArray[(index << 1) + 1];
//如果之前的集合長度小於等於1，則執行過刪除操作後，集合現在就是空的了
if (mSize <= 1) {
// Now empty.
if (DEBUG) Log.d(TAG, "remove: shrink from " + mHashes.length + " to 0");
//釋放回收空間
freeArrays(mHashes, mArray, mSize);
//置空
mHashes = EmptyArray.INT;
mArray = EmptyArray.OBJECT;
mSize = 0;
} else {//根據元素數量和集合佔用的空間情況，判斷是否要執行收縮操作
//如果 mHashes長度大於8，且 集合長度 小於當前空間的 1/3,則執行一個 shrunk，收縮操作，避免空間的浪費
if (mHashes.length > (BASE_SIZE*2) && mSize < mHashes.length/3) {
// Shrunk enough to reduce size of arrays. We dont allow it to
// shrink smaller than (BASE_SIZE*2) to avoid flapping between
// that and BASE_SIZE.
//如果當前集合長度大於8，則n為當前集合長度的1.5倍。否則n為8.
//n 為收縮後的 mHashes長度
final int n = mSize > (BASE_SIZE*2) ? (mSize + (mSize>>1)) : (BASE_SIZE*2);
if (DEBUG) Log.d(TAG, "remove: shrink from " + mHashes.length + " to " + n);
//分配新的更小的空間（收縮操作）
final int[] ohashes = mHashes;
final Object[] oarray = mArray;
allocArrays(n);
//刪掉一個元素，所以修改集合元素數量
mSize--;
//因為執行了收縮操作，所以要將老資料複製到新陣列中。
if (index > 0) {
if (DEBUG) Log.d(TAG, "remove: copy from 0-" + index + " to 0");
System.arraycopy(ohashes, 0, mHashes, 0, index);
System.arraycopy(oarray, 0, mArray, 0, index << 1);
}
//在複製的過程中，排除不復制當前要刪除的元素即可。
if (index < mSize) {
if (DEBUG) Log.d(TAG, "remove: copy from " + (index+1) + "-" + mSize
+ " to " + index);
System.arraycopy(ohashes, index + 1, mHashes, index, mSize - index);
System.arraycopy(oarray, (index + 1) << 1, mArray, index << 1,
(mSize - index) << 1);
}
} else {//不需要收縮
//修改集合長度
mSize--;
//類似ArrayList，用複製操作去覆蓋元素達到刪除的目的。
if (index < mSize) {
if (DEBUG) Log.d(TAG, "remove: move " + (index+1) + "-" + mSize
+ " to " + index);
System.arraycopy(mHashes, index + 1, mHashes, index, mSize - index);
System.arraycopy(mArray, (index + 1) << 1, mArray, index << 1,
(mSize - index) << 1);
}
//記得置空，以防記憶體洩漏
mArray[mSize << 1] = null;
mArray[(mSize << 1) + 1] = null;
}
}
//返回刪除的值
return (V)old;
}複製程式碼5.2 批量刪除
//從ArrayMap中，刪除Collection集合中，所有出現的key。
//返回值代表是否成功刪除元素
public boolean removeAll(Collection<?> collection) {
return MapCollections.removeAllHelper(this, collection);
}
//MapCollections.removeAllHelper(this, collection);
//遍歷Collection，呼叫Map.remove(key)去刪除元素;
public static <K, V> boolean removeAllHelper(Map<K, V> map, Collection<?> collection) {
int oldSize = map.size();
Iterator<?> it = collection.iterator();
while (it.hasNext()) {
map.remove(it.next());
}
//如果元素不等，說明成功刪除元素
return oldSize != map.size();
}複製程式碼- 根據元素數量和集合佔用的空間情況，判斷是否要執行收縮操作
- 類似ArrayList，用複製操作去覆蓋元素達到刪除的目的。
6 查
當你想獲取某個value的時候，ArrayMap會計算輸入key轉換過後的hash值，然後對hash陣列使用二分查詢法尋找到對應的index，然後我們可以通過這個index在另外一個陣列中直接訪問到需要的鍵值對。如果在第二個陣列鍵值對中的key和前面輸入的查詢key不一致，那麼就認為是發生了碰撞衝突。為了解決這個問題，我們會以該key為中心點，分別上下展開，逐個去對比查詢，直到找到匹配的值。如下圖所示：
隨著陣列中的物件越來越多，查詢訪問單個物件的花費也會跟著增長，這是在記憶體佔用與訪問時間之間做權衡交換。
6.1 單個查
public V get(Object key) {
//根據key去得到index
final int index = indexOfKey(key);
//根據 index*2+1 得到value
return index >= 0 ? (V)mArray[(index<<1)+1] : null;
}
public int indexOfKey(Object key) {
//判斷key是否是null，並去查詢key對應的index
return key == null ? indexOfNull()
: indexOf(key, mIdentityHashCode ? System.identityHashCode(key) : key.hashCode());
}複製程式碼總結
ArrayMap的實現細節很多地方和ArrayList很像，由於我們之前分析過面試必備：ArrayList原始碼解析（JDK8）。所以對於用陣列複製覆蓋去完成刪除等操作的細節，就比較容易理解了。
- 每次插入時，根據key的雜湊值，利用二分查詢，去尋找key在
int[] mHashes陣列中的下標位置。 - 如果出現了hash衝突，則從需要從目標點向兩頭遍歷，找到正確的index。
- 擴容時，會檢視之前是否有快取的 int[]陣列和object[]陣列
- 如果有，複用給mArray mHashes
- 擴容規則：如果容量大於8，則擴容一半。（類似ArrayList）
- 根據
key的hash值在mHashs中的index，如何得到key、value在mArray中的下標位置呢？key的位置是index*2，value的位置是index*2+1,也就是說mArray是利用連續的兩位空間去存放key、value。 - 根據元素數量和集合佔用的空間情況，判斷是否要執行收縮操作
- 如果 mHashes長度大於8，且 集合長度 小於當前空間的 1/3,則執行一個 shrunk，收縮操作，避免空間的浪費
- 類似ArrayList，用複製操作去覆蓋元素達到刪除的目的。