何时在API中使用CharSequence


问题内容

我正在为程序包设计一个公共接口(API)。我想知道,我应该CharSequence一般使用代替String。(我主要是在谈论公共接口)。

这样做有什么弊端吗?这被认为是一种好习惯吗?

将其用于类似标识符的目的(将值与基于散列的容器中的集合进行匹配时)如何处理?


问题答案:

CharSequence在通用库中很少使用。通常在主要用例是字符串处理(操作,解析等)时使用。

一般来说
,你可以做一个东西CharSequence,你可以用做String(平凡的,因为你可以每次转换CharSequenceString)。但是有一个重要的区别:
不能保证 ACharSequence是不变的!每当处理a
String并在两个不同的时间点对其进行检查时,都可以确保每次都具有相同的值。


但是对于CharSequence那不一定是正确的。例如,有人可以将a传递给StringBuilder您的方法并
在您对其执行操作时对其进行 修改,这可能会破坏许多理智的代码。

考虑以下伪代码:

public Object frobnicate(CharSequence something) {
  Object o = getFromCache(something);
  if (o == null) {
    o = computeValue(something);
    putIntoCache(o, something);
  }
  return o;
}

这看起来无害,如果您在String这里使用过,它通常可以正常工作(除非可能会计算两次该值)。但是,如果something为,CharSequence则其内容可以在getFromCache呼叫和computeValue呼叫之间改变。或更糟糕的是:在computeValue通话和putIntoCache通话之间!

因此: 只有CharSequence优势很大 并且 知道缺点的情况下 接受。

如果
您接受CharSequence,则应记录您的API如何处理可变CharSequence对象。例如:“在方法执行时修改参数会导致未定义的行为。”