Java源碼學習 -- java.lang.String

java.lang.String是使用頻率非常高的類。要想更好的使用java.lang.String類，了解其源代碼實現是非常有必要的。由java.lang.String，自然聯想到java.lang.StringBuffer和java.lang.StringBuilder，下篇文章再來研究java.lang.StringBuffer和java.lang.StringBuilder。

重要屬性

java.lang.String對象中字符串主要是以字符數組的形式存儲。當調用對象方法獲取字符串長度時，直接返回數組長度。判斷字符串是否為空isEmpty()時，也直接檢查數組長度是否為0。其部分發生代碼如下所示：

    /** The value is used for character storage. */
    private final char value[];

    /** Cache the hash code for the string */
    private int hash; // Default to 0

value：存儲字符串的字符數組。該數組為final變量，一旦賦值，將不會更改。

hash：該String對象的哈希值。

構造方法

java.lang.String對象構造方法比較多，列舉如下：

    public String()
    public String(String original)
    public String(char value[])
    public String(char value[], int offset, int count)
    public String(int[] codePoints, int offset, int count)
@Deprecated
    public String(byte ascii[], int hibyte, int offset, int count)
@Deprecated
    public String(byte ascii[], int hibyte)
    public String(byte bytes[], int offset, int length, String charsetName) throws UnsupportedEncodingException
    public String(byte bytes[], int offset, int length, Charset charset)
    public String(byte bytes[], String charsetName) throws UnsupportedEncodingException
    public String(byte bytes[], Charset charset)
    public String(byte bytes[], int offset, int length)
    public String(byte bytes[])
    public String(StringBuffer buffer)
    public String(StringBuilder builder)

在 public String(StringBuffer buffer) 中，傳入形參為StringBuffer，StringBuffer為線程安全類。則在此構造方法內部進行了synchronized關鍵字鎖同步。代碼如下：

    public String(StringBuffer buffer) {
        synchronized(buffer) {
            this.value = Arrays.copyOf(buffer.getValue(), buffer.length());
        }
    }

在 public String(StringBuilder builder) 中，傳入形參為StringBuilder，StringBuilder為非線程安全類。則在此構造方法內部內部未做同步處理，對比 public String(StringBuffer buffer) 。代碼如下：

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

常用方法

java.lang.String對象中封裝方法非常多，僅針對常用方法源代碼進行分析。如：equals()，replace(), indexOf()，startsWith()，compareTo()，regionMathes()，hashCode()。

public boolean equals(Object anObject)

用於比較兩對象存儲內容是否相同。采用比較巧妙的方式進行排除比較：（1）先“==”比較兩對象是否是同一對象，若是，直接返回true， 否則進一步判斷；（2）判斷待比較對象類型是否是java.lang.String，若不是，直接返回false，否則進一步判斷；（3）判斷兩字符串長度是否相等，若不是直接返回false，否則進一步判斷；（4）從字符數組中第一個字符開始，依次進行比較，一旦發現不相同字符直接返回false，若所在字符均相同則返回true。對字符數組中字符依次進行比較是一件非常耗時的操作，將此操作放在最后執行，先利用其它條件進行對其進行判斷。比較巧妙！

    public boolean equals(Object anObject) {
        if (this == anObject) {
            return true;
        }
        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;
    }

public String replace(char oldChar, char newChar)

將字符串中指定字符替換為新的字符。（1）先判斷待替換字符和新字符是否相同，若相同，則直接返回原字符串，若不同，則繼續執行；（2）找出第一次出現待替換字符位置i，創建新的等長字符數組，將該位置之前的字符依次放入新的字符數組中；（3）從位置i處依次遍歷比較原字符數組中字符是否是待替換字符，若是，則將新字符放入新字符數組對應位置，若不是，則將原字符數組中字符放入對應位置。巧妙做了一個小優化，直接找出第一次出現待替換字符的位置，再從此處開始遍歷，提高效率。

    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;
    }

public String replace(CharSequence target, CharSequence replacement)

該方法是我們通常意義所用到的 public String replace(String target, String replacement) ，java.lang.String實現了java.lang.CharSequence接口。方法內部調用正則表達式匹配替換來實現。

    public String replace(CharSequence target, CharSequence replacement) {
        return Pattern.compile(target.toString(), Pattern.LITERAL).matcher(
                this).replaceAll(Matcher.quoteReplacement(replacement.toString()));
    }

public int indexOf(String str)

該方法是找出目標字符串是第一次出現指定子字符串的位置，若不存在，則返回-1，若存在，則返回位置坐標。具體實現是調用 static int indexOf(char[] source, int sourceOffset, int sourceCount, char[] target, int targetOffset, int targetCount, int fromIndex) 方法。先對目標字符串中出現子字符串的位置可能范圍，然后在此范圍中遍歷找出與子字符串第一個字符相同的位置，並對后面字符進行比較分析。

      /**
      * Returns the index within this string of the first occurrence of the
      * specified substring.
      */
     public int indexOf(String str) {
         return indexOf(str, 0);
     }
 
     /**
      * Returns the index within this string of the first occurrence of the
      * specified substring, starting at the specified index.
      */
     public int indexOf(String str, int fromIndex) {
         return indexOf(value, 0, value.length,
                 str.value, 0, str.value.length, fromIndex);
     }
 
     /**
      * Code shared by String and StringBuffer to do searches. The
      * source is the character array being searched, and the target
      * is the string being searched for.
      *
      * @param   source       the characters being searched.
      * @param   sourceOffset offset of the source string.
      * @param   sourceCount  count of the source string.
      * @param   target       the characters being searched for.
      * @param   targetOffset offset of the target string.
      * @param   targetCount  count of the target string.
      * @param   fromIndex    the index to begin searching from.
      */
     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);
         }
         if (fromIndex < 0) {
             fromIndex = 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;
     }

public int compareTo(String anotherString)

該方法是對字符串集合進行排序的基礎，通過此方法可比較兩字符串大小，原理很簡單，源代碼如下：

    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;
    }

public boolean startsWith(String prefix)

判斷目標字符串是否以指定字符子串開關，該方法內部是調用 public boolean startsWith(String prefix, int toffset) 方法實現，原理很簡單，代碼如下：

    /**
     * Tests if this string starts with the specified prefix.
     *
     * @param   prefix   the prefix.
     */
    public boolean startsWith(String prefix) {
        return startsWith(prefix, 0);
    }

public int hashCode()

其hashCode()代碼如下：

    public int hashCode() {
        int h = hash;
        if (h == 0 && value.length > 0) {
            char val[] = value;

            for (int i = 0; i < value.length; i++) {
                h = 31 * h + val[i];
            }
            hash = h;
        }
        return h;
    }