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