簡單聊聊C#字符串構建利器StringBuilder

StringBuilder builder = new StringBuilder();
builder.Append("我和我的祖國");
builder.Append(',');
builder.Append("一刻也不能分割");
builder.Append('。');
builder.Append("無論我走到哪裡,都留下一首贊歌。");
builder.Append("我歌唱每一座高山,我歌唱每一條河。");
builder.Append("裊裊炊煙,小小村落,路上一道轍。");
builder.Append("我永遠緊依著你的心窩,你用你那母親的脈搏,和我訴說。");
string result = builder.ToString();
Console.WriteLine(result);

StringBuilder builder = new StringBuilder("我和我的祖國");
//或者是指定StringBuilder的容量，這樣的話StringBuilder初始可承載字符串的長度是16
builder = new StringBuilder(16);

//可承載字符的最大容量,即可以拼接的字符串的長度
internal int m_MaxCapacity;
//承載【拼接字符串的char數組
internal char[] m_ChunkChars;
//默認的容量，即默認初始化m_ChunkChars的長度，也就是首次擴容觸發的長度
internal const int DefaultCapacity = 16;
public StringBuilder()
{
    m_MaxCapacity = int.MaxValue;
    m_ChunkChars = new char[DefaultCapacity];
}

//聲明初始化容量，即首次擴容觸發的長度條件
public StringBuilder(int capacity)
//聲明初始化容量，和最大容量即可以動態構建字符串的總長度
public StringBuilder(int capacity, int maxCapacity)
//用給定字符串初始化
public StringBuilder(string? value)
//用給定字符串初始化，並聲明容量
public StringBuilder(string? value, int capacity)
//用一個字符串截取指定長度初始化，並聲明最大容量
public StringBuilder(string? value, int startIndex, int length, int capacity)

//可承載字符的最大容量,即可以拼接的字符串的長度
internal int m_MaxCapacity;
//承載【拼接字符串的char數組
internal char[] m_ChunkChars;
//默認的容量，即默認初始化m_ChunkChars的長度，也就是首次擴容觸發的長度
internal const int DefaultCapacity = 16;
public StringBuilder(int capacity, int maxCapacity)
{
    //指定容量不能大於最大容量
    if (capacity > maxCapacity)
    {
        throw new ArgumentOutOfRangeException(nameof(capacity), SR.ArgumentOutOfRange_Capacity);
    }
    //最大容量不能小於1
    if (maxCapacity < 1)
    {
        throw new ArgumentOutOfRangeException(nameof(maxCapacity), SR.ArgumentOutOfRange_SmallMaxCapacity);
    }
    //初始化容量不能小於0
    if (capacity < 0)
    {
        throw new ArgumentOutOfRangeException(nameof(capacity), SR.Format(SR.ArgumentOutOfRange_MustBePositive, nameof(capacity)));
    }
    //如果指定容量等於0，則使用默認的容量
    if (capacity == 0)
    {
        capacity = Math.Min(DefaultCapacity, maxCapacity);
    }
    //最大容量賦值
    m_MaxCapacity = maxCapacity;
    //分配指定容量的數組
    m_ChunkChars = GC.AllocateUninitializedArray<char>(capacity);
}

//可承載字符的最大容量,即可以拼接的字符串的長度
internal int m_MaxCapacity;
//承載【拼接字符串的char數組
internal char[] m_ChunkChars;
//默認的容量，即默認初始化m_ChunkChars的長度，也就是首次擴容觸發的長度
internal const int DefaultCapacity = 16;
//當前m_ChunkChars字符數組中已經使用的長度
internal int m_ChunkLength;
public StringBuilder(string? value, int startIndex, int length, int capacity)
{
    if (capacity < 0)
    {
        throw new ArgumentOutOfRangeException();
    }
    if (length < 0)
    {
        throw new ArgumentOutOfRangeException();
    }
    if (startIndex < 0)
    {
        throw new ArgumentOutOfRangeException();
    }
    //初始化的字符串可以為null,如果為null則隻用空字符串即""
    if (value == null)
    {
        value = string.Empty;
    }
    //基礎長度判斷,這個邏輯其實已經包含瞭針對字符串截取的起始位置和接要截取的長度進行判斷瞭
    if (startIndex > value.Length - length)
    {
        throw new ArgumentOutOfRangeException();
    }
    //最大容量是int的最大值，即2^31-1
    m_MaxCapacity = int.MaxValue;
    if (capacity == 0)
    {
        capacity = DefaultCapacity;
    }
    //雖然傳遞瞭默認容量,但是這裡依然做瞭判斷,在傳遞的默認容量和需要存儲的字符串容量總取最大值
    capacity = Math.Max(capacity, length);
    //分配指定容量的數組
    m_ChunkChars = GC.AllocateUninitializedArray<char>(capacity);
    //這裡記錄瞭m_ChunkChars固定長度的快中已經被使用的長度
    m_ChunkLength = length;
    //把傳遞的字符串指定位置指定長度(即截取操作)copy到m_ChunkChars中
    value.AsSpan(startIndex, length).CopyTo(m_ChunkChars);
}

//承載【拼接字符串的char數組
internal char[] m_ChunkChars;
//當前m_ChunkChars字符數組中已經使用的長度
internal int m_ChunkLength;
public StringBuilder Append(string? value)
{
    if (value != null)
    {
        // 獲取當前存儲塊
        char[] chunkChars = m_ChunkChars;
        // 獲取當前塊已使用的長度
        int chunkLength = m_ChunkLength;
        // 獲取傳進來的字符的長度
        int valueLen = value.Length;

        //當前使用的長度 + 需要Append的長度 < 當前塊的長度 則不需要擴容
        if (((uint)chunkLength + (uint)valueLen) < (uint)chunkChars.Length)
        {
            //判斷傳進來的字符串長度是否<=2
            //如果小於2則隻用直接訪問位置的方式操作
            if (valueLen <= 2)
            {
                //判斷字符串長度>0的場景
                if (valueLen > 0)
                {
                    //m_ChunkChars的已使用長度其實就是可以Append新元素的起始位置
                    //直接取value得第0個元素放入m_ChunkChars[可存儲的起始位置]
                    chunkChars[chunkLength] = value[0];
                }
                //其實是判斷字符串長度==2的場景
                if (valueLen > 1)
                {
                    //因為上面已經取瞭value第0個元素放入瞭m_ChunkChars中
                    //現在則取value得第1個元素繼續放入chunkLength的下一位置
                    chunkChars[chunkLength + 1] = value[1];
                }
            }
            else
            {
                //如果value的長度大於2則通過操作內存去追加value
                //獲取m_ChunkChars的引用位置,偏移到m_ChunkLength的位置追加value
                Buffer.Memmove(
                    ref Unsafe.Add(ref MemoryMarshal.GetArrayDataReference(chunkChars), chunkLength),
                    ref value.GetRawStringData(),
                    (nuint)valueLen);
            }
            //更新以使用長度的值,新的使用長度是當前已使用長度+追加進來的字符串長度
            m_ChunkLength = chunkLength + valueLen;
        }
        else
        {
            //走到這裡說明進入瞭擴容邏輯
            AppendHelper(value);
        }
    }
    return this;
}

private void AppendHelper(string value)
{
    unsafe
    {
        //防止垃圾收集器重新定位value變量。
        //指針操作,string本身是不可變的char數組,所以它的指針是char* 
        fixed (char* valueChars = value)
        {
            //調用瞭另一個append
            Append(valueChars, value.Length);
        }
    }
}

public unsafe StringBuilder Append(char* value, int valueCount)
{
    // value必須有值
    if (valueCount < 0)
    {
        throw new ArgumentOutOfRangeException();
    }

    //新的長度=StringBuilder的長度+需要追加的字符串長度
    int newLength = Length + valueCount;
    //新的長度不能大於最大容量
    if (newLength > m_MaxCapacity || newLength < valueCount)
    {
        throw new ArgumentOutOfRangeException();
    }

    // 新的起始位置=需要追加的長度+當前使用的長度
    int newIndex = valueCount + m_ChunkLength;
    // 判斷當前m_ChunkChars的容量是否夠用
    if (newIndex <= m_ChunkChars.Length)
    {
        //夠用的話則直接將追加的元素添加到m_ChunkChars中去
        new ReadOnlySpan<char>(value, valueCount).CopyTo(m_ChunkChars.AsSpan(m_ChunkLength));
        //更新已使用的長度為新的長度
        m_ChunkLength = newIndex;
    }
    //當前m_ChunkChars不滿足存儲則需要擴容
    else
    {
        // 判斷當前存儲塊m_ChunkChars還有多少未存儲的位置
        int firstLength = m_ChunkChars.Length - m_ChunkLength;
        if (firstLength > 0)
        {
            //把需要追加的value中的前firstLength位字符copy到m_ChunkChars中剩餘的位置
            //合理的利用存儲空間,截取需要追加的value到m_ChunkChars剩餘的位置
            new ReadOnlySpan<char>(value, firstLength).CopyTo(m_ChunkChars.AsSpan(m_ChunkLength));
            //更新已使用的位置，這個時候當前存塊m_ChunkChars已經存儲滿瞭
            m_ChunkLength = m_ChunkChars.Length;
        }

        // 獲取value中未放入到m_ChunkChars(因為當前塊已經放滿)剩餘部分起始位置
        int restLength = valueCount - firstLength;
        //擴展當前存儲塊即擴容操作
        ExpandByABlock(restLength);
        //判斷新的存儲塊是否創建成功
        Debug.Assert(m_ChunkLength == 0, "A new block was not created.");
        // 將value中未放入到m_ChunkChars的剩餘部放入擴容後的m_ChunkChars中去
        new ReadOnlySpan<char>(value + firstLength, restLength).CopyTo(m_ChunkChars);
        // 更新當前已使用長度
        m_ChunkLength = restLength;
    }
    //一些針對當前StringBuilder的校驗操作,和相關邏輯無關不做詳細介紹
    //類似的Debug.Assert(m_ChunkOffset + m_ChunkChars.Length >= m_ChunkOffset, "The length of the string is greater than int.MaxValue.");
    AssertInvariants();
    return this;
}

public int Length
{
    //StringBuilder已存儲的長度=塊的偏移量+當前塊使用的長度
    get => m_ChunkOffset + m_ChunkLength;
    set
    {
        //註意這裡是有代碼的隻是我們暫時省略set邏輯
    }
}

//當前StringBuilder實際存儲的總長度
public int Length
{
    //StringBuilder已存儲的長度=塊的偏移量+當前塊使用的長度
    get => m_ChunkOffset + m_ChunkLength;
    set
    {
        //註意這裡是有代碼的隻是我們暫時省略set邏輯
    }
}
//當前StringBuilder的總容量
public int Capacity
{
    get => m_ChunkChars.Length + m_ChunkOffset;
    set
    {
        //註意這裡是有代碼的隻是我們暫時省略set邏輯
    }
}

//可承載字符的最大容量,即可以拼接的字符串的長度
internal int m_MaxCapacity;
//承載【拼接字符串的char數組
internal char[] m_ChunkChars;
//當前塊的最大長度
internal const int MaxChunkSize = 8000;
//當前m_ChunkChars字符數組中已經使用的長度
internal int m_ChunkLength;
//存儲塊的偏移量,用於計算總長度
internal int m_ChunkOffset;
//前一個存儲塊
internal StringBuilder? m_ChunkPrevious;
private void ExpandByABlock(int minBlockCharCount)
{
    //當前塊m_ChunkChars存儲滿才進行擴容操作
    Debug.Assert(Capacity == Length, nameof(ExpandByABlock) + " should only be called when there is no space left.");
    //minBlockCharCount指的是剩下的需要存儲的長度
    Debug.Assert(minBlockCharCount > 0);
    AssertInvariants();

    //StringBuilder的總長度不能大於StringBuilder的m_MaxCapacity
    if ((minBlockCharCount + Length) > m_MaxCapacity || minBlockCharCount + Length < minBlockCharCount)
    {
        throw new ArgumentOutOfRangeException();
    }

    //!!!需要擴容塊的新長度=max(當前追加字符的剩餘長度,min(當前StringBuilder長度,8000))
    int newBlockLength = Math.Max(minBlockCharCount, Math.Min(Length, MaxChunkSize));

    //判斷長度是否越界
    if (m_ChunkOffset + m_ChunkLength + newBlockLength < newBlockLength)
    {
        throw new OutOfMemoryException();
    }

    // 申請一個新的存塊長度為newBlockLength
    char[] chunkChars = GC.AllocateUninitializedArray<char>(newBlockLength);

    //!!!把當前StringBuilder中的存儲塊存放到一個新的StringBuilder實例中，當前實例的m_ChunkPrevious指向上一個StringBuilder
    //這裡可以看出來擴容的本質是構建節點為StringBuilder的鏈表
    m_ChunkPrevious = new StringBuilder(this);
    //偏移量是每次擴容的時候去修改,它的長度就是記錄瞭已使用塊的長度,但是不包含當前StringBuilder的存儲塊
    //可以理解為偏移量=長度-已經存放擴容塊的長度
    m_ChunkOffset += m_ChunkLength;
    //因為已經擴容瞭新的容器所以重置已使用長度
    m_ChunkLength = 0;
    //把新的塊重新賦值給當前存儲塊m_ChunkChars數組
    m_ChunkChars = chunkChars;
    AssertInvariants();
}

private StringBuilder(StringBuilder from)
{
    m_ChunkLength = from.m_ChunkLength;
    m_ChunkOffset = from.m_ChunkOffset;
    m_ChunkChars = from.m_ChunkChars;
    m_ChunkPrevious = from.m_ChunkPrevious;
    m_MaxCapacity = from.m_MaxCapacity;
    AssertInvariants();
}

//當前StringBuilder實際存儲的總長度
public int Length
{
    //StringBuilder已存儲的長度=塊的偏移量+當前塊使用的長度
    get => m_ChunkOffset + m_ChunkLength;
    set
    {
        //註意這裡是有代碼的隻是我們暫時省略set邏輯
    }
}
public override string ToString()
{
    AssertInvariants();
    //當前StringBuilder長度為0則直接返回空字符串
    if (Length == 0)
    {
        return string.Empty;
    }
    //FastAllocateString函數負責分配長度為StringBuilder長度的字符串
    //這個字符串就是ToString最終返回的結果,所以長度等於StringBuilder的長度
    string result = string.FastAllocateString(Length);
    //當前StringBuilder是遍歷的第一個鏈表節點
    StringBuilder? chunk = this;
    do
    {
        //當前使用長度必須大於0，也就是說當前塊的m_ChunkChars必須使用過,才需要遍歷當前節點
        if (chunk.m_ChunkLength > 0)
        {
            // 取出當前遍歷的StringBuilder的相關數據
            // 當前遍歷StringBuilder的m_ChunkChars
            char[] sourceArray = chunk.m_ChunkChars;
            int chunkOffset = chunk.m_ChunkOffset;
            int chunkLength = chunk.m_ChunkLength;

            // 檢查是否越界
            if ((uint)(chunkLength + chunkOffset) > (uint)result.Length || (uint)chunkLength > (uint)sourceArray.Length)
            {
                throw new ArgumentOutOfRangeException();
            }
            //把當前遍歷項StringBuilder的m_ChunkChars逐步添加到result中當前結果的前端
            Buffer.Memmove(
                ref Unsafe.Add(ref result.GetRawStringData(), chunkOffset),
                ref MemoryMarshal.GetArrayDataReference(sourceArray),
                (nuint)chunkLength);
        }
        //獲取當前StringBuilder的前一個節點,循環遍歷鏈表操作
        chunk = chunk.m_ChunkPrevious;
    }
    //如果m_ChunkPrevious==null則代表是第一個節點
    while (chunk != null);

    return result;
}

//初始化一個等於StringBuilder長度的字符串
string result = "\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0\0";
//第一次遍歷後
result = "\0\0\0\0\0\0\0\0\0\0\0\0\0\0無論我走到哪裡都留下一首贊歌。";
//第二次遍歷後
result = "\0\0\0\0\0\0\0一刻也不能分割,無論我走到哪裡都留下一首贊歌。";
//第三次遍歷後
result = "\0\0\0我的祖國一刻也不能分割,無論我走到哪裡都留下一首贊歌。";
//第三次遍歷後
result = "我和我的祖國一刻也不能分割,無論我走到哪裡都留下一首贊歌。";

//存儲塊也就是承載Append數據的容器
char[] value;
//StringBuilder的總長度
int count;
public StringBuilder() {
    //默認的容量也是16
    super(16);
}

public StringBuilder(String str) {
    //這個地方有差異如果通過指定字符串初始化StringBuilder
    //則初始化的長度則是當前傳遞的str的長度+16
    super(str.length() + 16);
    append(str);
}

// AbstractStringBuilder.java
AbstractStringBuilder(int capacity) {
    value = new char[capacity];
}

// AbstractStringBuilder.java
public AbstractStringBuilder append(String str) {
    if (str == null)
        return appendNull();
    int len = str.length();
    // 這裡是擴容操作
    ensureCapacityInternal(count + len);
    str.getChars(0, len, value, count);
    //每次append之後重新設置長度
    count += len;
    return this;
} 

private void ensureCapacityInternal(int minimumCapacity) {
    //當前需要的長度>char[]的長度則需要擴容
    if (minimumCapacity - value.length > 0)
        expandCapacity(minimumCapacity);
}

void expandCapacity(int minimumCapacity) {
    //新擴容的長度是當前塊char[]的長度的2倍+2
    int newCapacity = value.length * 2 + 2;
    if (newCapacity - minimumCapacity < 0)
        newCapacity = minimumCapacity;
    if (newCapacity < 0) {
        if (minimumCapacity < 0)
            throw new OutOfMemoryError();
        newCapacity = Integer.MAX_VALUE;
    }
    //把當前的char[]復制到新擴容的字符數組中
    value = Arrays.copyOf(value, newCapacity);
}

// Arrays.java copy的邏輯
public static char[] copyOf(char[] original, int newLength) {
    //聲明一個新的數組，把original的數據copy到新的char數組中
    char[] copy = new char[newLength];
    System.arraycopy(original, 0, copy, 0,
                     Math.min(original.length, newLength));
    return copy;
}

@Override
public String toString() {
    // 這裡創建瞭一個新的String對象返回，通過當前char[]初始化這個字符串
    return new String(value, 0, count);
}