public SparseArray(int initialCapacity) {
if (initialCapacity == 0) {
mKeys = EmptyArray.INT;
mValues = EmptyArray.OBJECT;
} else {
mValues = ArrayUtils.newUnpaddedO
bjectArray(initialCapacity);
mKeys = new int[mValues.length];
}
mSize = 0;
}
添加元素
添加元素的方法有几个,主要看put(int key, E value)方法,当中用到了ContainerHelpers类提供的二分查找方法:binarySearch,用于查找目标key在mKeys中的当前索引(已有改key)或者是目标索引(没有该key)。
binarySearch方法的返回值分为两种情况:
如果mKeys中存在对应的key,则直接返回对应的索引值
如果mKeys中不存在对应的key
2.1 假设mKeys中存在值比key大且大小与key最接近的值的索引为presentIndex,则此方法的返回值为~presentIndex。
2.2 如果mKeys中不存在比key还要大的值的话,则返回值为~mKeys.length。
static int binarySearch(int[] array, int size, int value) {
int lo = 0;
int hi = size - 1;
while (lo <= hi) {
final int mid = (lo + hi) >>> 1;
final int midVal = array[mid];
if (midVal < value) {
lo = mid + 1;
} else if (midVal > value) {
hi = mid - 1;
} else {
return mid; // value found
}
}
return ~lo; // value not present
}
可以看到,即使在 mKeys 中不存在目标 key,但其返回值也指向了应该让 key 存入的位置。通过将计算出的索引值进行 ~ 运算,则返回值一定是 0 或者负数,从而与“找得到目标key的情况(返回值大于0)”的情况区分开。
从这个可以看出该方法的巧妙之处,单纯的一个返回值就可以区分出多种情况,且通过这种方式来存放数据可以使得 mKeys 的内部值一直是按照值递增的方式来排序的。
public void put(int key, E value) {
//用二分查找法查找指定 key 在 mKeys 中的索引值
int i = ContainerHelpers.binarySearch(mKeys, mSize, key);
//找得到则直接赋值
if (i >= 0) {
mValues[i] = value;
} else {
i = ~i;
//如果目标位置还未赋值,则直接存入数据即可,对应的情况是 2.1
if (i < mSize && mValues[i] == DELETED) {
mKeys[i] = key;
mValues[i] = value;
return;
}
//以下操作对应 2.1、2.2 两种情况:
if (mGarbage && mSize >= mKeys.length) {
gc();
//GC 后再次进行查找,因为值可能已经发生变化了
i = ~ContainerHelpers.binarySearch(mKeys, mSize, key);
}
//通过复制或者扩容数组,将数据存放到数组中
mKeys = GrowingArrayUtils.insert(mKeys, mSize, i, key);
mValues = GrowingArrayUtils.insert(mValues, mSize, i, value);
mSize++;
}
}
移除元素
上文说了,布尔变量mGarbage用于标记当前是否有待垃圾回收(GC)的元素,当该值被置为true时,即意味着当前状态需要进行垃圾回收,但回收操作并不马上进行,而是在后续操作中再完成。以下几个方法在移除元素时,都是只切断了mValues中的引用,而mKeys并没有进行回收,这个操作会留到gc()进行处理。
//如果存在 key 对应的元素值,则将其移除
public void delete(int key) {
//用二分查找法查找指定 key 在 mKeys 中的索引值
int i = ContainerHelpers.binarySearch(mKeys, mSize, key);
if (i >= 0) {
if (mValues[i] != DELETED) {
mValues[i] = DELETED;
//标记当前需要进行垃圾回收
mGarbage = true;
}
}
}
//和 delete 方法基本相同,差别在于会返回 key 对应的元素值
public E removeReturnOld(int key) {
int i = ContainerHelpers.binarySearch(mKeys, mSize, key);
if (i >= 0) {
if (mValues[i] != DELETED) {
final E old = (E) mValues[i];
mValues[i] = DELETED;
mGarbage = true;
return old;
}
}
return null;
}
//省略其它几个比较简单的移除元素的方法
查找元素
查找元素的方法较多,但逻辑都是挺简单的。
//根据 key 查找相应的元素值,查找不到则返回默认值
@SuppressWarnings(“unchecked”)
public E get(int key, E valueIfKeyNotFound) {
//用二分查找法查找指定 key 在 mKeys 中的索引值
int i = ContainerHelpers.binarySearch(mKeys, mSize, key);
//如果找不到该 key 或者该 key 尚未赋值,则返回默认值
if (i < 0 || mValues[i] == DELETED) {
return valueIfKeyNotFound;
} else {
return (E) mValues[i];
}
}
//根据 value 查找对应的索引值
public int indexOfValue(E value) {
if (mGarbage) {
gc();
}
for (int i = 0; i < mSize; i++) {
if (mValues[i] == value) {
return i;
}
}
return -1;
}
//与 indexOfValue 方法类似,但 indexOfValue 方法是通过比较 == 来判断是否同个对象
//而此方法是通过 equals 方法来判断是否同个对象
public int indexOfValueByValue(E value) {
if (mGarbage) {
gc();
}
for (int i = 0; i < mSize; i++) {
if (value == null) {
if (mValues[i] == null) {
return i;
}
} else {
if (value.equals(mValues[i])) {
return i;
}
}
}
似,但 indexOfValue 方法是通过比较 == 来判断是否同个对象
//而此方法是通过 equals 方法来判断是否同个对象
public int indexOfValueByValue(E value) {
if (mGarbage) {
gc();
}
for (int i = 0; i < mSize; i++) {
if (value == null) {
if (mValues[i] == null) {
return i;
}
} else {
if (value.equals(mValues[i])) {
return i;
}
}
}