Java教程
ArrayList源码分析
ArrayList和HashMap可以说是我在平时开发过程中用到的最多的两个集合类了，前面对HashMap的源码进行分析过后，再来看ArrayList的源码，相对来说就轻松很多了。
ArrayList的特点
1.ArrayList本质上就是一个可变大小的数组。
2.ArrayList允许存放null在内的任何元素，且可以存放重复的元素，所以也可以插入存多个null。
3.是一个有序容器，保持了每个元素的插入顺序。
4.ArrayList是非线程安全的。
ArrayList数据结构
容量：CAPACITY ； 实际大小：size。
ArrayList底层的数据结构就是数组，数组元素类型为Object类型，即可以存放所有类型数据。我们对ArrayList类的实例的所有的操作底层都是基于数组的。
ArrayList的属性值
// 序列化id
private static final long serialVersionUID = 8683452581122892189L;
/**
* Default initial capacity. 默认的初始化容量
*/
private static final int DEFAULT_CAPACITY = 10;
/**
* Shared empty array instance used for empty instances.
* 指定该ArrayList容量为0时，返回该空数组。
*/
private static final Object[] EMPTY_ELEMENTDATA = {};
/**
* 当调用无参构造方法，返回的是该数组。刚创建一个ArrayList 时，其内数据量为0。
* 它与EMPTY_ELEMENTDATA的区别就是：该数组是默认返回的，而EMPTY_ELEMENTDATA是在用户指定容量为0时返回。
*/
private static final Object[] DEFAULTCAPACITY_EMPTY_ELEMENTDATA = {};
/**
* 保存添加到ArrayList中的元素。
* ArrayList的容量就是该数组的长度。
* 被标记为transient，在对象被序列化的时候不会被序列化。
*/
transient Object[] elementData; // non-private to simplify nested class access
/**
* The size of the ArrayList (the number of elements it contains).
* ArrayList的实际大小（数组包含的元素个数/实际数据的数量）默认为0
* @serial
*/
private int size;
/**
* 分派给arrays的最大容量
* 为什么要减去8呢？
* 因为某些VM会在数组中保留一些头字，尝试分配这个最大存储容量，可能会导致array容量大于VM的limit，最终导致OutOfMemoryError。
*/
private static final int MAX_ARRAY_SIZE = Integer.MAX_VALUE - 8;
//备注：MAX.VALUE为0x7fffffff，转换成十进制就是2147483647，也就是数组的最大长度是2147483639；
ArrayList的构造方法
ArrayList提供了三种构造方法：
ArrayList(int initialCapacity)：构造一个指定容量为capacity的空ArrayList。这是一个带初始容量大小的有参构造函数。
（1）初始容量大于0，实例化数组，将自定义的容量大小当成初始化elementData的大小。
（2）初始容量等于0，将空数组赋给elementData。
（3）初始容量小于0，抛异常。
/**
* Constructs an empty list with the specified initial capacity.
* 构造具有指定初始容量的空List
* @param initialCapacity the initial capacity of the list （list的初始化容量）
* @throws IllegalArgumentException if the specified initial capacity is negative
* 如果指定的初始容量为负，抛出异常
*/
public ArrayList(int initialCapacity) {
if (initialCapacity > 0) {
this.elementData = new Object[initialCapacity];
} else if (initialCapacity == 0) {
this.elementData = EMPTY_ELEMENTDATA;
} else {
throw new IllegalArgumentException("Illegal Capacity: "+
initialCapacity);
}
}
ArrayList()：构造一个初始容量为 10 的空列表。从上面的属性我们知道DEFAULTCAPACITY_EMPTY_ELEMENTDATA是一个空的Object[]，那为啥说它的初始化容量为10呢？其实ArrayList也是使用的懒加载机制，初始化为空，但是在第一次添加元素时，会进行扩容操作，将elementData的长度变为默认值：10。
/**
* Constructs an empty list with an initial capacity of ten.
*/
public ArrayList() {
this.elementData = DEFAULTCAPACITY_EMPTY_ELEMENTDATA;
}
ArrayList(Collection<? extends E> c)：构造一个包含指定 collection 的元素的列表，这些元素是按照该 collection 的迭代器返回它们的顺序排列的。这个有参构造方法构造时赋的值是它的父类Collection对象。
/**
* Constructs a list containing the elements of the specified
* collection, in the order they are returned by the collection's
* iterator.
*构造一个包含指定 collection 的元素的列表，这些元素是按照该 collection 的迭代器返回它们的顺序排列的。
* @param c the collection whose elements are to be placed into this list
* 其元素将放置在此列表中的 collection
* @throws NullPointerException if the specified collection is null
* 如果指定的 collection 为 null
*/
public ArrayList(Collection<? extends E> c) {
elementData = c.toArray();
if ((size = elementData.length) != 0) {
// c.toArray might (incorrectly) not return Object[] (see 6260652)
//每个集合的toarray()的实现方法不一样，所以需要判断一下，如果不是Object[].class类型，那么就需要使用ArrayList中的方法去改造一下。
if (elementData.getClass() != Object[].class)
//copyOf(要复制的数组,要返回的副本的长度,要返回的副本的类)
elementData = Arrays.copyOf(elementData, size, Object[].class);
} else {
// replace with empty array.
this.elementData = EMPTY_ELEMENTDATA;
}
}
ArrayList的构造方法就做一件事情，就是初始化一下储存数据的容器，其实本质上就是一个数组，在其中就叫elementData。
ArrayList的主要方法
get()方法
/**
* Returns the element at the specified position in this list.
* 返回list中指定位置的元素
* @param index index of the element to return 要返回的元素的索引
* @return the element at the specified position in this list
位于list中指定位置的元素
* @throws IndexOutOfBoundsException {@inheritDoc}
*/
public E get(int index) {
rangeCheck(index);//越界检查
return elementData(index);//返回索引为index的元素
}
/**
* Checks if the given index is in range. If not, throws an appropriate
* runtime exception. This method does *not* check if the index is
* negative: It is always used immediately prior to an array access,
* which throws an ArrayIndexOutOfBoundsException if index is negative.
检查指定索引是否在范围内。如果不在，抛出一个运行时异常。
这个方法不检查索引是否为负数，它总是在数组访问之前立即优先使用，
如果给出的索引index>=size，抛出一个越界异常
*/
private void rangeCheck(int index) {
if (index >= size)
throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}
/**
* Constructs an IndexOutOfBoundsException detail message.
* Of the many possible refactorings of the error handling code,
* this "outlining" performs best with both server and client VMs.
*/
private String outOfBoundsMsg(int index) {
return "Index: "+index+", Size: "+size;
}
// Positional Access Operations 位置访问操作
// 返回索引为index的元素
@SuppressWarnings("unchecked")
E elementData(int index) {
return (E) elementData[index];
}
因为ArrayList底层是数组，所以它的get方法非常简单，先是判断一下有没有越界（索引小于0或者大于等于数组实际长度，错误信息返回索引和数组的实际长度），之后就直接通过数组下标来获取元素。
set()方法
/**
* Replaces the element at the specified position in this list with
* the specified element.
* 用指定的元素替换列表中指定位置的元素。
* @param index index of the element to replace 要替换的元素的索引
* @param element element to be stored at the specified position 要存储在指定位置的元素
* @return the element previously at the specified position 先前位于指定位置的元素(返回被替换的元素)
* @throws IndexOutOfBoundsException {@inheritDoc} 如果参数指定索引index>=size，抛出一个越界异常
*/
public E set(int index, E element) {
//检查索引是否越界。如果参数指定索引index>=size，抛出一个越界异常
rangeCheck(index);
//记录被替换的元素（旧值）
E oldValue = elementData(index);
//替换元素（新值）
elementData[index] = element;
//返回被替换的元素
return oldValue;
}
确保set的位置小于当前数组的长度（size）并且大于0，获取指定位置（index）元素，然后放到oldValue存放，将需要设置的元素放到指定的位置（index）上，然后将原来位置上的元素oldValue返回给用户。
add()方法
add的方法有两个，一个是带一个参数的add(E e)，一个是带两个参数的add(int index, E e)。
boolean add(E e)方法
/**
* Appends the specified element to the end of this list.
* 将指定的元素追加到此列表的末尾
* @param e element to be appended to this list 被添加到list的元素
* @return <tt>true</tt> (as specified by {@link Collection#add})
*/
public boolean add(E e) {
//确认list是否需要扩容
ensureCapacityInternal(size + 1); // Increments modCount!!
//将元素e放在size的位置上,并且size++
elementData[size++] = e;
return true;
}
//数组容量检查，不够时则进行扩容，只供类内部使用
private void ensureCapacityInternal(int minCapacity) {
ensureExplicitCapacity(calculateCapacity(elementData, minCapacity));
}
private static int calculateCapacity(Object[] elementData, int minCapacity) {
// 若elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA，则取minCapacity为DEFAULT_CAPACITY和参数minCapacity之间的最大值。DEFAULT_CAPACITY在此之前已经定义为默认的初始化容量是10。
if (elementData == DEFAULTCAPACITY_EMPTY_ELEMENTDATA) {
return Math.max(DEFAULT_CAPACITY, minCapacity);
}
return minCapacity;
}
//数组容量检查，不够时则进行扩容，只供类内部使用
// minCapacity 想要的最小容量
private void ensureExplicitCapacity(int minCapacity) {
modCount++;
// overflow-conscious code
//最小容量>数组缓冲区当前长度
if (minCapacity - elementData.length > 0)
grow(minCapacity);//扩容
}
这个add 方法是在list的末尾添加一个元素。
ensureCapacityInternal(size + 1)方法中，size是数组中当前数据的个数，因为要添加一个元素，所以size+1，先判断size+1的这个个数数组能否放得下。
calculateCapacity方法用来计算容量。判断初始化的elementData是不是空的数组，如果是空数组，就返回数组长度的默认值10，否则就返回size + 1。
minCapacity代表着elementData中元素增加之后的实际数据个数。
ensureExplicitCapacity(int minCapacity)方法的入参就是calculateCapacity()方法的返回值，如果该值大于了当前数组的长度，就需要扩容。
其实，它的实现原理就是这样的：
（1）如果elementData中的元素是空的，它现在需要的容量是默认值10，但是elementData.length为0，所以要扩容。
（2）如果elementData数组中的元素不是空的，若它添加一个元素后需要的容量比原数组长度大，就需要扩容，否则就不需要扩容。
下面是扩容的核心实现方法：grow(minCapacity)。
/**
* Increases the capacity to ensure that it can hold at least the
* number of elements specified by the minimum capacity argument.
*扩容，保证ArrayList至少能存储minCapacity个元素
* 第一次扩容，逻辑为newCapacity = oldCapacity + (oldCapacity >> 1);即在原有的容量基础上增加一半。
第一次扩容后，如果容量还是小于minCapacity，就将容量扩充为minCapacity。
* @param minCapacity the desired minimum capacity
*/
private void grow(int minCapacity) {
// overflow-conscious code
// 获取当前数组的容量
int oldCapacity = elementData.length;
// 扩容。新的容量=当前容量+当前容量/2.即将当前容量增加一半（当前容量增加1.5倍）。
int newCapacity = oldCapacity + (oldCapacity >> 1);
//如果扩容后的容量还是小于想要的最小容量
if (newCapacity - minCapacity < 0)
//将扩容后的容量再次扩容为想要的最小容量
newCapacity = minCapacity;
//elementData就空数组的时候，length=0，那么oldCapacity=0，newCapacity=0，在这里就是真正的初始化elementData的大小了，就是为10.
//如果扩容后的容量大于临界值，则进行大容量分配
if (newCapacity - MAX_ARRAY_SIZE > 0)
newCapacity = hugeCapacity(minCapacity);
// minCapacity is usually close to size, so this is a win:
//新的容量大小已经确定好了，就copy数组，改变容量大小。
//copyof(原数组，新的数组长度)
elementData = Arrays.copyOf(elementData, newCapacity);
}
//进行大容量分配
private static int hugeCapacity(int minCapacity) {
//如果minCapacity<0，抛出异常
if (minCapacity < 0) // overflow
throw new OutOfMemoryError();
//如果想要的容量大于MAX_ARRAY_SIZE，则分配Integer.MAX_VALUE，否则分配MAX_ARRAY_SIZE
return (minCapacity > MAX_ARRAY_SIZE) ?
Integer.MAX_VALUE :
MAX_ARRAY_SIZE;
}
扩容过程中，首先设定新的数组容量newCapacity为原来的数组容量oldCapacity的1.5倍，然后判断newCapacity是否小于minCapacity，如果小于就将minCapacity的值赋给newCapacity。这一步是为什么呢？这是因为如果要数组为空或或者添加的是一个集合的元素时（addAll()方法也会调用该方法进行扩容），扩容1.5倍后，可能还是不能满足要求。比如说当前数组为空，那oldCapacity为0，扩容后还是0，所以就将minCapacity的值赋给它。
接着会判断扩容后的容量是否大于临界值MAX_ARRAY_SIZE，如果是则进行大容量分配。
void add(int index, E element)方法
/**
* Inserts the specified element at the specified position in this
* list. Shifts the element currently at that position (if any) and
* any subsequent elements to the right (adds one to their indices).
*将指定元素插入到列表中的指定位置。将当前位于该位置的元素(如果有的话)和随后的任何元素向右移动(将一个元素添加到它们的索引中)。
* @param index index at which the specified element is to be inserted
* 要插入指定元素的索引(即将插入元素的位置)
* @param element element to be inserted 即将插入的元素
* @throws IndexOutOfBoundsException {@inheritDoc} 如果索引超出size
*/
public void add(int index, E element) {
//越界检查
rangeCheckForAdd(index);
//确认list容量，确认是否需要扩容
ensureCapacityInternal(size + 1); // Increments modCount!!
// 对数组进行复制处理，目的就是空出index的位置插入element，并将index后的元素位移一个位置
//在插入元素之前，要先将index之后的元素都往后移一位
//arraycopy(原数组，源数组中的起始位置，目标数组，目标数据中的起始位置，要复制的数组元素的数量)
System.arraycopy(elementData, index, elementData, index + 1,
size - index);
//将指定的index位置赋值为element
elementData[index] = element;
//实际容量+1
size++;
}
/**
* A version of rangeCheck used by add and addAll.
*/
private void rangeCheckForAdd(int index) {
if (index > size || index < 0)//插入的位置不能大于size 和小于0，如果是就报越界异常
throw new IndexOutOfBoundsException(outOfBoundsMsg(index));
}
add(int index, E e)需要先对元素进行移动，然后完成插入操作。
remove()方法
E remove(int index)：根据索引remove，通过删除指定位置上的元素。
/**
* Removes the element at the specified position in this list.
* Shifts any subsequent elements to the left (subtracts one from their
* indices).
*删除list中位置为指定索引index的元素
* 索引之后的元素向左移一位
* @param index the index of the element to be removed 被删除元素的索引
* @return the element that was removed from the list 被删除的元素
* @throws IndexOutOfBoundsException {@inheritDoc} 如果参数指定索引index>=size，抛出一个越界异常
*/
public E remove(int index) {
//检查索引是否越界。如果参数指定索引index>=size，抛出一个越界异常
rangeCheck(index);
//结构性修改次数+1
modCount++;
//记录索引处的元素
E oldValue = elementData(index);
// 删除指定元素后，需要左移的元素个数
int numMoved = size - index - 1;
//如果有需要左移的元素，就移动（移动后，该删除的元素就已经被覆盖了）
if (numMoved > 0)
System.arraycopy(elementData, index+1, elementData, index,
numMoved);
// size减一，然后将索引为size-1处的元素置为null。为了让GC起作用，必须显式的为最后一个位置赋null值
elementData[--size] = null; // clear to let GC do its work
//返回被删除的元素
return oldValue;
}
从中我们可以看到根据索引删除元素的步骤：
1.进行越界检查
2.修改次数加1（modCount 可以用来检测快速失败的一种标志。）
3.通过索引找到要删除的元素
4.计算要移动的位数
5.移动元素（其实是覆盖掉要删除的元素）
6.将数组最后一位的位置赋值为null，让gc(垃圾回收机制)更快的回收它。
7.返回被删除的元素
boolean remove(Object o)
/**
* Removes the first occurrence of the specified element from this list,
* if it is present. If the list does not contain the element, it is
* unchanged. More formally, removes the element with the lowest index
* <tt>i</tt> such that
* <tt>(o==null ? get(i)==null : o.equals(get(i)))</tt>
* (if such an element exists). Returns <tt>true</tt> if this list
* contained the specified element (or equivalently, if this list
* changed as a result of the call).
*从列表中删除指定元素的第一个出现项，
如果它存在的话。如果列表不包含该元素，它将保持不变。更正式地说，删除索引最低的元素...
* @param o element to be removed from this list, if present
* @return <tt>true</tt> if this list contained the specified element
*/
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 remove method that skips bounds checking and does not
* return the value removed.
私有的remove方法，该方法跳过边界检查，并且不返回已删除的值。
*/
private void fastRemove(int index) {
modCount++;
int numMoved = size - index - 1;
if (numMoved > 0)
//arraycopy(原数组，源数组中的起始位置，目标数组，目标数据中的起始位置，要复制的数组元素的数量)
System.arraycopy(elementData, index+1, elementData, index,
numMoved);
elementData[--size] = null; // clear to let GC do its work
}
循环遍历所有对象，得到对象所在索引位置（找到第一个匹配的），然后调用fastRemove方法，执行remove操作。
indexOf()和lastIndexOf()方法
//返回此列表中指定元素的第一个出现项的索引，如果该列表不包含该元素，则返回-1。
public int indexOf(Object o) {
if (o == null) { // 查找的元素为空
for (int i = 0; i < size; i++) // 遍历数组，找到第一个为空的元素，返回下标
if (elementData[i]==null)
return i;
} else { // 查找的元素不为空
for (int i = 0; i < size; i++) // 遍历数组，找到第一个和指定元素相等的元素，返回下标
if (o.equals(elementData[i]))
return i;
}
return -1;
}
//返回此列表中指定元素的最后一次出现的索引，如果该列表不包含该元素，则返回-1。
public int lastIndexOf(Object o) {
if (o == null) {
for (int i = size-1; i >= 0; i--)
if (elementData[i]==null)
return i;
} else {
for (int i = size-1; i >= 0; i--)
if (o.equals(elementData[i]))
return i;
}
return -1;
}
clear()方法
/**
* Removes all of the elements from this list. The list will
* be empty after this call returns.
从列表中删除所有元素。该调用返回后，列表将为空。
*/
public void clear() {
modCount++;
// clear to let GC do its work
for (int i = 0; i < size; i++)
elementData[i] = null;
size = 0;
}
为什么说ArrayList是非线程安全的
简单来说，我们可以看下ArrayList的add()方法
1 public boolean add(E e) {
2 ensureCapacityInternal(size + 1); // Increments modCount!!
3 elementData[size++] = e;
4 return true;
5 }
elementData[size++] = e，这个步骤就是非线程安全的。可能会出现某个值为空或数组越界的情况。因为elementData[size++] = e为非原子操作，等同于elementData[size] = e;size++;
可能会导致的问题：
1.值被覆盖
2.值为null
3.数组越界异常
我们分别使用两个线程来模拟插入过程.例如有两个线程,分别加入插入元素。
运行过程如下：
1. 线程1 赋值 element[1] = e; 随后因为时间片用完而中断。
2. 线程2 赋值 element[1] = e; 随后因为时间片用完中断。
此处导致了之前所说的一个问题插入的值被另一个线程给覆盖掉了。
3. 线程1 自增 size++; (size=2)
4. 线程2 自增 size++; (size=3)
此处导致了某些值为null的问题。因为原size=1, 但是因为线程1与线程2都将值赋值给了element[1],导致了element[2]内没有值，被跳过了。指针index指向了3。所以,导致了某些情况下值为null的情况。
数组越界的情况：
前提条件: 当前size=1， 数组长度为2。
1. 线程1 判断数组是否越界.因为size=1 长度为2,没有越界.将进行赋值操作.但是因为时间片问题导致了中断.
2. 线程2 判断数组是否越界.因为size=1 长度为2,没有越界.将进行赋值操作.但是因为时间片问题导致了中断.
3. 线程1 重新获取到主动权.上文判断了长度刚刚好够用.进行赋值操作element[size]=2,并且size++
4. 线程2 因为上文判断了数组没有越界.所以进行赋值操作.但是此时的size=2了.再执行element[2]=2. 导致了数组越界了.
ArrayList和Vector区别
ArrayList和Vector都实现了List接口，他们都是有序集合，并且存放的元素是允许重复的。它们的底层都是通过数组来实现的，因此列表这种数据结构检索数据速度快，但增删速度慢（删除或增加数据时，可能会造成其他元素的位置的移动，add方法可以指定位置进行插入）。经常移动集合中元素的位置可以考虑使用LinkedList,底层用双向链表实现，移动某个元素的位置其他元素位置不移动（但LinkedList根据索引查询元素效率较低）。
线程安全性：Vector线程安全(方法上使用了synchronized)，ArrayList非线程安全。
数据增长：ArrayList每次增长原来的0.5倍，而Vector增长原来的一倍。ArrayList和Vector都可以设置初始空间的大小，Vector还可以设置增长的空间大小。
参考文档：
java1.8源码之ArrayList源码解读_技术探求-CSDN博客_arraylist源码
ArrayList 线程安全问题_Be yourself.-CSDN博客_arraylist线程安全吗
-
微服务架构中API版本控制的实践09-28
-
AI给的和自己写的Python代码，都无法改变输入框的内容，替换也不行09-28
-
Sentinel配置限流资料：新手入门教程09-27
-
Sentinel配置限流资料详解09-27
-
Sentinel限流资料：新手入门教程09-27
-
Sentinel限流资料入门详解09-26
-
Springboot框架资料：初学者入门教程09-26
-
Springboot框架资料详解：新手入门教程09-26
-
Springboot企业级开发资料：新手入门指南09-26
-
SpringBoot企业级开发资料新手指南09-26
-
Springboot微服务资料入门教程09-26
-
SpringBoot微服务资料入门指南09-26
-
Springboot项目开发资料：新手入门及初级实战教程09-26
-
Springboot项目开发资料：新手入门教程09-26
-
SpringCloud Alibaba资料入门详解09-26
