在某些情况下，直接访问 String 的后备数组是否合理？

Question

我正在优化文本处理软件，其中使用了以下类：

class Sentence {

  private final char[] textArray;
  private final String textString; 

  public Sentence(String text) {
     this.textArray = text.toCharArray();
     this.textString = text;
  }

  public String getString() {
     return textString;
  }

  public char[] getArray() {
     return textArray;
  } 
}

如您所见，存在一些冗余：textString 的支持数组始终等于 textArray，但两者都被存储。

我希望通过去掉 textArray 字段来减少此类的内存​​占用。

有一个问题：这个类在代码库中被广泛使用，因此我无法摆脱 getArray() 方法。我的解决方案是去掉 textArray 字段，让 getArray() 方法通过反射返回 textSting 的支持数组。

结果会是这样的：

class Sentence {

  private final String textString; 

  public Sentence(String text) {
       this.textString = text;
  }

  public String getString() {
     return textString;
  }

  public char[] getArray() {
     return getBackingArrayUsingReflection(textString);
  } 
}

这似乎是一个可行的解决方案，但我怀疑 String 的后备数组是私有的是有原因的。这种方法有哪些潜在问题？

Answer 1

将会发生的一件事是您将自己提交给 JDK 的一个特定实现。例如，Java 7 Update 6 完全修改了其对char[] 的使用。这就是为什么只有当你的代码是非常短暂的，基本上是一次性的代码时才应该容忍这种方法。

如果您只阅读char[]，并且您正在为 OpenJDK Java 7 Update 6 编写代码，则不会引入任何错误。

另一方面，全世界 95% 的 Java 程序员可能会对反映 String 内部结构的代码表示怀疑，所以要小心 :)

Answer 2

根据java.lang.String（Java 7 Update 5 及更早版本）的版本，它使用一个后备数组，以及该数组中实际字符串的开始索引和长度 (count)。在 Java 的这些实现中，后备数组可以（基本上）比实际字符串长，并且字符串不一定从数组的开头开始。

例如，当您使用substring 时，后备数组可能与原始字符串的后备数组相同，只是起始索引和字符数不同。因此，使用反射返回 String 的支持数组并非在所有情况下都有效（或者：它会导致不正确/意外的行为）。

参见例如http://www.docjar.com/html/api/java/lang/String.java.htmlString substring(int beginIndex, int endIndex) 在第 1950 行（及以下），它调用构造函数 String(int offset, int count, char value[]) 在第 645 行（及以下）。这里char[]直接作为后备数组，offset和count分别作为到数组的偏移量和字符串的长度：

public String substring(int beginIndex, int endIndex) {
    if (beginIndex < 0) {
        throw new StringIndexOutOfBoundsException(beginIndex);
    }
    if (endIndex > count) {
        throw new StringIndexOutOfBoundsException(endIndex);
    }
    if (beginIndex > endIndex) {
        throw new StringIndexOutOfBoundsException(endIndex - beginIndex);
    }
    return ((beginIndex == 0) && (endIndex == count)) ? this :
        new String(offset + beginIndex, endIndex - beginIndex, value);
}

// Package private constructor which shares value array for speed.
String(int offset, int count, char value[]) {
    this.value = value;
    this.offset = offset;
    this.count = count;
}

正如 Marko Topolnik 所指出的，更多的recent versions of Java 7 不再是这种情况。您不应该依赖于 Java 的实现细节（尤其是因为它可以在版本之间发生重大变化 - 如图所示）。

Answer 3

如果您想要更快，请使用String.charAt(i)，它将被内联并避免任何与更改 inetrnals 相关的问题。如果你想避免从 StringBuilder 创建 String，你可以使用 CharSequence，因为它们都支持这个接口。

Answer 4

为了娱乐和游戏，运行以下单元测试：

public class StringTest {
    private String text;

    public StringTest() {
        super();
    }

    public char[] getBackingArray() {
        if (text == null) {
            return null;
        }

        try {
            final Field valueField = text.getClass().getDeclaredField("value");
            valueField.setAccessible(true);
            final char[] data = (char[]) valueField.get(text);
            return data;
        } catch (final Exception e) {
            e.printStackTrace();
        }

        return null;
    }

    public String getText() {
        return text;
    }

    public void setText(String text) {
        this.text = text;
    }

    @Test
    public void testStringFunManipulation() {
        final StringTest test = new StringTest();
        test.setText("Hello World");
        Assert.assertNotNull(test);
        System.out.println("Original String: " + test);
        System.out
                .println("Original String Hash: " + test.getText().hashCode());

        char[] data = test.getBackingArray();
        Assert.assertNotNull(data);
        System.out.println("Backing Array: " + data);

        data[0] = 'J';
        System.out.println("Modified String: " + test);
        System.out
                .println("Modified String Hash: " + test.getText().hashCode());
        System.out.println("Modified String Hash Should be: "
                + "Jello World".hashCode());
    }

    @Override
    public String toString() {
        return text != null ? text.toString() : "";
    }
}

它应该可以回答为什么公开类的内部私有值可能是个坏主意。

Answer 5

您可以按如下方式更改getArray 实现：

public char[] getArray() 
{
    return this.textString.toCharArray();
}