Apache commons lang3 StringUtils工具类

Apache commons lang3包下的StringUtils工具类中封装了一些字符串操作的方法，非常实用，使用起来也非常方便。最近自己也经常在项目中使用到了里面的一些方法，在这里将常用的方法总结了一下，方便以后查阅，大家有兴趣也可以看一下。

首先需要说明的一点是，StringUtils类在操作字符串时，即使操作的为null值也是安全的，不会报NullPointerException，这一点在后面的例子中再具体说明。因此，在操作字符串时使用StringUtils相比使用原生的String会更加安全。

一、判空

StringUtils中判断字符串是否为空的方法主要有以下几个：

boolean StringUtils.isBlank(String str)
boolean StringUtils.isEmpty(String str)
boolean StringUtils.isNotBlank(String str)
boolean StringUtils.isNotEmpty(String str)
boolean StringUtils.isAnyBlank(CharSequence… css)
boolean StringUtils.isAnyEmpty(CharSequence… css)
boolean StringUtils.isNoneBlank(CharSequence… css)
boolean StringUtils.isNoneEmpty(CharSequence… css)
boolean StringUtils.isWhitespace(CharSequence cs)

很显然上面的方法很多都是是非的关系，isBlank与isNotBlank，isEmpty与isNotEmpty，isAnyBlank与isNoneBlank，isAnyEmpty与isNoneEmpty都是如此。
但是blank与empty以及whitesapce它们之间有何区别呢？看下面的对比就很清楚了：

    StringUtils.isBlank(""); // trueStringUtils.isBlank(" "); // trueStringUtils.isBlank("     "); // trueStringUtils.isBlank("\t"); // trueStringUtils.isBlank("\r"); // trueStringUtils.isBlank("\n"); // trueStringUtils.isBlank(null); // trueStringUtils.isEmpty(""); // trueStringUtils.isEmpty(" "); // falseStringUtils.isEmpty("     "); // falseStringUtils.isEmpty("\t"); // falseStringUtils.isEmpty("\r"); // falseStringUtils.isEmpty("\n"); // falseStringUtils.isEmpty(null); // trueStringUtils.isWhitespace(""); // trueStringUtils.isWhitespace(" "); // trueStringUtils.isWhitespace("    "); // trueStringUtils.isWhitespace("\t"); // trueStringUtils.isWhitespace("\r"); // trueStringUtils.isWhitespace("\n"); // trueStringUtils.isWhitespace(null); // false

从上面的结果可以看出，
blank：代表的是空串("")、空白符(空格""，" “，制表符”\t"，回车符"\r"，"\n"等)以及null值；
empty：代表的是空串("")和null值，不包含空白符；
whitespace：包含空串("")和空白符，不包含null值.

isBlank，isNotBlank，isEmpty，isNotEmpty四个方法都是用于判断单个字符串是否为空，这个可以参见上面的几个例子。

isAnyBlank，isNoneBlank，isAnyEmpty，isNoneEmpty四个方法是用于判断多个字符串是否为空；
对于isAnyBlank和isAnyEmpty来说，只要有一个字符串为空，结果即为true；
对于isNoneBlank和isNoneEmpty，只要存在一个字符串为空，结果即为false，具体参见下面的例子：

    StringUtils.isAnyBlank("titanic", "jack", "rose")); // falseStringUtils.isAnyBlank("", "jack", "rose")); // trueStringUtils.isAnyBlank(" ", "jack", "rose")); // trueStringUtils.isAnyBlank(null, "jack", "rose")); // trueStringUtils.isAnyEmpty("titanic", "jack", "rose")); // falseStringUtils.isAnyEmpty("", "jack", "rose")); // trueStringUtils.isAnyEmpty(" ", "jack", "rose")); // falseStringUtils.isAnyEmpty(null, "jack", "rose")); // trueStringUtils.isNoneBlank("titanic", "jack", "rose")); // trueStringUtils.isNoneBlank("", "jack", "rose")); // falseStringUtils.isNoneBlank(" ", "jack", "rose")); // falseStringUtils.isNoneBlank(null, "jack", "rose")); // falseStringUtils.isNoneEmpty("titanic", "jack", "rose")); // trueStringUtils.isNoneEmpty("", "jack", "rose")); // falseStringUtils.isNoneEmpty(" ", "jack", "rose")); // trueStringUtils.isNoneEmpty(null, "jack", "rose")); // false

二、转换

StringUtils中涉及大小写转换以及判断字符串大小写的方法如下：

StringUtils.capitalize(String str)
StringUtils.uncapitalize(String str)
StringUtils.upperCase(String str)
StringUtils.upperCase(String str,Locale locale)
StringUtils.lowerCase(String str)
StringUtils.lowerCase(String str,Locale locale)
StringUtils.swapCase(String str)
StringUtils.isAllUpperCase(CharSequence cs)
StringUtils.isAllLowerCase(CharSequence cs)

字符串首字母大小写转换

    StringUtils.capitalize(null)); // null (注意此处不会报异常)StringUtils.capitalize("china")); // China (首字母转大写)StringUtils.uncapitalize(null)); // null  StringUtils.uncapitalize("CHINA")); // cHINA (首字母转小写)

字符串整体大小写转换

    StringUtils.upperCase(null)); // nullStringUtils.upperCase("china")); // CHINA (全部转为大写)StringUtils.upperCase("china", Locale.ENGLISH)); // CHINA (按照指定规则转换为大写)StringUtils.lowerCase(null)); // nullStringUtils.lowerCase("CHINA")); // china (全部转换为小写)StringUtils.lowerCase("CHINA", Locale.ENGLISH)); // china (按照指定转换规则转换为小写)

字符串大小写互换

    StringUtils.swapCase(null)); // nullStringUtils.swapCase("chINA")); // CHina

判断字符串是否全部是大写或小写(空或空白符均为false)

    StringUtils.isAllUpperCase(null)); // falseStringUtils.isAllUpperCase("")); // falseStringUtils.isAllUpperCase(" ")); // falseStringUtils.isAllUpperCase("CHINA")); // trueStringUtils.isAllLowerCase(null)); // falseStringUtils.isAllLowerCase("")); // falseStringUtils.isAllLowerCase(" ")); // falseStringUtils.isAllLowerCase("china")); // true

三、移除

从字符串中移除匹配的字符或字符序列，如果要移除的字符或字符序列在字符串中不存在，即无匹配，则不进行移除

StringUtils.remove(String str, char remove)
StringUtils.remove(String str, String remove)
StringUtils.removeStart(String str, String remove)
StringUtils.removeStartIgnoreCase(String str, String remove)
StringUtils.removeEnd(String str, String remove)
StringUtils.removeEndIgnoreCase(String str, String remove)
StringUtils.deleteWhitespace(String str)

移除单个字符

    StringUtils.remove(null, 'a')); // null (注意此处及下一行为null)StringUtils.remove('china', null) // china StringUtils.remove("china", 'i')); // chnaStringUtils.remove("china", 'b')); // china (如果要移除的字符不存在，则返回原字符串)

移除指定字符序列

 StringUtils.remove("china", "in")); // chaStringUtils.remove("china", "nin")); // china

移除开头匹配的字符序列

 StringUtils.removeStart("china", "ch")); // inaStringUtils.removeStartIgnoreCase("china", "CHI")); // na (忽略大小写)

移除结尾匹配的字符序列

 StringUtils.removeEnd("china", "na")); // chiStringUtils.removeEndIgnoreCase("china", "NA")); // chi (忽略大小写)

移除空白字符

 StringUtils.deleteWhitespace(null)); //nullStringUtils.deleteWhitespace(" c h  i\tn\ra")); // china

四、替换

StringUtils中常用的替换方法有如下几种

replace(String text, String searchString, String replacement)
replace(String text, String searchString, String replacement, int max)
replaceChars(String str, char searchChar, char replaceChar)
replaceChars(String str, String searchChars, String replaceChars)
replaceOnce(String text, String searchString, String replacement)
overlay(String str,String overlay,int start,int end)
replaceEach(String text, String[] searchList, String[] replacementList)
replaceEachRepeatedly(String text, String[] searchList, String[]replacementList)

需要注意的是，若被替换的字符串为null，或者被替换的字符或字符序列为null，又或者替换的字符或字符序列为null，那么此次替换都会被忽略，返回原字符串。

1）替换单个字符串

replace方法
replace方法可以替换单个字符序列

 StringUtils.replace("china", null, "z")); // china (此处被替换字符序列为null，因此替换会被忽略，返回原字符串)StringUtils.replace("china", "c", null)); // china (此处替换字符序列为null，因此替换也被忽略，返回原字符串)StringUtils.replace("china", "a", "ese")); // chineseStringUtils.replace("china", "a", "")); // chin

replace方法还可以指定最大替换的个数

 StringUtils.replace("aabaaa", "a", "z", 0)); // aabaaa (0表示替换的个数为0，也就是不替换)StringUtils.replace("aabaaa", "a", "z", 1)); // zabaaa (1表示最多替换1个)StringUtils.replace("aabaaa", "a", "z", 2)); // zzbaaa (2表示最多替换2个)StringUtils.replace("aabaaa", "a", "z", 3)); // zzbzaa (3表示最多替换3个)StringUtils.replace("aabaaa", "a", "z", -1)); // zzbzaa (-1表示全部替换)

replaceChars方法
replaceChars方法可以替换单个字符或者单个字符序列

 StringUtils.replaceChars("china", 'a', 'z')); // chinzStringUtils.replaceChars("china", "a", "z")); // chinz

replaceOnce方法
replaceOnce方法只会替换一次，也就是只会替换第一个要替换的字符序列，后面即使有匹配的字符序列也不会被替换

StringUtils.replaceOnce("abaa", "a", "z")); // zbaa

overlay方法
overlay(String str,String overlay,int start,int end)方法可以在指定位置进行字符序列替换，从start索引处开始(包含)到end-1索引处为止进行替换

 StringUtils.overlay("abcdef", "zzzz", 2, 4)); // abzzzzef

这里有一些特殊情况：
起始索引start小于结束索引end，这时会将end作为起始索引，start作为结束索引
```java
StringUtils.overlay("abcdef", "zzzz", 4, 2)); // abzzzzef
StringUtils.overlay("abcdef", "zzzz", 4, 3)); // abczzzzef
StringUtils.overlay("abcdef", "zzzz", 4, 4)); // abcdzzzzef
StringUtils.overlay("abcdef", "zzzz", 4, 5)); // abcdzzzzf
```起始索引start为负数，这时start会被当作0处理
```java
StringUtils.overlay("abcdef", "zzzz", -1, 2)); // abcdzz
StringUtils.overlay("abcdef", "zzzz", -2, -3)); // zzzzabcdef
```结束索引end大于原始字符串的长度，这时end会被当作原始字符串长度处理
```java
StringUtils.overlay("abcdef", "zzzz", 8, 10)); // abcdefzzzz
```

2）同时替换多个字符序列

replaceEach方法
replaceEach(String text, String[] searchList, String[] replacementList)方法可以同时替换多个字符序列，但被替换和替换的字符序列的个数应该对应，否则会报IllegalArgumentException

StringUtils.replaceEach("china", new String[] { "ch", "a" }, new String[] { "x", "z" })); // xhinz (将ch和a分别替换为x和z)
StringUtils.replaceEach("china", null, new String[] { "x", "z" })); // china (存在null，不进行替换)
StringUtils.replaceEach("china", new String[] { "ch", "a" }, new String[] { "x", "z", "y" })); // IllegalArgumentException (被替换和替换的个数不对应)

replaceEachRepeatedly方法
replaceEachRepeatedly(String text, String[] searchList, String[] replacementList)方法可以循环进行替换，具体见下面的例子：

 StringUtils.replaceEachRepeatedly("china", new String[] { "c", "x" }, new String[] { "x", "z" })); // zhina (c被替换为x，x又被替换为z)

但如果替换是一个死循环，则会报IllegalStateException：

StringUtils.replaceEachRepeatedly("china", new String[] { "c", "x" }, new String[] { "x", "c" })); // IllegalStateException (c被替换为x，x又被替换为c)

五、反转

StringUtils中有关反转的方法如下：

reverse(String str)
reverseDelimited(String str, char separatorChar)

简单反转
reverse(String str)方法

StringUtils.reverse("china")); // anihc

根据指定分隔符进行反转，分隔符之间的字符不进行反转

StringUtils.reverseDelimited("china", ',')); // china
StringUtils.reverseDelimited("cxhinxa", 'x')); // axhinxz
StringUtils.reverseDelimited("c.hin.a", '.')); // a.hin.c
StringUtils.reverseDelimited("c.hina", '.')); // hina.c