Guava 译文系列）Strings

Posted on Edited on In

Joiner

以某种分隔符连接连接字符串序列通常不应该那么麻烦，当序列中包含 null 值的时候尤甚。流式风格的 Joiner 简化了这种操作。

1
2
Joiner joiner = Joiner.on("; ").skipNulls();
return joiner.join("Harry", null, "Ron", "Hermione");

上述代码将返回字符串：”Harry; Ron; Hermione“。除了skipNulls以外，还可以用useForNull(String)来指定将 null 替换为给定的字符串。

你也可以直接对对象使用 Joiner ，这会自动调用对象的toString()方法后进行拼接。

1
Joiner.on(",").join(Arrays.asList(1, 5, 7)); // returns "1,5,7"

注意：joiner 实例是不可变的。因此 joiner 的配置方法总会返回一个新的 Joiner，并通过这种方式来获取所需语义的 joiner。这种特性让Joiner能够线程安全，并可以将之定义为一个static final的常量。

Splitter

Java 内置的字符串分割器存在一些古怪的行为。例如：String.split 会默默地丢弃最尾部的分隔符，而 StringTokenizer只用五个空格来工作。（译者注：原文 “StringTokenizer respects exactly five whitespace characters and nothing else”。这里应该是指StringTokenizer默认采用\n \r, 空格，Tab 符，换页符这五种符号来分隔字符串，而这五种符号在字符串中都以类似“空格”的形式显示。）

小测验: ",a,,b,".split(",") 会返回什么结果？

  1. "", "a", "", "b", ""
  2. null, "a", null, "b", null
  3. "a", null, "b"
  4. "a", "b"
  5. 以上都不对

正确答案是以上都不对，返回的实际是"", "a", "", "b"。只有尾部的分隔符被忽略掉了。我甚至都搞不懂为什么要这么做。

Splitter 采用令人安心且直截了当的流式风格来允许用户完全的控制它并避免出现所有那些令人困惑的行为。

1
2
3
4
Splitter.on(',')
    .trimResults()
    .omitEmptyStrings()
    .split("foo,bar,,   qux");

上述代码会返回一个包含了"foo", "bar", "qux" 的Iterable<String>。Splitter可以被配置为使用Pattern, char, String或 CharMatcher来进行分割。

基本工厂方法

Method Description Example
Splitter.on(char) 在出现特定的单个字符时分割。 Splitter.on(';')
Splitter.on(CharMatcher) 在某个类别中出现任意字符时分割。 Splitter.on(CharMatcher.BREAKING_WHITESPACE)
Splitter.on(CharMatcher.anyOf(";,."))
Splitter.on(String) 以String字面量分割。 Splitter.on(", ")
Splitter.on(Pattern)
Splitter.onPattern(String)		 以正则表达式分割。 Splitter.onPattern("\r?\n")
Splitter.fixedLength(int) 将字符串以固定长度字符数来分割。最后一个部分的长度有可能小于length，但一定不会为空。 Splitter.fixedLength(3)

修饰方法

Method Description Example
omitEmptyStrings() 自动忽略结果中包含的空字符串。 Splitter.on(',').omitEmptyStrings().split("a,,c,d") returns "a", "c", "d"
trimResults() 删除结果中的空格符，与trimResults(CharMatcher.WHITESPACE)的语义相同。 Splitter.on(',').trimResults().split("a, b, c, d") returns "a", "b", "c", "d"
trimResults(CharMatcher) 删除结果中匹配CharMatcher的字符。 Splitter.on(',').trimResults(CharMatcher.is('_')).split("_a ,_b_ ,c__") returns "a ", "b_ ", "c".
limit(int) 在指定数量的字串被返回后停止分割。 Splitter.on(',').limit(3).split("a,b,c,d") returns "a", "b", "c,d"

如果你想要返回List，使用splitToList()来代替split()。

注意：splitter 实例是不可变的。因此 joiner 的配置方法总会返回一个新的 Splitter，并通过这种方式来获取所需语义的 joiner。这种特性让Splitter能够线程安全，并可以将之定义为一个static final的常量。

Map 分割器

You can also use a splitter to deserialize a map by specifying a second delimiter using withKeyValueSeparator().

The resulting MapSplitter will split the input into entries using the splitter's delimiter, and then split those entries into keys and values using the given key-value separator, returning a Map<String, String>.

你也可以用splitter来将字符串反序列化为一个 map，通过withKeyValueSeparator()来指定第二个分隔符。

MapSplitter 的结果会通过分隔符来将输入分割为entries，之后通过给定的 key-value 分隔器将这些entrie分割成 key 和 value，最后返回Map<String, String>。

CharMatcher

过去的时候，我们的StringUtil类逐渐变得不受控制，他拥有很多类似如下的方法：

  • allAscii
  • collapse
  • collapseControlChars
  • collapseWhitespace
  • lastIndexNotOf
  • numSharedChars
  • removeChars
  • removeCrLf
  • retainAllChars
  • strip
  • stripAndCollapse
  • stripNonDigits

他们代表了两种概念的交叉产物：

  1. “匹配”字符是由什么组成的？
  2. 用“匹配”到的字符能干什么？

为了简化这一团乱码，我们开发了 CharMatcher。

直觉上，你可以把CharMatcher当作是一个特殊的字符类，比如数字或空格符。实际上，CharMatcher只是基于字符上的一种布尔断言 -- 的确，CharMatcher实现了[Predicate<Character>] -- 但是由于指代 “所有空格符” 或 “所有小写字符” 的情况很常见，所以 Guava 提供了这个字符专用的语法和 API。

但CharMatcher的实用之处在于他能够在出现指定字符类型时才执行相关_操作_：截断，折叠，移除，保留等等。一个CharMatcher类型的对象能代表：概念 1，“匹配”字符是由什么组成的？之后他提供了许多操作来实现概念 2：用“匹配”到的字符能干什么？当然最终 API 的复杂度会随着更加灵活和功能更强的方向而线性增长。Yay！

1
2
3
4
5
6
7
String noControl = CharMatcher.javaIsoControl().removeFrom(string); // remove control characters
String theDigits = CharMatcher.digit().retainFrom(string); // only the digits
String spaced = CharMatcher.whitespace().trimAndCollapseFrom(string, ' ');
  // trim whitespace at ends, and replace/collapse whitespace into single spaces
String noDigits = CharMatcher.javaDigit().replaceFrom(string, "*"); // star out all digits
String lowerAndDigit = CharMatcher.javaDigit().or(CharMatcher.javaLowerCase()).retainFrom(string);
  // eliminate all characters that aren't digits or lowercase

注意：CharMatcher只处理char值；他无法理解从0x10000 到 0x10FFFF的增补 Unicode 代码点。此类逻辑字符会通过替换对（surrogate pairs） 编码为String，并且CharMatcher把这种替换对视为是两个分立的字符。

获取 CharMatchers

CharMatcher提供的工厂方法能够满足非常多的需求：

其他获取一个CharMatcher的通用方法包括：

Method Description
anyOf(CharSequence) 指定你想要匹配的所有字符。例如，CharMatcher.anyOf("aeiou")能匹配所有英文小写元音字符。
is(char) 指定需要匹配的单个字符。
inRange(char, char) 指定一个字符匹配范围，例如，CharMatcher.inRange('a', 'z')。

此外，CharMatcher 拥有 negate()， and(CharMatcher)，和 or(CharMatcher)。他们提供了基于CharMatcher的简单布尔操作。

使用 CharMatchers

CharMatcher提供了大量的方法来操作任何CharSequence中出现的字符。我们列出了最常用的方法，但实际上还有很多方法我们未列出：

Method Description
collapseFrom(CharSequence, char) 将一组连续匹配到的字符替换为指定的字符。例如，WHITESPACE.collapseFrom(string, ' ')把多个空格符折叠为单个空格符。
matchesAllOf(CharSequence) 判断序列中的字符是否全部能被匹配到。例如，ASCII.matchesAllOf(string)可以检查是否所有的字符都在 ASCII 字符集内。
removeFrom(CharSequence) 从序列中移除匹配到的字符。
retainFrom(CharSequence) 从序列中移除所有未被匹配到的字符。
trimFrom(CharSequence) 移除首尾匹配到的字符。
replaceFrom(CharSequence, CharSequence) 用给定的序列替换匹配到的字符。

（注意：以上所有方法都返回一个String，除了matchesAllOf，他会返回一个boolean。）

Charsets

别这么干：

1
2
3
4
5
6
try {
  bytes = string.getBytes("UTF-8");
} catch (UnsupportedEncodingException e) {
  // how can this possibly happen?
  throw new AssertionError(e);
}

应该这么干：

1
bytes = string.getBytes(Charsets.UTF_8);

Charsets 提供了对标准的六种Charset实现的常量引用，所有 java 平台都保证支持这六种实现。使用这些常量引用而不是他们的名字。

TODO: an explanation of charsets and when to use them（注：似乎是作者给自己留的一个坑）

(注意：如果你已经使用了 JDK7，那么可以直接使用 StandardCharsets 中定义的常量）

CaseFormat

CaseFormat 是一个趁手的小工具类，他能方便的在不同的 ASCII 大小写习惯（例如，编程语言的命名习惯） 之间进行转换 。支持的格式包括：

Format Example
LOWER_CAMEL lowerCamel
LOWER_HYPHEN lower-hyphen
LOWER_UNDERSCORE lower_underscore
UPPER_CAMEL UpperCamel
UPPER_UNDERSCORE UPPER_UNDERSCORE

使用方法相当直接：

1
CaseFormat.UPPER_UNDERSCORE.to(CaseFormat.LOWER_CAMEL, "CONSTANT_NAME")); // returns "constantName"

我们发现这非常好用，比如在编写某种能够生成其他程序的程序时。

Strings

类中包含了一定数量的通用String工具。