死磕 Java 系列（一）—— 常用类（1） String 源码解析

// String 类中的字段

// 1.String 类底层用于字符存储的数组，一旦创建无法修改（final）
private final char value[];

// 2.缓存 String 对象的哈希值
private int hash; // Default to 0

// 3.序列版本号
private static final long serialVersionUID = -6849794470754667710L;

// String 类的构造方法（部分）

// 1.空参构造方法，实际上返回的是一个为 null 的数组
public () {
    this.value = "".value;
}

// 2.创建指定的字符串对象，新创建的字符串是参数字符串的副本
public (String original) {
    this.value = original.value;
    this.hash = original.hash;
}

// 3.根据字符数组创建字符串对象
public (char value[]) {
    // 将传入的数组复制一份然后返回
    this.value = Arrays.copyOf(value, value.length);
}

// 4.从字符数组的第几位开始，再取几个元素创建字符串对象
public (char value[], int offset, int count) {
    if (offset < 0) {
        // 越界检查
        throw new StringIndexOutOfBoundsException(offset);
    }
    if (count <= 0) {
        if (count < 0) {
            throw new StringIndexOutOfBoundsException(count);
        }
        // 当偏移值小于字符数组的长度，且 count == 0 时创建空字符串
        if (offset <= value.length) {
            this.value = "".value;
            return;
        }
    }
    // offset + count > value.length，很明显越界了
    if (offset > value.length - count) {
        throw new StringIndexOutOfBoundsException(offset + count);
    }
    this.value = Arrays.copyOfRange(value, offset, offset+count);
}

// 5.这里是把 StringBuffer 和 StringBuilder 传进来，然后返回对应的字符串
public (StringBuffer buffer) {
    synchronized(buffer) {
        this.value = Arrays.copyOf(buffer.getValue(), buffer.length());
    }
}

public String(StringBuilder builder) {
    this.value = Arrays.copyOf(builder.getValue(), builder.length());
}

// String 类公共方法（部分），底层的实际操作对象为 value

// 1.返回字符串的长度
public int length() {
    return value.length;
}

// 2.判空方法
public boolean isEmpty() {
    return value.length == 0;
}

// 3.按照指定索引返回字符
public char charAt(int index) {
    // 越界检查
    if ((index < 0) || (index >= value.length)) {
        throw new StringIndexOutOfBoundsException(index);
    }
    return value[index];
}

// 4.返回指定索引上字符的 Unicode 编码
public int codePointAt(int index) {
    if ((index < 0) || (index >= value.length)) {
        throw new StringIndexOutOfBoundsException(index);
    }
    return Character.codePointAtImpl(value, index, value.length);
}

// 5.下面是 String 类中很重要的一个方法，比较指定对象与字符串对象的值
public boolean equals(Object anObject) {
    if (this == anObject) {
        // 两个比较对象的地址相同，值肯定相同，直接返回 true
        return true;
    }
    // 传进来的对象为 String 类时，才进行比较
    if (anObject instanceof String) {
        String anotherString = (String)anObject;
        int n = value.length;
        // 字符串长度相等才继续比较
        if (n == anotherString.value.length) {
            char v1[] = value;
            char v2[] = anotherString.value;
            int i = 0;
            // 下面是对数组中储存的每个元素进行比较
            while (n-- != 0) {
                if (v1[i] != v2[i])
                    return false;
                i++;
            }
            return true;
        }
    }
    return false;
}

// 6.同上，不同之处在于传进来的对象就是字符串类型的
public boolean equalsIgnoreCase(String anotherString) {
    return (this == anotherString) ? true
        : (anotherString != null)
    && (anotherString.value.length == value.length)
        && regionMatches(true, 0, anotherString, 0, value.length);
}

// 6.对两个两个字符串对象中每个字符的 Unicode 值进行比较
//  返回负数说明参数字符串的大；正数则相反；返回 0 说明两个字符串相等
public int compareTo(String anotherString) {
    int len1 = value.length;
    int len2 = anotherString.value.length;
    int lim = Math.min(len1, len2);
    char v1[] = value;
    char v2[] = anotherString.value;

    int k = 0;
    while (k < lim) {
        char c1 = v1[k];
        char c2 = v2[k];
        if (c1 != c2) {
            return c1 - c2;
        }
        k++;
    }
    return len1 - len2;
}

// 7.判断一个字符串从 toffset 位置开始是否以 prefix 字符串开头
大专栏  死磕 Java 系列（一）—— 常用类（1） String 源码解析>public boolean startsWith(String prefix, int toffset) {
    char ta[] = value;
    int to = toffset;
    char pa[] = prefix.value;
    int po = 0;
    int pc = prefix.value.length;
    // 下面这两种情况都没有比较的意义
    if ((toffset < 0) || (toffset > value.length - pc)) {
        return false;
    }
    while (--pc >= 0) {
        // 从字符串的 toffset 位置开始，将每个字符与 prefix 的每个字符作比较
        if (ta[to++] != pa[po++]) {
            return false;
        }
    }
    return true;
}

// 8.重载方法，即默认从字符串的头位置开始
public boolean startsWith(String prefix) {
    return startsWith(prefix, 0);
}

// 9.判断是否以 suffix 结尾
public boolean endsWith(String suffix) {
    // 这里很巧妙，还是利用了之前的方法，从前往后比较
    return startsWith(suffix, value.length - suffix.value.length);
}

// 10.这也是一个非常重要的方法，返回字符串对象的哈希值，更多介绍参见分析
public int hashCode() {
    int h = hash; // 默认为 0
    if (h == 0 && value.length > 0) {
        // 这里保证了每个字符串对象的哈希值只会计算一次
        char val[] = value;

        for (int i = 0; i < value.length; i++) {
            // 此处的 31 很奇怪，留个悬念
            h = 31 * h + val[i];
        }
        hash = h;
    }
    return h;
}

// 11.从指定位置开始，对字符串进行截取到末尾，然后返回
public String substring(int beginIndex) {
    if (beginIndex < 0) {
        throw new StringIndexOutOfBoundsException(beginIndex);
    }
    // 获取截取长
    int subLen = value.length - beginIndex;
    if (subLen < 0) {
        throw new StringIndexOutOfBoundsException(subLen);
    }
    // 当 beginIndex != 0 时，返回的实际上一个新的字符串对象（不是操作原对象）
    return (beginIndex == 0) ? this : new String(value, beginIndex, subLen);
}

// 12.同上，范围截取
public String substring(int beginIndex, int endIndex) {
    if (beginIndex < 0) {
        throw new StringIndexOutOfBoundsException(beginIndex);
    }
    if (endIndex > value.length) {
        throw new StringIndexOutOfBoundsException(endIndex);
    }
    int subLen = endIndex - beginIndex;
    if (subLen < 0) {
        throw new StringIndexOutOfBoundsException(subLen);
    }
    return ((beginIndex == 0) && (endIndex == value.length)) ? this
        : new String(value, beginIndex, subLen);
}

// 13.这个方法是在 CharSequence 中定义的，作用和上面的方法一样不同之处在于返回值不同
// 因为 String 实现了 CharSequence 接口，CharSequence 可以直接下转为 String 对象
public CharSequence subSequence(int beginIndex, int endIndex) {
    return this.substring(beginIndex, endIndex);
}

// 14.将指定的字符串与本字符串对象进行连接
public String concat(String str) {
    int otherLen = str.length();
    if (otherLen == 0) {
        return this;
    }
    int len = value.length;
    // 创建新的字符数组
    char buf[] = Arrays.copyOf(value, len + otherLen);
    str.getChars(buf, len);
    // 返回新的字符串对象
    return new String(buf, true);
}

// 15.将原字符串中的某个字符替区拉布换成新的字符
public String replace(char oldChar, char newChar) {
    // 新旧字符不相等才开始替换
    if (oldChar != newChar) {
        int len = value.length;
        int i = -1;
        char[] val = value; /* avoid getfield opcode */

        while (++i < len) {
            if (val[i] == oldChar) {
                // 记录字符串中替换字符第一次出现的位置
                break;
            }
        }
        if (i < len) {
            char buf[] = new char[len];
            // 将旧字符串中替换字符之前的字符复制到新数组中
            for (int j = 0; j < i; j++) {
                buf[j] = val[j];
            }
            // 下面就是替换工作了，注意是全部替换
            while (i < len) {
                char c = val[i];
                buf[i] = (c == oldChar) ? newChar : c;
                i++;
            }
            return new String(buf, true);
        }
    }
    return this;
}

// 16.去掉字符串头尾的空格
public String trim() {
    int len = value.length;
    int st = 0;
    char[] val = value;    /* avoid getfield opcode */

    // 找到头部第一个不为 ' ' 的字符位置
    while ((st < len) && (val[st] <= ' ')) {
        st++;
    }
    // 找到尾部第一个不为 ' ' 的字符位置
    while ((st < len) && (val[len - 1] <= ' ')) {
        len--;
    }
    // (st > 0) || (len < value.length) 说明头或尾存在空格，然后对字符串进行截取
    return ((st > 0) || (len < value.length)) ? substring(st, len) : this;
}

// 18.返回字符串对象的字符数组
public char[] toCharArray() {
    // Cannot use Arrays.copyOf because of class initialization order issues
    char result[] = new char[value.length];
    // 这里也是复制一份新数组返回
    System.arraycopy(value, 0, result, 0, value.length);
    return result;
}

// 19.下面都是 valueOf() 的重载方法，并且是静态的（只贴了部分）
// 用于将传入的对象或者基本类型转换成字符串
public static String valueOf(Object obj) {
    return (obj == null) ? "null" : obj.toString();
}

public static String valueOf(char data[]) {
    return new String(data);
}

public static String valueOf(char data[], int offset, int count) {
    return new String(data, offset, count);
}

// 20.返回字符串对象在常量池中的引用，如果常量池中不存在该字符串
// 则将该字符串的引用放入到常量池中
public native String intern();