JDK源码解析之 Java.lang.StringBuffer

栗筝i

发布于 2022-12-01 19:58:16

1660

发布于 2022-12-01 19:58:16

StringBuffer类表示一个可变的字符序列。StringBuffer的API与StringBuilder互相兼容，但是StringBuffer是线程安全的。在可能的情况下，建议优先使用StringBuilder，因为在大多数实现中它比StringBuffer更快。

一、类定义

public final class StringBuffer
    extends AbstractStringBuilder
    implements java.io.Serializable, CharSequence
{
    ...
}

StringBuffer类被 final 所修饰，因此不能被继承。

StringBuffer类继承于 AbstractStringBuilder类。实际上，AbstractStringBuilder类具体实现了可变字符序列的一系列操作，比如：append()、insert()、delete()、replace()、charAt()方法等。值得一提的是，StringBuilder也是继承于AbstractStringBuilder类。

StringBuffer类实现了2个接口：

Serializable 序列化接口，表示对象可以被序列化。
CharSequence 字符序列接口，提供了几个对字符序列进行只读访问的方法，比如：length()、charAt()、subSequence()、toString()方法等。

二、成员变量

private transient char[] toStringCache;

// AbstractStringBuilder.java

char[] value;

int count;

value、count这两个变量是继承自父类
toStringCache 用来缓存toString()方法返回的最近一次的value数组中的字符。当修改StringBuffer对象时会被清除。

三、构造方法

//默认构造方法设置了value数组的初始容量为16。
public StringBuffer() {
    super(16);
}
//设置了value数组的初始容量为指定的大小。
public StringBuffer(int capacity) {
    super(capacity);
}
//接受一个String对象作为参数，设置了value数组的初始容量为String对象的长度+16，并把String对象中的字符添加到value数组中。
public StringBuffer(String str) {
    super(str.length() + 16);
    append(str);
}
//接受一个CharSequence对象作为参数，设置了value数组的初始容量为CharSequence对象的长度+16，并把CharSequence对象中的字符添加到value数组中。
public StringBuffer(CharSequence seq) {
    this(seq.length() + 16);
    append(seq);
}

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

StringBuffer类提供了4个构造方法。构造方法主要完成了对value数组的初始化。

四、普通方法

StringBuilder实现了AbstractStringBuilder和CharSequence，他的方法都来自于这两个类，绝大部分都是通过super来调用的。

4.1、append()方法

@Override
public synchronized StringBuffer append(boolean b) {
    toStringCache = null;
    super.append(b);
    return this;
}

// AbstractStringBuilder.java
public AbstractStringBuilder append(boolean b) {
    if (b) {
        ensureCapacityInternal(count + 4);
        value[count++] = 't';
        value[count++] = 'r';
        value[count++] = 'u';
        value[count++] = 'e';
    } else {
        ensureCapacityInternal(count + 5);
        value[count++] = 'f';
        value[count++] = 'a';
        value[count++] = 'l';
        value[count++] = 's';
        value[count++] = 'e';
    }
    return this;
}    

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

// 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);
    count += len;
    return this;
}

调用了父类AbstractStringBuilder类中对应的方法。最后，append()方法返回了StringBuffer对象自身。

append()方法将指定参数类型的字符串表示形式追加到字符序列的末尾。它可以接受boolean、char、char[]、CharSequence、double、float、int、long、Object、String、StringBuffer这些类型的参数。这些方法最终都，以便用户可以链式调用StringBuilder类中的方法。

AbstractStringBuilder类的各个append()方法大同小异。append()方法在追加字符到value数组中之前都会调用ensureCapacityInternal()方法来确保value数组有足够的容量，然后才把字符追加到value数组中。

4.2、toString()方法

@Override
public String toString() {
    // Create a copy, don't share the array
    return new String(value, 0, count);
}

4.3、writeObject和readObject

    /**
     * Save the state of the {@code StringBuilder} instance to a stream
     * (that is, serialize it).
     *
     * @serialData the number of characters currently stored in the string
     *             builder ({@code int}), followed by the characters in the
     *             string builder ({@code char[]}).   The length of the
     *             {@code char} array may be greater than the number of
     *             characters currently stored in the string builder, in which
     *             case extra characters are ignored.
     */
    private void writeObject(java.io.ObjectOutputStream s)
        throws java.io.IOException {
        s.defaultWriteObject();
        s.writeInt(count);
        s.writeObject(value);
    }

    /**
     * readObject is called to restore the state of the StringBuffer from
     * a stream.
     */
    private void readObject(java.io.ObjectInputStream s)
        throws java.io.IOException, ClassNotFoundException {
        s.defaultReadObject();
        count = s.readInt();
        value = (char[]) s.readObject();
    }

实现自Serializable接口后，可定制的序列化过程