AtomicIntegerArray源码解析

一、前言

    AtomicIntegerArray类是java.util.concurrent.atomic包下的提供了可以以原子方式读取和写入的底层int数组的操作，还包含高级原子操作的并发数组类。 AtomicIntegerArray支持对底层int数组变量的原子操作。 它具有获取和设置方法，如在变量上的读取和写入。 也就是说，一个集合与同一变量上的任何后续get相关联。 原子compareAndSet方法也具有这些内存一致性功能。

二、源码解析

继承了哪些类

    由上图可知AtomicIntegerArray只继承了一个Serializable接口，其他什么也没有继承。

变量说明

//序列化序号，用来对对象进行反序列化时的判断
private static final long serialVersionUID = 2862133569453604235L;
//unsafe常量，设置为使用Unsafe.compareAndSwapInt进行更新，方法中多处需要使用unsafe变量
private static final Unsafe unsafe = Unsafe.getUnsafe();
//获取数组中第一个元素的内存地址
private static final int base = unsafe.arrayBaseOffset(int[].class);
//shift:转变，在这里表示左移
private static final int shift;
//存放元素的数组
private final int[] array;

shift是如何获取的？

static {
    //获取数据中单个元素占用的字节数
    int scale = unsafe.arrayIndexScale(int[].class);
    //判断数据类型缩放是不是2的幂，比如scale为4那么scale & (scale - 1)为 0100 & 0011 == 0
    if ((scale & (scale - 1)) != 0)
        throw new Error("data type scale not a power of two");
    //numberOfLeadingZeros表示将scale变成二进制位的话最左边有多少个0
    //numberOfLeadingZeros(scale)则为00000000 00000000 00000000 00000100
    //shift = 31 - 29 = 2，即左移2位
    shift = 31 - Integer.numberOfLeadingZeros(scale);
}

构造方法

    AtomicIntegerArray类的构造方法有两个，一个是自己根据参数length来new一个长度为length的数组，另外一个根据传入的数组参数将此参数数组赋值给变量array。

//构造方法创建长度为length的数组，并且赋值给数组元素array
public AtomicIntegerArray(int length) {
    array = new int[length];
}
//将参数数组赋值给元素变量数组
public AtomicIntegerArray(int[] array) {
    // Visibility guaranteed by final field guarantees
    this.array = array.clone();
}

两个特殊的方法

//检查下标i是否越界，并且返回其在内存中从base开始的偏移量
private long checkedByteOffset(int i) {
    //检查数组下标是否越界
    if (i < 0 || i >= array.length)
        throw new IndexOutOfBoundsException("index " + i);
    return byteOffset(i);
}
//返回下标i在内存中从base开始数的内存地址偏移量
private static long byteOffset(int i) {
    //比如i为2，从上可知shift为2，则 i << shift就是2*4
    return ((long) i << shift) + base;
}

    AtomicIntegerArray中大多数方法获取元素都是靠checkedByteOffset(int i) 方法来进行获取的，而checkedByteOffset(int i)又是靠byteOffset(int i)来实现的。

其他方法

① get(int i)方法。

//获取下标为i的元素
public final int get(int i) {
    //checkedByteOffset(i)表示检查下标是否越界并且返回下标i的从base开始的内存地址
    //getRaw(offset)方法就是根据内存偏移量来获取指定内存地址的元素
    return getRaw(checkedByteOffset(i));
}

//根据内存地址的偏移量获取数组的元素
private int getRaw(long offset) {
    return unsafe.getIntVolatile(array, offset);
}

② set(int i, int newValue)方法。

//插入新的值到指定数组下标的位置
public final void set(int i, int newValue) {
    unsafe.putIntVolatile(array, checkedByteOffset(i), newValue);
}

③ getAndSet(int i, int newValue)方法。

//根据下标获取数组中的元素的值，并且将此数组的下标的值变为新值newValue
public final int getAndSet(int i, int newValue) {
    return unsafe.getAndSetInt(array, checkedByteOffset(i), newValue);
}

④ compareAndSet(int i, int expect, int update)方法。

//根据数组下标获取数组元素，然后和expect进行比较，若一样，就将其值替换为update
//就是CAS的原理
public final boolean compareAndSet(int i, int expect, int update) {
    //compareAndSetRaw就是根据内存地址的偏移量中的值来与expect值进行比较
    return compareAndSetRaw(checkedByteOffset(i), expect, update);
}

//根据偏移量offset获取其内存地址的值，并且和expect进行比较，若相等就将其值替换为update
private boolean compareAndSetRaw(long offset, int expect, int update) {
    return unsafe.compareAndSwapInt(array, offset, expect, update);
}

⑤ getAndIncrement(int i)方法 和 getAndDecrement(int i)方法。

//先获取指定下标的值，然后再让此值加一，利用的是getAndAdd方法
public final int getAndIncrement(int i) {
   return getAndAdd(i, 1);
}

//先获取指定下标的值，然后再让此值减一，利用的是getAndAdd方法
public final int getAndDecrement(int i) {
    return getAndAdd(i, -1);
}

//获取指定下标的值，并且在指定下标的值的基础上加delta
public final int getAndAdd(int i, int delta) {
    return unsafe.getAndAddInt(array, checkedByteOffset(i), delta);
}

⑥ incrementAndGet(int i)方法 和 decrementAndGet(int i)方法。

//先对指定下标的值加一，然后返回加一后的值
public final int incrementAndGet(int i) {
    return getAndAdd(i, 1) + 1;
}

//先对指定下标的值减一，然后返回减一后的值
public final int decrementAndGet(int i) {
    return getAndAdd(i, -1) - 1;
}

⑦ addAndGet(int i, int delta)方法。

//先对指定下标的值加上指定数值delta，然后返回加后的值
public final int addAndGet(int i, int delta) {
    return getAndAdd(i, delta) + delta;
}

⑧ toString()方法。

//toString方法是利用StringBuilder来进行处理的
public String toString() {
    //若数组为空，则length为0
    int iMax = array.length - 1;
    //若数组为空，则0 - 1 = -1就返回“[]”
    if (iMax == -1)
        return "[]";

    StringBuilder b = new StringBuilder();
    b.append('[');
    //遍历数组元素，并且添加到StringBuilder中
     for (int i = 0; ; i++) {
            b.append(getRaw(byteOffset(i)));
            //条件判断，用来跳出此循环并且返回结果
            if (i == iMax)
                return b.append(']').toString();
            b.append(',').append(' ');
        }
}

三、总结

    AtomicIntegerArray里面比较难理解的就是base变量和shift变量，只要将这两个变量理解了，然后理解checkedByteOffset(int i)方法和byteOffset(int i)方法，那么整个AtomicIntegerArray类的源码都能迎刃而解。