美文网首页
ArrayList 源码分析(JDK1.8)

ArrayList 源码分析(JDK1.8)

作者: fran_cis_ | 来源:发表于2019-04-29 13:50 被阅读0次

一、目录

  • 源码分析
    1. 构造器
    2. 插入
    3. 删除
    4. 迭代器(注意: foreach 做删除操作抛出异常问题)
  • 总结
  • 示例代码
  • 参考资料

二、源码分析

1. 构造器

private static final Object[] EMPTY_ELEMENTDATA = {};
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
transient Object[] elementData;

// 参数表示初始化容量
public ArrayList(int initialCapacity) {
    if (initialCapacity > 0) {
        this.elementData = new Object[initialCapacity];
    } else if (initialCapacity == 0) {
        // 空数组 {}
        // private static final Object[] EMPTY_ELEMENTDATA = {};
        this.elementData = EMPTY_ELEMENTDATA;
    } else {
        //容量 < 0 , 报异常
        throw new IllegalArgumentException("Illegal Capacity: "+
                                           initialCapacity);
    }
}

// 无参构造器
public ArrayList() {
    // 默认创建一个空数组 {}
    // private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
    this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
}

两个构造器都是初始化底层数组 elementData , 区别在于无参构造方法会创建一个空数组, 插入元素时, 扩容将会按默认值重新初始化数组, 有参构造方法则会根据参数创建一个长度 >=0 的数组.


2. 插入

private int size;
protected transient int modCount = 0;
private static final int DEFAULT_CAPACITY = 10;

public boolean add(E e) {
    // 确定集合容量(是否扩容)
    ensureCapacityInternal(size + 1); 
    // 添加元素到集合的尾部, size +1
    elementData[size++] = e;
    return true;
}

public void add(int index, E element) {
    // 检查插入索引是否符合规范
    rangeCheckForAdd(index);
    // 确定集合容量(是否扩容)
    ensureCapacityInternal(size + 1);
    // 将 index 及其之后的元素向后移动一位
    System.arraycopy(elementData, index, elementData, index + 1,
                     size - index);
    // 替换掉 index 元素
    elementData[index] = element;
    size++;
}

public boolean addAll(Collection<? extends E> c) {
    // 集合转数组
    Object[] a = c.toArray();
    int numNew = a.length
    // 确定集合容量(是否扩容)
    ensureCapacityInternal(size + numNew);  
    // 将数组元素添加到集合尾部
    System.arraycopy(a, 0, elementData, size, numNew);
    size += numNew;
    return numNew != 0;
}

对于在数组尾部插入元素

  1. 检查是否需要扩容
  2. 将元素插入至数组尾部

对于根据索引插入元素

  1. 检查是否需要扩容
  2. 将 index 及其之后的元素向后移动一位
  3. 替换掉 index 元素

对于插入集合元素

  1. 将集合转成数组
  2. 检查是否需要扩容
  3. 将数组元素添加到集合尾部
private void ensureCapacityInternal(int minCapacity) {
    // 假如集合初始化时为空数组 {}
    if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
        // 获取最小容量
        // private static final int DEFAULT_CAPACITY = 10;
        minCapacity = Math.max(DEFAULT_CAPACITY, minCapacity);
    }
    // 确定集合容量(是否扩容)
    ensureExplicitCapacity(minCapacity);
}

private void ensureExplicitCapacity(int minCapacity) {
    modCount++;

    // 假如集合容量大于初始化长度
    if (minCapacity - elementData.length > 0)
        // 扩容
        grow(minCapacity);
}
private void grow(int minCapacity) {
    int oldCapacity = elementData.length;
    // 等价于 int newCapacity = oldCapacity + (oldCapacity * 0.5);
    // 扩容1.5倍
    int newCapacity = oldCapacity + (oldCapacity >> 1);
    if (newCapacity - minCapacity < 0)
        newCapacity = minCapacity;
    if (newCapacity - MAX_ARRAY_SIZE > 0)
        newCapacity = hugeCapacity(minCapacity);
    // 扩容
    elementData = Arrays.copyOf(elementData, newCapacity);
}

扩容是按照之前容量的1.5倍进行扩充, 假如初始化数组为空, 则扩容容量为10, 扩容容量最大值为 Integer.MAX_VALUE


3. 删除

public E remove(int index) {
    // 检查索引是否符合规范, index >= size 抛出异常
    rangeCheck(index);

    modCount++;
    E oldValue = elementData(index);
    // 从索引开始到最后的数组长度
    int numMoved = size - index - 1;
    if (numMoved > 0)
        // 将 index + 1 及之后的元素向前移动一位,覆盖被删除值
        System.arraycopy(elementData, index+1, elementData, index,
                         numMoved);
    // 最后一个元素设置为 null, size -1
    elementData[--size] = null; 

    return oldValue;
}


public boolean remove(Object o) {
    if (o == null) {
        // 遍历整个数组
        for (int index = 0; index < size; index++)
            if (elementData[index] == null) {
                fastRemove(index);
                return true;
            }
    } else {
        for (int index = 0; index < size; index++)
            if (o.equals(elementData[index])) {
                fastRemove(index);
                return true;
            }
    }
    return false;
}


private void fastRemove(int index) {
    modCount++;
    int numMoved = size - index - 1;
    if (numMoved > 0)
        System.arraycopy(elementData, index+1, elementData, index,
                         numMoved);
    elementData[--size] = null; 
}


public void clear() {
    modCount++;

    // 遍历, 清空所有元素
    for (int i = 0; i < size; i++)
        elementData[i] = null;

    size = 0;
}

根据索引删除元素

  1. 将 index + 1 及之后的元素向前移动一位,覆盖被删除值
  2. 最后一个元素设置为 null, size -1
  3. 返回被删除的元素

根据对象删除元素

  1. 遍历整个数组
  2. 判断数组是否含有该元素
  3. 删除该元素

清空元素

  1. 遍历, 将所有元素设置为null

注意:

public void trimToSize() {
    modCount++;
    if (size < elementData.length) {
        elementData = (size == 0)
          ? EMPTY_ELEMENTDATA
          : Arrays.copyOf(elementData, size);
    }
}

往 ArrayList 插入大量元素, 然后又删除了很多元素, 此时底层数组会空出大量的空间. 使用 trimToSize() 方法可以解决这个问题


4. 迭代器

private class Itr implements Iterator<E> {
    // 下一个元素索引
    int cursor;       
    // 上一个元素索引
    int lastRet = -1; 
    int expectedModCount = modCount;

    public boolean hasNext() {
        // 如果cursor == size,说明已经遍历完了,上一次遍历的是最后一个元素
        return cursor != size;
    }

    @SuppressWarnings("unchecked")
    public E next() {
        // 检验在遍历过程中集合是否有做 add, remove 操作
        checkForComodification();
        int i = cursor;
        if (i >= size)
            throw new NoSuchElementException();
        Object[] elementData = ArrayList.this.elementData;
        if (i >= elementData.length)
            throw new ConcurrentModificationException();
        // 下一个元素索引 = 元素索引 +1
        cursor = i + 1;
        // 返回迭代对象, 上一个元素索引 = 元素索引
        return (E) elementData[lastRet = i];
    }

    public void remove() {
        // 假如 lastRet < 0, 未获取元素, 无法做删除操作, 抛出异常
        if (lastRet < 0)
            throw new IllegalStateException();
        // 检验在遍历过程中集合是否有做 add, remove 操作
        checkForComodification();

        try {
            // 根据索引做删除操作
            ArrayList.this.remove(lastRet);
            // 下一个元素索引 = 元素索引
            cursor = lastRet;
            // 下一个元素索引 = -1
            lastRet = -1;
            expectedModCount = modCount;
        } catch (IndexOutOfBoundsException ex) {
            throw new ConcurrentModificationException();
        }
    }
    
    final void checkForComodification() {
        if (modCount != expectedModCount)
            throw new ConcurrentModificationException();
    }
}

注意:
关于 foreach 遍历做删除操作时抛出异常的问题

  ArrayList<Object> list = new ArrayList<>();
  list.add(1);
  list.add(2);
  list.add(3);
  list.add(4);
  
  for (Object o : list) {
      if (Objects.equals(2, o)) {
          list.remove(o);
      }
  }

Java 中的 foreach 经过编译器编译之后会被转换成迭代器遍历的方式, 等价于

  ArrayList<Object> list = new ArrayList();
  list.add(1);
  list.add(2);
  list.add(3);
  list.add(4);
  Iterator var2 = list.iterator();
  
  while(var2.hasNext()) {
      Object o = var2.next();
      if (Objects.equals(2, o)) {
          list.remove(o);
      }
  }

根据上面的代码可知, list 经过 remove 操作 modCount 会进行 +1 操作, 等到下一轮循环的 next() 方法中, checkForComodification() 方法用来判断 list 是否有进行 add / remove 操作, 此时 modCount +1, modCount != expectedModCount 为 true , 抛出 ConcurrentModificationException 异常


三、总结

  • ArrayList 基于数组实现, 可扩容
  • 添加元素时可能要扩容, 删除元素时不会自动减少容量, 可以使用 trimToSize() 方法进行缩容处理**
  • 线程不安全
  • add(int index, E element) 添加元素到指定位置, 需要将索引及其以后的元素整块向后移动一位(使用 System.arraycopy 方法)
  • remove(Object o) 需要遍历数组
  • remove(int index) 不需要遍历, 效率高于remove(Object o)
  • contains(E) 亦需要遍历数组

四、示例代码

public static void main(String[] args) {
    byte[]  srcBytes = new byte[]{1,2,3,4,5,6};  // 源数组
    System.arraycopy(srcBytes, 1, srcBytes, 3, 2);
    System.out.println(Arrays.toString(srcBytes));
    byte[]  srcBytes2 = new byte[]{1,2,3,4,5,6};
    byte[]  desBytes = Arrays.copyOf(srcBytes2, 3);
    System.out.println(Arrays.toString(desBytes));

    ArrayList<Object> list = new ArrayList<>();
    list.add("sss");
    list.add("xxx");
    list.add("zzz");
    list.add("yyy");
    list.add(1, "ooo");
    list.remove(1);
    list.remove("yyy");
    list.set(1, "mmm");
    list.get(1);
    list.trimToSize();
    System.out.println(list.toString());
    Iterator<Object> iterator = list.iterator();
    while (iterator.hasNext()) {
        Object temp = iterator.next();
        System.out.println(temp);
        if (Objects.equals("zzz", temp)) {
            iterator.remove();
        }
    }
    System.out.println(list.toString());

    ArrayList<Object> list2 = new ArrayList<>(2);
    list2.add(1);
    list2.add(2);
    list.addAll(list2);

    System.out.println("---");

    for (Object o : list) {
        if (Objects.equals("sss", o)) {
            list.remove(o);
        }
    }
    System.out.println(list.toString());
}

运行结果:

[1, 2, 3, 2, 3, 6]
[1, 2, 3]
[sss, mmm, zzz]
sss
mmm
zzz
[sss, mmm]
---
Exception in thread "main" java.util.ConcurrentModificationException
    at java.util.ArrayList$Itr.checkForComodification(ArrayList.java:901)
    at java.util.ArrayList$Itr.next(ArrayList.java:851)
    at Main.main(Main.java:145)

五、参考资料

Java集合之ArrayList源码分析
ArrayList源码解析
ArrayList 源码分析

相关文章

网友评论

      本文标题:ArrayList 源码分析(JDK1.8)

      本文链接:https://www.haomeiwen.com/subject/ehjynqtx.html