为什么StringBuilder线程不安全？

约定不等于承诺〃 2022-10-07 09:52 224阅读 0赞

# StringBuilder线程不安全的原因 #

### 文章目录 ###

*  StringBuilder线程不安全的原因
 *   *  一、现象分析
     *  二、为什么输出值跟预期值不一样
     *  三、为什么会抛出异常
     *  四、StringBuffer线程安全的原因

## 一、现象分析 ##

先上结论，StringBuilder不是线程安全的，StringBuffer是线程安全的，这篇文章就探究一下底层原理。

在分析这个问题之前要知道StringBuilder和StringBuffer的内部实现跟String类一样，都是通过一个char数组存储字符串的，不同的是String类里面的char数组是final修饰的，是不可变的，而StringBuilder和StringBuffer的char数组是可变的，没有使用final修饰。

首先通过一段代码去看一下多线程操作StringBuilder对象会出现什么问题：

public class StringBuilderDemo { 
    
        public static void main(String[] args) throws InterruptedException { 
            StringBuilder stringBuilder = new StringBuilder();
            for (int i = 0; i < 10; i++){ 
                new Thread(new Runnable() { 
                    @Override
                    public void run() { 
                        for (int j = 0; j < 1000; j++){ 
                            stringBuilder.append("a");
                        }
                    }
                }).start();
            }
    
            Thread.sleep(100);
            System.out.println(stringBuilder.length());
        }
    }

这段代码创建了10个线程，每个线程循环1000次往StringBuilder对象里面append字符。正常情况下代码应该输出10000，但是实际运行结果如下图：

![image-20210617114046574][]

可以看到输出了 “9326”，小于预期的10000，并且还抛出了一个 `ArrayIndexOutOfBoundsException` 异常（异常不是必现）。

## 二、为什么输出值跟预期值不一样 ##

先看一下StringBuilder的两个成员变量（这两个成员变量实际上是定义在AbstractStringBuilder里面的，StringBuilder和StringBuffer都继承了AbstractStringBuilder）

//存储字符串的具体内容
    char[] value;
    
    //已经使用的字符数组的数量
    int count;

再看StringBuilder的 `append()` 方法：

@Override
    public StringBuilder append(String str) { 
        super.append(str);
        return this;
    }

StringBuilder的 `append()` 方法调用父类AbstractStringBuilder的 `append()` 方法：

1.public AbstractStringBuilder append(String str) { 
    2.    if (str == null)
    3.        return appendNull();
    4.    int len = str.length();
    5.    ensureCapacityInternal(count + len);
    6.    str.getChars(0, len, value, count);
    7.    count += len;
    8.    return this;
    9.}

先不管代码的第五行和第六行干了什么，直接看第七行，`count += len` 不是一个原子操作。假设这个时候count值为10，len值为1，两个线程同时执行到了第七行，拿到的count值都是10，执行完加法运算后将结果赋值给count，所以两个线程执行完后count值为11，而不是12。这就是为什么测试代码输出的值要比10000小的原因。

## 三、为什么会抛出异常 ##

回看AbstractStringBuilder的 `append()` 方法源码的第五行：

1.public AbstractStringBuilder append(String str) { 
          //...
    4.    int len = str.length();
    5.    ensureCapacityInternal(count + len);
          //...
    }

`ensureCapacityInternal()` 方法用来检查StringBuilder对象的原char数组的容量能不能容下新的字符串，如果容不下就调用 `expandCapacity()` 方法对char数组进行扩容，部分源码如下：

//参数minimumCapacity是数组中已占用的+将要占用的和
    private void ensureCapacityInternal(int minimumCapacity) { 
        // overflow-conscious code
        if (minimumCapacity - value.length > 0)
            expandCapacity(minimumCapacity);
    }

扩容的逻辑就是创建一个新的char数组，新的char数组的容量是原来char数组的两倍再加2，再通过 `System.arryCopy()` 方法将原数组的内容复制到扩容后的新数组，最后将指针指向新数组，部分源码如下：

void expandCapacity(int minimumCapacity) { 
        
        //计算新的容量
        int newCapacity = value.length * 2 + 2;
        
        //中间省略了一些检查逻辑
        //...
        value = Arrays.copyOf(value, newCapacity);
    }

`Arrys.copyOf()` 方法源码如下：

public static char[] copyOf(char[] original, int newLength) { 
        
        char[] copy = new char[newLength];
        
        //拷贝数组
        System.arraycopy(original, 0, copy, 0,
                         Math.min(original.length, newLength));
        return copy;
    }

AbstractStringBuilder的 `append()` 方法源码的第六行，是将参数String对象里面的char数组里面的内容拷贝到StringBuilder对象的char数组里面，第六行代码如下：

1.public AbstractStringBuilder append(String str) { 
          //...
    4.    int len = str.length();
    5.    ensureCapacityInternal(count + len);
    6.    str.getChars(0, len, value, count);
          //...
    }

`getChars()` 方法源码如下：

//参数1、2表示String对象的char数组的起始位置和终止位置
    //参数3、4表示StringBuilder对象的char数组和将要添加新元素的起始位置
    public void getChars(int srcBegin, int srcEnd, char dst[], int dstBegin) { 
        //中间省略了一些检查
        //...
        System.arraycopy(value, srcBegin, dst, dstBegin, srcEnd - srcBegin);
    }

拷贝流程见下图：

![image-20210617115644716][]

假设现在有两个线程同时执行了StringBuilder的 `append()` 方法，两个线程都执行完了第五行的 `ensureCapacityInternal()` 方法，此刻count=5，表示新元素将要从5位置开始添加，如下图所示：

![image-20210617115738636][]

假如这个时候线程1的cpu时间片用完了，线程2继续执行，线程2执行完整个 `append()` 方法后count变成6：

![image-20210617120740605][]

这个时候线程1继续执行第六行的 `str.getChars()` 方法拿到的count值就是6，执行char数组拷贝时就会抛出 `ArrayIndexOutOfBoundsException` 异常。

## 四、StringBuffer线程安全的原因 ##

如果将测试代码的StringBuilder对象换成StringBuffer对象输出结果如下：

![image-20210617120121398][]

没有出现异常，且按照预期结果输出。

StringBuffer的 `append()` 方法的源码如下：

public synchronized StringBuffer append(String str) { 
        toStringCache = null;
        super.append(str);
        return this;
    }

可以发现，StringBuffer线程安全的原因是使用了 `synchronized` 关键字。

[image-20210617114046574]: /images/20221005/4a48cedcbc51434b9ffe75241c11df8e.png
[image-20210617115644716]: /images/20221005/4ebcb99ea7aa4c6dbd8ec5b0985ad6ff.png
[image-20210617115738636]: /images/20221005/f23bb3485a814256ad3ed9a62a6db036.png
[image-20210617120740605]: /images/20221005/030156a8cd5b4f7fa3d45771d57deb4e.png
[image-20210617120121398]: /images/20221005/6729369e81044e21be5021ab1959141a.png