Java API:String class 原

Java API:String class

一、介绍

本博文参照API文档以及源码进行阅读,源码参考JDK1.8。

java.lang.String
public final class String
extends Object
implements Serializable, Comparable<String>, CharSequence

JDK1.0出现。

上面由API提供的描述,可以看出,String是一个最终类,继承了Object类,实现了序列化接口和排序接口以及char可读序列接口。可以得出以下几个特点。

1、特点

  • 1.String是一个最终类,代表字符串的一个类,所有的字符串都是String的对象。
  • 2.字符串是一个常量;字符串可以被共享。
  • 3.字符串是存在方法区。 - 4.注意不同的方式创建的对象的个数。有几个对象,就看内存中有几个存储的是地址。

二、属性字段

以下为String类中提供的属性字段。

//存储结构,String类型其实就是使用char数组在内存中进行存储的。也可以说String是基于char数组实现的。
private final char value[];
//缓存hashcode,默认值为0
private int hash;
//序列化版本号
private static final long serialVersionUID = -6849794470754667710L;
//序列化对象文件
private static final ObjectStreamField[] serialPersistentFields = new ObjectStreamField[0];
//一个对 String 对象进行排序的 Comparator,作用与 compareToIgnoreCase 相同
public static final Comparator<String> CASE_INSENSITIVE_ORDER
                          = new CaseInsensitiveComparator();

三、构造方法

以下是String提供所有构造方法。

    //默认构造,可以看出,确实是基于char数组进行存储的。
    public String() {
        this.value = new char[0];
    }
    //这个构造是一个参数,直接给两个属性赋值
    public String(String original) {
        this.value = original.value;
        this.hash = original.hash;
    }
    //将整个char数组转变成字符串
    public String(char value[]) {
        //这里面借助的是数组的复制,来进行赋值。
        this.value = Arrays.copyOf(value, value.length);
    }
    //将char数组的一部分转变成字符串
    //value:要转变的数组;offset:开始的下标;count:转变的数量。
    public String(char value[], int offset, int count) {
        //判断下标是否是异常值
        if (offset < 0) {
            throw new StringIndexOutOfBoundsException(offset);
        }
        //判断数量是否是异常值。
        if (count < 0) {
            throw new StringIndexOutOfBoundsException(count);
        }
        // 判断下标和数量组合是否会越界
        if (offset > value.length - count) {
            throw new StringIndexOutOfBoundsException(offset + count);
        }
        //利用数组复制,进行赋值。
        this.value = Arrays.copyOfRange(value, offset, offset+count);
    }
    //这个方法和上述方法一样,只是换了类型,将char类型的数组换成了int类型的数组。
    public String(int[] codePoints, int offset, int count) {
        //判断开始位置是否异常。
        if (offset < 0) {
            throw new StringIndexOutOfBoundsException(offset);
        }
        //判断数量是否异常。
        if (count < 0) {
            throw new StringIndexOutOfBoundsException(count);
        }
        //判断下标和数量组合是否会越界。
        if (offset > codePoints.length - count) {
            throw new StringIndexOutOfBoundsException(offset + count);
        }
        //声明一个数组最大的标志位
        final int end = offset + count;

        // 声明一个数量,等于count,用于声明新数组使用。
        int n = count;
        for (int i = offset; i < end; i++) {
            //获取数组中当前位的元素
            int c = codePoints[i];
            //判断元素是否在char字符代码点中
            if (Character.isBmpCodePoint(c))
                //如果在就继续代码逻辑
                continue;
            //判断此元素的代码点是否有效
            else if (Character.isValidCodePoint(c))
                //记录加一
                n++;
            //其他情况则抛出异常
            else throw new IllegalArgumentException(Integer.toString(c));
        }

        // 声明char数组,用来接收转换过的字符串
        final char[] v = new char[n];
        //循环遍历int数组进行赋值
        for (int i = offset, j = 0; i < end; i++, j++) {
            int c = codePoints[i];
            if (Character.isBmpCodePoint(c))
                v[j] = (char)c;
            else
                Character.toSurrogates(c, v, j++);
        }
        //直接将v数组赋值给value属性
        this.value = v;
    }
    //此构造方法已经过时
    @Deprecated
    //ascii[]:字节数组;hibyte:每个16位Unicode代码单元的前8位;offset:开始的位置;count:个数。
    public String(byte ascii[], int hibyte, int offset, int count) {
        //检查边界,此方法,在String内部声明,在API文档中看不到,只在源码中能够看到
        checkBounds(ascii, offset, count);
        //创建一个接受值的char数组,大小为count。
        char value[] = new char[count];
        //
        if (hibyte == 0) {
            for (int i = count; i-- > 0;) {
                value[i] = (char)(ascii[i + offset] & 0xff);
            }
        } else {
            hibyte <<= 8;
            for (int i = count; i-- > 0;) {
                value[i] = (char)(hibyte | (ascii[i + offset] & 0xff));
            }
        }
        this.value = value;
    }
    @Deprecated
    public String(byte ascii[], int hibyte) {
        this(ascii, hibyte, 0, ascii.length);
    }
    //bytes[]:字符数组;offset:初始位置;length:长度;charsetName:编码字符集名称
    public String(byte bytes[], int offset, int length, String charsetName)
            throws UnsupportedEncodingException {
        //判断编码字符集,为空抛异常
        if (charsetName == null)
            throw new NullPointerException("charsetName");
        //检查边界
        checkBounds(bytes, offset, length);
        //调用StringCoding类的方法进行对应的字符集转换。
        this.value = StringCoding.decode(charsetName, bytes, offset, length);
    }
    //bytes[]:字节数组;offset:初始位置;length:长度;charset:解码字符集
    public String(byte bytes[], int offset, int length, Charset charset) {
        //解码字符集为空抛出异常
        if (charset == null)
            throw new NullPointerException("charset");
        //检查边界
        checkBounds(bytes, offset, length);
        this.value =  StringCoding.decode(charset, bytes, offset, length);
    }
    //重载方法
    public String(byte bytes[], String charsetName)
            throws UnsupportedEncodingException {
        //直接调用上面的方法
        this(bytes, 0, bytes.length, charsetName);
    }
    //重载方法,直接调用的上面的方法
    public String(byte bytes[], Charset charset) {
        this(bytes, 0, bytes.length, charset);
    }
    //重载方法
    public String(byte bytes[], int offset, int length) {
        checkBounds(bytes, offset, length);
        this.value = StringCoding.decode(bytes, offset, length);
    }
    //重载方法,直接调用之前的方法
    public String(byte bytes[]) {
        this(bytes, 0, bytes.length);
    }
    //将一个StringBuffer对象转换成String对象
    public String(StringBuffer buffer) {
        //加锁同步安全
        synchronized(buffer) {
            //利用数组复制进行赋值。
            this.value = Arrays.copyOf(buffer.getValue(), buffer.length());
        }
    }
    //将一个StringBuilder对象转换成一个String对象
    public String(StringBuilder builder) {
        //直接利用数组复制进行赋值
        this.value = Arrays.copyOf(builder.getValue(), builder.length());
    }
    //将char数组转换成字符串,直接赋值。
    String(char[] value, boolean share) {
        // assert share : "unshared not supported";
        this.value = value;
    }

四、类中的方法

1、私有方法

checkBounds()

    /* 
     * 此方法为私有方法,构造函数中很多都用到这个方法,此方法是用来判断对应数字是否超出范围
     */
    private static void checkBounds(byte[] bytes, int offset, int length) {
        //长度不合法抛出异常
        if (length < 0)
            throw new StringIndexOutOfBoundsException(length);
        //初始位置不合法,抛出异常
        if (offset < 0)
            throw new StringIndexOutOfBoundsException(offset);
        //初始位置和长度组合,超出范围抛异常
        if (offset > bytes.length - length)
            throw new StringIndexOutOfBoundsException(offset + length);
    }

2、公共方法

length()

    /**
     * 获取长度,直接获取的数组长度的属性
     */
    public int length() {
        return value.length;
    }

isEmpty()

    /**
     * 判断是否为空,直接判断长度是否为0
     * @since 1.6
     */
    public boolean isEmpty() {
        return value.length == 0;
    }

charAt()

    /**
     * 获取当前下标的字符。
     */
    public char charAt(int index) {
        //判断index是否超范围。
        if ((index < 0) || (index >= value.length)) {
            throw new StringIndexOutOfBoundsException(index);
        }
        //返回数组中这个位置的元素。
        return value[index];
    }

codePointAt()

关于Unicode字符编码的相关方法都在这里:

    /**
     * 查询当前位置字符的Unicode字符编码
     * @since 1.5
     */
    public int codePointAt(int index) {
        //判断index是否超范围。
        if ((index < 0) || (index >= value.length)) {
            throw new StringIndexOutOfBoundsException(index);
        }
        //调用方法返回。
        return Character.codePointAtImpl(value, index, value.length);
    }

    /**
     * 查询前一位置字符的Unicode字符编码
     * @since     1.5
     */
    public int codePointBefore(int index) {
        int i = index - 1;
        if ((i < 0) || (i >= value.length)) {
            throw new StringIndexOutOfBoundsException(index);
        }
        return Character.codePointBeforeImpl(value, index, 0);
    }

    /**
     * 查询beginIndex到endIndex之间的Unicode字符编码,含头不含尾。
     * @since  1.5
     */
    public int codePointCount(int beginIndex, int endIndex) {
        //判断范围是否越界
        if (beginIndex < 0 || endIndex > value.length || beginIndex > endIndex) {
            throw new IndexOutOfBoundsException();
        }
        return Character.codePointCountImpl(value, beginIndex, endIndex - beginIndex);
    }

    /**
     *
     * @since 1.5
     */
    public int offsetByCodePoints(int index, int codePointOffset) {
        if (index < 0 || index > value.length) {
            throw new IndexOutOfBoundsException();
        }
        return Character.offsetByCodePointsImpl(value, 0, value.length,
                index, codePointOffset);
    }

getChars()

    /**
     * 将此字符串中的字符复制到目标字符数组中
     * srcBegin:要复制的字符串中第一个字符的索引
     */
    void getChars(char dst[], int dstBegin) {
        //使用数组复制赋值。
        System.arraycopy(value, 0, dst, dstBegin, value.length);
    }

    /**
     * srcBegin - 要复制的字符串中第一个字符的索引。
     * srcEnd - 要复制的字符串中最后一个字符后面的索引。
     * dst - 目标数组。
     * dstBegin - 目标数组中的起始偏移量。
     *
     */
    public void getChars(int srcBegin, int srcEnd, char dst[], int dstBegin) {
        //判断字符索引是否合法
        if (srcBegin < 0) {
            throw new StringIndexOutOfBoundsException(srcBegin);
        }
        //判断最后一个字符是否越界
        if (srcEnd > value.length) {
            throw new StringIndexOutOfBoundsException(srcEnd);
        }
        //判断开始和结束的位置是否符合逻辑
        if (srcBegin > srcEnd) {
            throw new StringIndexOutOfBoundsException(srcEnd - srcBegin);
        }
        //数组拷贝
        System.arraycopy(value, srcBegin, dst, dstBegin, srcEnd - srcBegin);
    }

getBytes()

    /**
     *已过时
     */
    @Deprecated
    public void getBytes(int srcBegin, int srcEnd, byte dst[], int dstBegin) {
        if (srcBegin < 0) {
            throw new StringIndexOutOfBoundsException(srcBegin);
        }
        if (srcEnd > value.length) {
            throw new StringIndexOutOfBoundsException(srcEnd);
        }
        if (srcBegin > srcEnd) {
            throw new StringIndexOutOfBoundsException(srcEnd - srcBegin);
        }
        Objects.requireNonNull(dst);

        int j = dstBegin;
        int n = srcEnd;
        int i = srcBegin;
        char[] val = value;   /* avoid getfield opcode */

        while (i < n) {
            dst[j++] = (byte)val[i++];
        }
    }

    /**
     * 通过指定编码字符集获取对象的字节数组
     * @since  JDK1.1
     */
    public byte[] getBytes(String charsetName)
            throws UnsupportedEncodingException {
        if (charsetName == null) throw new NullPointerException();
        return StringCoding.encode(charsetName, value, 0, value.length);
    }

    /**
     *通过指定编码字符集获取对象的字节数组
     * @since  1.6
     */
    public byte[] getBytes(Charset charset) {
        if (charset == null) throw new NullPointerException();
        return StringCoding.encode(charset, value, 0, value.length);
    }

    /**
     * 使用平台默认字符集获取对象字节数组
     * @since      JDK1.1
     */
    public byte[] getBytes() {
        return StringCoding.encode(value, 0, value.length);
    }

equals()

    /**
     * 判断对象是否相等,String类将此方法重写了。
     */
    public boolean equals(Object anObject) {
        //判断内存地址是否相等
        if (this == anObject) {
            //因为String是存在于方法区中的常亮,所以内存地址如果相等则相等。
            return true;
        }
        //判断对象是否是String类型
        if (anObject instanceof String) {
            //如果是String类型,则强转为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])
                        //有不相等的就返回false。
                        return false;
                    i++;
                }
                return true;//全部相等则返回true。
            }
        }
        return false;//以上两种情况都不符合,则返回false。
    }

    /**
     *
     * @since  1.4
     */
    public boolean contentEquals(StringBuffer sb) {
        return contentEquals((CharSequence)sb);
    }

    private boolean nonSyncContentEquals(AbstractStringBuilder sb) {
        char v1[] = value;
        char v2[] = sb.getValue();
        int n = v1.length;
        if (n != sb.length()) {
            return false;
        }
        for (int i = 0; i < n; i++) {
            if (v1[i] != v2[i]) {
                return false;
            }
        }
        return true;
    }

    /**
     *
     *
     * @since  1.5
     */
    public boolean contentEquals(CharSequence cs) {
        // Argument is a StringBuffer, StringBuilder
        if (cs instanceof AbstractStringBuilder) {
            if (cs instanceof StringBuffer) {
                synchronized(cs) {
                   return nonSyncContentEquals((AbstractStringBuilder)cs);
                }
            } else {
                return nonSyncContentEquals((AbstractStringBuilder)cs);
            }
        }
        // Argument is a String
        if (cs instanceof String) {
            return equals(cs);
        }
        // Argument is a generic CharSequence
        char v1[] = value;
        int n = v1.length;
        if (n != cs.length()) {
            return false;
        }
        for (int i = 0; i < n; i++) {
            if (v1[i] != cs.charAt(i)) {
                return false;
            }
        }
        return true;
    }

    /**
     * 忽略大小写比较
     */
    public boolean equalsIgnoreCase(String anotherString) {
        return (this == anotherString) ? true
                : (anotherString != null)
                && (anotherString.value.length == value.length)
                && regionMatches(true, 0, anotherString, 0, value.length);
    }

compareTo()

    /**
     * 排序规则
     * 返回的是数字,大于等于0则调用当前方法的对象排序在前,小于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++;
        }
        // 有长度为0的直接取相减的结果
        return len1 - len2;
    }

    /**
     * 忽略大小写排序
     * @since   1.2
     */
    public int compareToIgnoreCase(String str) {
        return CASE_INSENSITIVE_ORDER.compare(this, str);
    }
    /**
    * 此常量是专门为忽略大小写创建的。
    */
    public static final Comparator<String> CASE_INSENSITIVE_ORDER
                                         = new CaseInsensitiveComparator();
   	/**
    * 此内部类是为忽略大小写排序而构造的,上面可以看到常量就是这个内部类的实例。
    * 忽略大小写排序,就是调用这个内部类中的排序方法进行排序的。
    */
    private static class CaseInsensitiveComparator
            implements Comparator<String>, java.io.Serializable {
        // use serialVersionUID from JDK 1.2.2 for interoperability
        private static final long serialVersionUID = 8575799808933029326L;

        public int compare(String s1, String s2) {
            int n1 = s1.length();
            int n2 = s2.length();
            int min = Math.min(n1, n2);
            for (int i = 0; i < min; i++) {
                char c1 = s1.charAt(i);
                char c2 = s2.charAt(i);
                // 自此以上的逻辑和compareTo方法的逻辑是一样的,往下就不一样了。
                if (c1 != c2) {
                	//全部转化为大写比较
                    c1 = Character.toUpperCase(c1);
                    c2 = Character.toUpperCase(c2);
                    //若不相等再全部转化为小写比较
                    if (c1 != c2) {
                        c1 = Character.toLowerCase(c1);
                        c2 = Character.toLowerCase(c2);
                        // 还不相等直接相减。
                        if (c1 != c2) {
                            // No overflow because of numeric promotion
                            return c1 - c2;
                        }
                    }
                }
            }
            //若都相等,最后比的是长度的结果。
            return n1 - n2;
        }

        /** */
        private Object readResolve() { return CASE_INSENSITIVE_ORDER; }
    }

由源码得出String的compareTo的步骤如下:

  • 1.先获取两个字符串的长度。如果有字符串长度为0直接进行第3步。
  • 2.比较两个字符串相同长度的字符。每个字符依次比较,如果有不相同的则返回两个字符相减的值。
  • 3.如果比较的字符全部相等,则返回两个字符串长度之差。

由源码得出String的compareToIgnoreCase的步骤如下:

  • 1.先获取两个字符串的长度。
  • 2.取长度小的两个字符串的长度进行比较。如果两个字符相等,则进入下个字符的比较。
    • (1)如果两个字符不相等,全部转成大写进行比较。如果相等则进入下个字符的比较。
    • (2)如果两个字符不相等,则全部转为小写进行比较。如果相等则进入下个字符的比较。
    • (3)如果两个字符还不相等,则返回当前比较的两个字符之差。
  • 3.如果比较的字符全部相等,则最后返回两个字符串的长度之差。

regionMatches()

    /**
     * 测试两个字符串指定子集是否相等,即指定比较的区域是否相等。
     * @param   toffset   当前对象子集开始的位置
     * @param   other     要比较的对象。
     * @param   ooffset   要比较的对象的子集的开始位置。
     * @param   len       比较的长度。
     * @return 返回true表示子集相等,false表示子集不相等。
     */
    public boolean regionMatches(int toffset, String other, int ooffset,
            int len) {
        char ta[] = value; //当前对象的字符数组
        int to = toffset; //当前对象的开始位置
        char pa[] = other.value; //参数对象的字符数组
        int po = ooffset; //参数对象的开始位置
        // Note: toffset, ooffset, or len might be near -1>>>1.
        // 排除异常情况:两头超范围的排除
        if ((ooffset < 0) || (toffset < 0)
                || (toffset > (long)value.length - len)
                || (ooffset > (long)other.value.length - len)) {
            return false;
        }
        // 比较的次数为长度的次数
        while (len-- > 0) {
        	// 不相等就返回false
            if (ta[to++] != pa[po++]) {
                return false;
            }
        }
        // 全部安然度过循环,则表示相等。
        return true;
    }

    /**
     * 此方法增加了一个参数,是否忽略大小写。
     */
    public boolean regionMatches(boolean ignoreCase, int toffset,
            String other, int ooffset, int len) {
        char ta[] = value;
        int to = toffset;
        char pa[] = other.value;
        int po = ooffset;
        // Note: toffset, ooffset, or len might be near -1>>>1.
        if ((ooffset < 0) || (toffset < 0)
                || (toffset > (long)value.length - len)
                || (ooffset > (long)other.value.length - len)) {
            return false;
        }
        while (len-- > 0) {
            char c1 = ta[to++];
            char c2 = pa[po++];
            //从此处开始逻辑和不忽略大小写比较开始不同
            //如果相等进入下次循环。
            if (c1 == c2) {
                continue;
            }
            // 如果不相等则判断是否忽略大小写比较。
            if (ignoreCase) {
                // 如果是true则都转换成大写
                char u1 = Character.toUpperCase(c1);
                char u2 = Character.toUpperCase(c2);
                //如果相等则进入下次循环。
                if (u1 == u2) {
                    continue;
                }
                // 如果大写比较不相等,则转成小写进行比较,如果相等则进入下次循环
                if (Character.toLowerCase(u1) == Character.toLowerCase(u2)) {
                    continue;
                }
            }
            // 循环中一旦出现不相等则返回false。
            return false;
        }
        // 平安顺利的从循环中出来,则表示相等。
        return true;
    }

startsWith()

    /**
     *从toffset位置开始的以prefix开头的字符
     */
    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) {
            if (ta[to++] != pa[po++]) {
                return false;
            }
        }
        return true;
    }

    /**
     * 以字符prefix开头的字符串
     * @since   1. 0
     */
    public boolean startsWith(String prefix) {
        return startsWith(prefix, 0);
    }

endsWith()

    /**
     * 判断后缀是否与suffix相等
     */
    public boolean endsWith(String suffix) {
    	// 转换成前缀进行比较 当前对象的长度-后缀的长度=开始比较的位置
        return startsWith(suffix, value.length - suffix.value.length);
    }

hashCode()

    /**
     *
     */
    public int hashCode() {
        int h = hash;
        // 如果存在hash值的话,直接返回,不存在,进行如下计算
        if (h == 0 && value.length > 0) {
            char val[] = value;

            for (int i = 0; i < value.length; i++) {
                h = 31 * h + val[i];
            }
            // 计算完成之后,存入hash成员属性中,以便下次使用
            hash = h;
        }
        return h;
    }

indexOf()

    /**
     * 从fromIndex位置开始查找字符ch存在于当前对象的第一次出现的位置
     * @param   ch          字符的Unicode码
     * @param   fromIndex   开始查找的位置
     * @return 返回-1表示不存在,存在则返回位置。
     */
    public int indexOf(int ch, int fromIndex) {
    	// 获取当前对象的长度。
        final int max = value.length;
        // 判断formIndex是否非法
        if (fromIndex < 0) {
            fromIndex = 0; //小于0,则按0开始
        } else if (fromIndex >= max) {
            // 开始位置大于当前对象的长度,则返回-1
            return -1;
        }
		// 字符小于字符补码的最小值。
        if (ch < Character.MIN_SUPPLEMENTARY_CODE_POINT) {
            // 在这里处理很多复杂的情况,比如ch是一个BMP码,或者是一个负数
            final char[] value = this.value;
            //开始每个字符依次比较,相等则返回当前的位置
            for (int i = fromIndex; i < max; i++) {
                if (value[i] == ch) {
                    return i;
                }
            }
            //不相等则返回-1
            return -1;
        } else {//如果字符大于等于字符补码的最小值
        	//调用如下方法。
            return indexOfSupplementary(ch, fromIndex);
        }
    }
    /**
     * 从开始查找字符在字符串中的位置
     */
    public int indexOf(int ch) {
    	//直接调用fromIndex为0的方法。
        return indexOf(ch, 0);
    }

    /**
     *处理带有补充字符的indexOf的字符
     */
    private int indexOfSupplementary(int ch, int fromIndex) {
    	//判断当前字符是否是有正确的Unicode编码
        if (Character.isValidCodePoint(ch)) {
            final char[] value = this.value;
            // 获取ch在utf-16中的编码
            final char hi = Character.highSurrogate(ch);
            final char lo = Character.lowSurrogate(ch);
            final int max = value.length - 1;
            //逐个字符比较编码返回的字符,如果相等返回当前位置。
            for (int i = fromIndex; i < max; i++) {
                if (value[i] == hi && value[i + 1] == lo) {
                    return i;
                }
            }
        }
        //没有相等的则返回-1
        return -1;
    }
    /**
     * 查找字符串str在当前字符串对象中的位置。
     */
    public int indexOf(String str) {
        return indexOf(str, 0);
    }

    /**
     * 从fromIndex开始查找字符串str在当前字符串对象中的位置
     */
    public int indexOf(String str, int fromIndex) {
        return indexOf(value, 0, value.length,
                str.value, 0, str.value.length, fromIndex);
    }

    /**
     * 查找字符数组在字符串中的位置
     * @param   source       要查询的字符数组
     * @param   sourceOffset 要查询的字符数组的开始位置
     * @param   sourceCount  要查询的字符数组的长度
     * @param   target       被查询的字符串。
     * @param   fromIndex    开始查询的位置
     */
    static int indexOf(char[] source, int sourceOffset, int sourceCount,
            String target, int fromIndex) {
        return indexOf(source, sourceOffset, sourceCount,
                       target.value, 0, target.value.length,
                       fromIndex);
    }

    /**
     * 此方法为上述几个方法的基础,这还是一个静态方法。
     * @param   source       要查询的字符数组
     * @param   sourceOffset 要查询的字符数组的开始位置
     * @param   sourceCount  要查询的字符数组的长度
     * @param   target       被查询的字符串。
     * @param   targetOffset 被查询的字符串的开始位置
     * @param   targetCount  被查询的字符串的长度
     * @param   fromIndex    开始查询的位置
     */
    static int indexOf(char[] source, int sourceOffset, int sourceCount,
            char[] target, int targetOffset, int targetCount,
            int fromIndex) {
        // 判断开始位置是否超范围
        if (fromIndex >= sourceCount) {
            return (targetCount == 0 ? sourceCount : -1);
        }
        //开始位置如果小于0,则按0开始
        if (fromIndex < 0) {
            fromIndex = 0;
        }
        //如果被查询的字符串长度为0
        if (targetCount == 0) {
            return fromIndex;
        }
		// 开始依次比较
        char first = target[targetOffset];
        int max = sourceOffset + (sourceCount - targetCount);

        for (int i = sourceOffset + fromIndex; i <= max; i++) {
            /* Look for first character. */
            if (source[i] != first) {
                while (++i <= max && source[i] != first);
            }

            /* Found first character, now look at the rest of v2 */
            if (i <= max) {
                int j = i + 1;
                int end = j + targetCount - 1;
                for (int k = targetOffset + 1; j < end && source[j]
                        == target[k]; j++, k++);

                if (j == end) {
                    /* Found whole string. */
                    return i - sourceOffset;
                }
            }
        }
        return -1;
    }

lastIndexOf()

lastIndexOf()的逻辑,基本和indexOf()方法的逻辑相同。

    /**
     * 查找字符在字符串中最后出现的位置。
     */
    public int lastIndexOf(int ch) {
        return lastIndexOf(ch, value.length - 1);
    }

    /**
     * 从指定位置开始查找字符在字符串中出现的位置
     */
    public int lastIndexOf(int ch, int fromIndex) {
        if (ch < Character.MIN_SUPPLEMENTARY_CODE_POINT) {
            // handle most cases here (ch is a BMP code point or a
            // negative value (invalid code point))
            final char[] value = this.value;
            int i = Math.min(fromIndex, value.length - 1);
            for (; i >= 0; i--) {
                if (value[i] == ch) {
                    return i;
                }
            }
            return -1;
        } else {
            return lastIndexOfSupplementary(ch, fromIndex);
        }
    }

    /**
     * 处理带有补充字符的ch的方法
     */
    private int lastIndexOfSupplementary(int ch, int fromIndex) {
        if (Character.isValidCodePoint(ch)) {
            final char[] value = this.value;
            char hi = Character.highSurrogate(ch);
            char lo = Character.lowSurrogate(ch);
            int i = Math.min(fromIndex, value.length - 2);
            for (; i >= 0; i--) {
                if (value[i] == hi && value[i + 1] == lo) {
                    return i;
                }
            }
        }
        return -1;
    }
    /**
     * 查询字符串str在当前字符串对象中最后出现的位置
     */
    public int lastIndexOf(String str) {
        return lastIndexOf(str, value.length);
    }

    /**
     * 从fromIndex开始查询字符串str在当前字符串中最后出现的位置
     */
    public int lastIndexOf(String str, int fromIndex) {
        return lastIndexOf(value, 0, value.length,
                str.value, 0, str.value.length, fromIndex);
    }

    /**
     * 从formIndex的位置开始查询source在target中最后出现的位置
     */
    static int lastIndexOf(char[] source, int sourceOffset, int sourceCount,
            String target, int fromIndex) {
        return lastIndexOf(source, sourceOffset, sourceCount,
                       target.value, 0, target.value.length,
                       fromIndex);
    }

    /**
     * 从fromIndex开始查询字符数粗source从sourceOffset位置开始sourceCount个长度在target从targetOffset开始,targetCount长度中最后出现的位置
     */
    static int lastIndexOf(char[] source, int sourceOffset, int sourceCount,
            char[] target, int targetOffset, int targetCount,
            int fromIndex) {
        /*
         * Check arguments; return immediately where possible. For
         * consistency, don't check for null str.
         */
        int rightIndex = sourceCount - targetCount;
        if (fromIndex < 0) {
            return -1;
        }
        if (fromIndex > rightIndex) {
            fromIndex = rightIndex;
        }
        /* Empty string always matches. */
        if (targetCount == 0) {
            return fromIndex;
        }

        int strLastIndex = targetOffset + targetCount - 1;
        char strLastChar = target[strLastIndex];
        int min = sourceOffset + targetCount - 1;
        int i = min + fromIndex;

    startSearchForLastChar:
        while (true) {
            while (i >= min && source[i] != strLastChar) {
                i--;
            }
            if (i < min) {
                return -1;
            }
            int j = i - 1;
            int start = j - (targetCount - 1);
            int k = strLastIndex - 1;

            while (j > start) {
                if (source[j--] != target[k--]) {
                    i--;
                    continue startSearchForLastChar;
                }
            }
            return start - sourceOffset + 1;
        }
    }

substring()

    /**
     * 从beginIndex位置开始截取到末尾
     */
    public String substring(int beginIndex) {
        if (beginIndex < 0) {
            throw new StringIndexOutOfBoundsException(beginIndex);
        }
        // 获取截取的长度
        int subLen = value.length - beginIndex;
        if (subLen < 0) {
            throw new StringIndexOutOfBoundsException(subLen);
        }
        // 使用构造方法新创建一个对象。
        return (beginIndex == 0) ? this : new String(value, beginIndex, subLen);
    }

    /**
     * 从geginIndex位置开始截取到endIndex位置,含头不含尾。
     */
    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);
    }

    /**
     * 返回截取的字符序列
     * @since 1.4
     * @spec JSR-51
     */
    public CharSequence subSequence(int beginIndex, int endIndex) {
        return this.substring(beginIndex, endIndex);
    }

concat()

    /**
     * 将str连接到当前字符串对象的末尾
     */
    public String concat(String str) {
    	// 获取参数的长度
        int otherLen = str.length();
        //如果参数长度为0,返回当前对象
        if (otherLen == 0) {
            return this;
        }
        int len = value.length;
        // 将当前对象复制到另外一个字符数组中
        char buf[] = Arrays.copyOf(value, len + otherLen);
        // 将str也复制到数组中
        str.getChars(buf, len);
        // 返回数组新建的字符串对象
        return new String(buf, true);
    }

replace()

    /**
     * 将字符串中的oldChar替换成newChar。
     */
    public String replace(char oldChar, char newChar) {
    	// 判断两个字符是否相等
        if (oldChar != newChar) {
        	// 获取当前对象的长度
            int len = value.length;
            int i = -1;//定义开始的位置
            char[] val = value; //复制当前对象
			//查找第一次出现oldChar的位置
            while (++i < len) {
                if (val[i] == oldChar) {
                    break;
                }
            }
            if (i < len) {
                char buf[] = new char[len];
                //复制第一次出现oldChar位置之前的字符
                for (int j = 0; j < i; j++) {
                    buf[j] = val[j];
                }
                while (i < len) {
                    char c = val[i];
                    //从第一次出现oldChar的位置开始判断赋值
                    buf[i] = (c == oldChar) ? newChar : c;
                    i++;
                }
                return new String(buf, true);
            }
        }
        return this;
    }
    /**
     * 替换第一次出现的子字符串
     * @since 1.4
     * @spec JSR-51
     */
    public String replaceFirst(String regex, String replacement) {
        return Pattern.compile(regex).matcher(this).replaceFirst(replacement);
    }

    /**
     * 替换所有出现的子字符串
     * @since 1.4
     * @spec JSR-51
     */
    public String replaceAll(String regex, String replacement) {
        return Pattern.compile(regex).matcher(this).replaceAll(replacement);
    }

    /**
     * 用指定的文字替换序列替换与文字目标序列匹配的字符串的每个子字符串。替换从字符串的开始到结束,例如,将字符串“aaa”中的“aa”替换为“b”将导致“ba”而不是“ab”。
     * @since 1.5
     */
    public String replace(CharSequence target, CharSequence replacement) {
        return Pattern.compile(target.toString(), Pattern.LITERAL).matcher(
                this).replaceAll(Matcher.quoteReplacement(replacement.toString()));
    }

matches()

    /**
     * 正则匹配
     * @since 1.4
     * @spec JSR-51
     */
    public boolean matches(String regex) {
        // 直接调用正则对象的方法
        return Pattern.matches(regex, this);
    }

contains()

    /**
     * 是否包含对象。
     * @since 1.5
     */
    public boolean contains(CharSequence s) {
    	// 调用indexOf()方法判断位置的值。
        return indexOf(s.toString()) > -1;
    }

split()

    /**
     * 按指定分隔符,分割指定的次数
     * @param  regex 分割符
     * @param  limit 结果阈值。如果limit大于0那么结果的数组长度不大于limit,如果limit小于等于0,那么结果的数组长度不受限制。
     * @since 1.4
     * @spec JSR-51
     */
    public String[] split(String regex, int limit) {

        char ch = 0;
        if (((regex.value.length == 1 &&//regex的长度=1
             ".$|()[{^?*+\\".indexOf(ch = regex.charAt(0)) == -1) ||
             //不包含正则的符号
             // 上面两段是一个条件:regex的长度为1且不包含正则符号
             (regex.length() == 2 &&//regex的长度=2
              regex.charAt(0) == '\\' &&//regex的第一个字符为反斜杠
              (((ch = regex.charAt(1))-'0')|('9'-ch)) < 0 &&
              //regex的第二个字符不是数字
              ((ch-'a')|('z'-ch)) < 0 &&
              // 第二个字符不是小写字母
              ((ch-'A')|('Z'-ch)) < 0)) &&
              // 第二个字符不是大写字母
            (ch < Character.MIN_HIGH_SURROGATE ||
             ch > Character.MAX_LOW_SURROGATE))
             //第二个字符不是utf-16中的字符
             //这是第二个允许的条件:regex是2个字符,第一个字符是反斜杠并且第二个字符不是数字、字母、utf-16的编码
             //这两个条件的综合表示为单个字符和转义字符
        {
            int off = 0;
            int next = 0;
            boolean limited = limit > 0;
            ArrayList<String> list = new ArrayList<>();
            // 当ch字符存在于当前字符串中,进入循环
            while ((next = indexOf(ch, off)) != -1) {
            	// 结果数组元素个数没满或者集合中的元素个数小于分割次数-1
                if (!limited || list.size() < limit - 1) {
                	// 从开始位置开始截取,截取到下一个分隔符之前,然后添加到集合中
                    list.add(substring(off, next));
                    // 开始截取位置挪到下一个分隔符之后
                    off = next + 1;
                } else {    // 最后一个位置
                    //assert (list.size() == limit - 1);
                    // 最后一次截取直接将剩余的所有字符放入一个对象中,放入集合
                    list.add(substring(off, value.length));
                    off = value.length;
                    //结束循环
                    break;
                }
            }
            // 如果上面没有匹配上,将使用这个
            if (off == 0)
            	// 返回当前对象组成的数组
                return new String[]{this};

            // Add remaining segment
            if (!limited || list.size() < limit)
                list.add(substring(off, value.length));

            // Construct result
            int resultSize = list.size();
            // 修正集合的元素个数。
            if (limit == 0) {
                while (resultSize > 0 && list.get(resultSize - 1).length() == 0) {
                    resultSize--;
                }
            }
            // 声明结果所用的数组
            String[] result = new String[resultSize];
            将集合转换到数组中返回。
            return list.subList(0, resultSize).toArray(result);
        }
        // 如果regex是正则则使用正则的方法分割
        return Pattern.compile(regex).split(this, limit);
    }

    /**
     * 根据regex进行分割
     * @since 1.4
     * @spec JSR-51
     */
    public String[] split(String regex) {
        return split(regex, 0);
    }

join()

    /**
     * 返回一个新的字符串,字符串有连接符连接每个元素。
     * @param  delimiter 连接每个element的字符
     * @param  elements  被连接的元素
     * @since 1.8
     */
    public static String join(CharSequence delimiter, CharSequence... elements) {
    	// 判断两个元素对象是否存在引用
        Objects.requireNonNull(delimiter);
        Objects.requireNonNull(elements);
        // 如下对象是使用指定连接符连接字符序列
        StringJoiner joiner = new StringJoiner(delimiter);
        for (CharSequence cs: elements) {
            joiner.add(cs);
        }
        return joiner.toString();
    }

    /**
     *
     * @since 1.8
     */
    public static String join(CharSequence delimiter,
            Iterable< ? extends CharSequence> elements) {
        Objects.requireNonNull(delimiter);
        Objects.requireNonNull(elements);
        StringJoiner joiner = new StringJoiner(delimiter);
        for (CharSequence cs: elements) {
            joiner.add(cs);
        }
        return joiner.toString();
    }

toLowerCase()

以下转换为小写的逻辑,本人没有看懂,所以以后待补充。

    /**
     * 将字符串转换成小写
     * @since   1.1
     */
    public String toLowerCase(Locale locale) {
    	// 如果locale为null 直接抛出异常
        if (locale == null) {
            throw new NullPointerException();
        }

        int firstUpper;
        final int len = value.length;

        // 开始检查是否有字符需要修改
        scan: {//循环标号
            for (firstUpper = 0 ; firstUpper < len; ) {
                char c = value[firstUpper];
                // 字符c在编码范围之内
                if ((c >= Character.MIN_HIGH_SURROGATE)
                        && (c <= Character.MAX_HIGH_SURROGATE)) {
                    // 获取当前对象第一个字符的Unicode编码
                    int supplChar = codePointAt(firstUpper);
                    如果编码不等于小写的编码,循环跳到scan位置
                    if (supplChar != Character.toLowerCase(supplChar)) {
                        break scan;
                    }
                    firstUpper += Character.charCount(supplChar);
                } else {
                    if (c != Character.toLowerCase(c)) {
                        break scan;
                    }
                    firstUpper++;
                }
            }
            return this;
        }

        char[] result = new char[len];
        int resultOffset = 0;  /* result may grow, so i+resultOffset
                                * is the write location in result */

        /* Just copy the first few lowerCase characters. */
        System.arraycopy(value, 0, result, 0, firstUpper);

        String lang = locale.getLanguage();
        boolean localeDependent =
                (lang == "tr" || lang == "az" || lang == "lt");
        char[] lowerCharArray;
        int lowerChar;
        int srcChar;
        int srcCount;
        for (int i = firstUpper; i < len; i += srcCount) {
            srcChar = (int)value[i];
            if ((char)srcChar >= Character.MIN_HIGH_SURROGATE
                    && (char)srcChar <= Character.MAX_HIGH_SURROGATE) {
                srcChar = codePointAt(i);
                srcCount = Character.charCount(srcChar);
            } else {
                srcCount = 1;
            }
            if (localeDependent ||
                srcChar == '\u03A3' || // GREEK CAPITAL LETTER SIGMA
                srcChar == '\u0130') { // LATIN CAPITAL LETTER I WITH DOT ABOVE
                lowerChar = ConditionalSpecialCasing.toLowerCaseEx(this, i, locale);
            } else {
                lowerChar = Character.toLowerCase(srcChar);
            }
            if ((lowerChar == Character.ERROR)
                    || (lowerChar >= Character.MIN_SUPPLEMENTARY_CODE_POINT)) {
                if (lowerChar == Character.ERROR) {
                    lowerCharArray =
                            ConditionalSpecialCasing.toLowerCaseCharArray(this, i, locale);
                } else if (srcCount == 2) {
                    resultOffset += Character.toChars(lowerChar, result, i + resultOffset) - srcCount;
                    continue;
                } else {
                    lowerCharArray = Character.toChars(lowerChar);
                }

                /* Grow result if needed */
                int mapLen = lowerCharArray.length;
                if (mapLen > srcCount) {
                    char[] result2 = new char[result.length + mapLen - srcCount];
                    System.arraycopy(result, 0, result2, 0, i + resultOffset);
                    result = result2;
                }
                for (int x = 0; x < mapLen; ++x) {
                    result[i + resultOffset + x] = lowerCharArray[x];
                }
                resultOffset += (mapLen - srcCount);
            } else {
                result[i + resultOffset] = (char)lowerChar;
            }
        }
        return new String(result, 0, len + resultOffset);
    }

    /**
     *
     */
    public String toLowerCase() {
        return toLowerCase(Locale.getDefault());
    }

toUpperCase()

转换大写的逻辑和转换小写的逻辑是一样的。

    /**
     * 
     * @since   1.1
     */
    public String toUpperCase(Locale locale) {
        if (locale == null) {
            throw new NullPointerException();
        }

        int firstLower;
        final int len = value.length;

        /* Now check if there are any characters that need to be changed. */
        scan: {
            for (firstLower = 0 ; firstLower < len; ) {
                int c = (int)value[firstLower];
                int srcCount;
                if ((c >= Character.MIN_HIGH_SURROGATE)
                        && (c <= Character.MAX_HIGH_SURROGATE)) {
                    c = codePointAt(firstLower);
                    srcCount = Character.charCount(c);
                } else {
                    srcCount = 1;
                }
                int upperCaseChar = Character.toUpperCaseEx(c);
                if ((upperCaseChar == Character.ERROR)
                        || (c != upperCaseChar)) {
                    break scan;
                }
                firstLower += srcCount;
            }
            return this;
        }

        /* result may grow, so i+resultOffset is the write location in result */
        int resultOffset = 0;
        char[] result = new char[len]; /* may grow */

        /* Just copy the first few upperCase characters. */
        System.arraycopy(value, 0, result, 0, firstLower);

        String lang = locale.getLanguage();
        boolean localeDependent =
                (lang == "tr" || lang == "az" || lang == "lt");
        char[] upperCharArray;
        int upperChar;
        int srcChar;
        int srcCount;
        for (int i = firstLower; i < len; i += srcCount) {
            srcChar = (int)value[i];
            if ((char)srcChar >= Character.MIN_HIGH_SURROGATE &&
                (char)srcChar <= Character.MAX_HIGH_SURROGATE) {
                srcChar = codePointAt(i);
                srcCount = Character.charCount(srcChar);
            } else {
                srcCount = 1;
            }
            if (localeDependent) {
                upperChar = ConditionalSpecialCasing.toUpperCaseEx(this, i, locale);
            } else {
                upperChar = Character.toUpperCaseEx(srcChar);
            }
            if ((upperChar == Character.ERROR)
                    || (upperChar >= Character.MIN_SUPPLEMENTARY_CODE_POINT)) {
                if (upperChar == Character.ERROR) {
                    if (localeDependent) {
                        upperCharArray =
                                ConditionalSpecialCasing.toUpperCaseCharArray(this, i, locale);
                    } else {
                        upperCharArray = Character.toUpperCaseCharArray(srcChar);
                    }
                } else if (srcCount == 2) {
                    resultOffset += Character.toChars(upperChar, result, i + resultOffset) - srcCount;
                    continue;
                } else {
                    upperCharArray = Character.toChars(upperChar);
                }

                /* Grow result if needed */
                int mapLen = upperCharArray.length;
                if (mapLen > srcCount) {
                    char[] result2 = new char[result.length + mapLen - srcCount];
                    System.arraycopy(result, 0, result2, 0, i + resultOffset);
                    result = result2;
                }
                for (int x = 0; x < mapLen; ++x) {
                    result[i + resultOffset + x] = upperCharArray[x];
                }
                resultOffset += (mapLen - srcCount);
            } else {
                result[i + resultOffset] = (char)upperChar;
            }
        }
        return new String(result, 0, len + resultOffset);
    }

    /**
     * 
     */
    public String toUpperCase() {
        return toUpperCase(Locale.getDefault());
    }

trim()

    /**
     * 去空
     */
    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--;
        }
        // 如果没有空格则返回自身,有空格返回截取掉两头空格的字符串
        return ((st > 0) || (len < value.length)) ? substring(st, len) : this;
    }

toString()

    /**
     * 字符串表示,直接返回本身
     */
    public String toString() {
        return this;
    }

toCharArray()

    /**
     * 转换为字符数组
     */
    public char[] toCharArray() {
        // 由于类初始化顺序的问题,这里不能使用Arrays.copyOf。
        char result[] = new char[value.length];
        // 这里使用的是另外一个拷贝方法
        System.arraycopy(value, 0, result, 0, value.length);
        return result;
    }

format()

    /**
     * 字符串格式化
     * @since  1.5
     */
    public static String format(String format, Object... args) {
        return new Formatter().format(format, args).toString();
    }

    /**
     *
     * @see  java.util.Formatter
     * @since  1.5
     */
    public static String format(Locale l, String format, Object... args) {
        return new Formatter(l).format(format, args).toString();
    }

valueOf()

    /**
     * 转化为字符串结果
     */
    public static String valueOf(Object obj) {
    	//直接调用的对象的toString()方法
        return (obj == null) ? "null" : obj.toString();
    }

    /**
     * char数组转化为字符串结果
     */
    public static String valueOf(char data[]) {
        // 直接新建一个String对象
        return new String(data);
    }

    /**
     * 从offset位置开始,将count个data中的字符转化成字符串。
     */
    public static String valueOf(char data[], int offset, int count) {
        return new String(data, offset, count);
    }

    /**
     * 拷贝字符数组的字符串结果
     */
    public static String copyValueOf(char data[], int offset, int count) {
        return new String(data, offset, count);
    }

    /**
     *
     */
    public static String copyValueOf(char data[]) {
        return new String(data);
    }

    /**
     * 返回布尔类型的字符串表示形式
     */
    public static String valueOf(boolean b) {
        return b ? "true" : "false";
    }

    /**
     * 返回字符的字符串表示形式
     */
    public static String valueOf(char c) {
        char data[] = {c};
        return new String(data, true);
    }

    /**
     * 返回int的字符串表示形式
     */
    public static String valueOf(int i) {
        return Integer.toString(i);
    }

    /**
     * 返回long的字符串表示形式
     */
    public static String valueOf(long l) {
        return Long.toString(l);
    }

    /**
     * 返回float的字符串表示形式
     */
    public static String valueOf(float f) {
        return Float.toString(f);
    }

    /**
     * 返回double的字符串表示形式
     */
    public static String valueOf(double d) {
        return Double.toString(d);
    }

    /**
     * 返回字符串对象的标准表示形式。
     * 一个本地方法。
     */
    public native String intern();

以上就是String的全部源码,如有错误请批评指正。

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

发表于

我来说两句

0 条评论
登录 后参与评论

扫码关注云+社区

领取腾讯云代金券