apache commons StringUtils介绍

jopen 10年前

StringUtils是apache commons lang库（http://commons.apache.org/lang)旗下的一个工具类，提供了很多有用的处理字符串的方法，本文不打算把所有的方法都介绍一遍，我会介绍一些精选的常用的给大家。 

目前StringUtils有两个版本可用，分别是较新的org.apache.commons.lang3.StringUtils和较老的 org.apache.commons.lang.StringUtils，他们有比较大的区别，前者需要JAVA 5，我想这个应该是我们希望使用的。 

1）public static boolean equals(CharSequence str1,CharSequence str2) 

我们就先从最简单的方法equals开始，和你想的一样，他需要两个字符串参数，当相同的时候返回true,否则返回false。 

但是java.lang.String已经有现成的比较完美的equals方法了，为何我们还需要一个第三方的实现呢？ 

这个问题很好，让我们来看看下面这些代码，看看有何问题？ 

Java代码 
</div>
  1. public void doStuffWithString(String stringParam) {    
  2. if(stringParam.equals("MyStringValue")) {    
  3. // do stuff }    
  4. }   
</div> 这个可能有NullPointerException出现，那么有几个办法处理： 
Java代码 
</div>
  1. public void safeDoStuffWithString1(String stringParam) {    
  2. if(stringParam != null &amp;&amp;    
  3. stringParam.equals("MyStringValue")) {    
  4. // do stuff    
  5. }    
  6. }     
  7. public void safeDoStuffWithString2(String stringParm) {    
  8. if("MyStringValue".equals(stringParam))    
  9. {    
  10. // do stuff    
  11. }    
  12. }   
</div> 我本人不喜欢上面的两个方法，第一个看起来太臃肿，第二个看起来像错误的。这里我们就可以用一些StringUtils类了，这个类提供的equals方法是空指针安全的，不用担心传递给他的是什么参数，他不会抛出空指针异常，这样写： 
Java代码 
</div>
  1. public void safeDoStuffWithString3(String stringParam) {   
  2. if(StringUtils.equals(stringParam,"MyStringValue))    
  3. {    
  4. // do stuff    
  5. }    
  6. }   
</div> 这个是我个人的喜好，但是这个确实看起来比较简单易读。前面的两个方法虽然么有什么问题，但是我想StringUtils.equals还是值得考虑的。 

2）isEmpty,isNotEmpty,isBlank,isNotBlank 

和前面一样，这些方法相对于jdk提供的isEmpty方法来说，多了一个“空指针安全”，即不用考虑传递参数的空值问题，让我们来看一个例子： 

Java代码 
</div>
  1. if(myString != null && !myString.isEmpty()) {    
  2. // 有点臃肿是把？   
  3. // Do stuff with myString    
  4. }    
  5.     
  6. if(StringUtils.isNotEmpty(myString)) { // 好多了吧    
  7. // Do stuff with myString    
  8. }   
</div> Blank和empty的区别 

isBlank将在字符串含有空白字符的时候，返回true，例如： 

Java代码 
</div>
  1. String someWhiteSpace = " \t \n";    
  2. StringUtils.isEmpty(someWhiteSpace); // false    
  3. StringUtils.isBlank(someWhiteSpace); // true   
</div> 3）public static String[] split(String str,String separatorChars) 
当然，这个方法相对于String.split也是空指针安全的，当你尝试split一个null字符串的时候，将返回Null，一个Null的分隔符将按照空白字符分隔字符串，但是，还有一个理由让你可考虑使用StringUtils.split（）方法，就是jdk自带的String.split由于支持正则表达式进行分隔，所以可能带来意想不到的后果，例如: 
Java代码 
</div>
  1. public void possiblyNotWhatYouWant() {   
  2. String contrivedExampleString = "one.two.three.four";    
  3. String[] result = contrivedExampleString.split(".");    
  4. System.out.println(result.length); // 0    
  5. }  
</div> 上面很明显你希望按照.分隔，但是jdk理解的“.”是正则表达式的任意字符，导致字符串内任意字符都匹配，返回一个size=0的字符串数组。其实你只要传递"\\."就行了，但是这个确实是一个问题。  
这样，使用StringUtils.split就简单多了，另外，我测试还发现StringUtils.split比jdk自带的split要快四倍。 

4）public static String join(Iterable iterable,String separator） 
这个方法确实很实用，因为jdk自身没有提供，简单使用方法： 
Java代码 
</div>
  1. String[] numbers = {"one", "two", "three"};   
  2. StringUtils.join(numbers,","); // returns "one,two,three"   
</div> 当然你可以传递一个数字或者迭代序列iterators. 

好了，我确信，这个库确实是一个比较实用的库，推荐大家使用。 

API请参考:http://commons.apache.org/lang/api-3.1/org/apache/commons/lang3/StringUtils.html

下面分别对一些常用方法做简要介绍：

1. public static boolean isEmpty(String str) 
   判断某字符串是否为空，为空的标准是 str==null 或 str.length()==0 
   下面是 StringUtils 判断是否为空的示例：

StringUtils.isEmpty(null) = true
StringUtils.isEmpty("") = true 
StringUtils.isEmpty(" ") = false //注意在 StringUtils 中空格作非空处理
StringUtils.isEmpty("   ") = false
StringUtils.isEmpty("bob") = false
StringUtils.isEmpty(" bob ") = false

2. public static boolean isNotEmpty(String str) 
   判断某字符串是否非空，等于 !isEmpty(String str) 
   下面是示例：

      StringUtils.isNotEmpty(null) = false
      StringUtils.isNotEmpty("") = false
      StringUtils.isNotEmpty(" ") = true
      StringUtils.isNotEmpty("         ") = true
      StringUtils.isNotEmpty("bob") = true
      StringUtils.isNotEmpty(" bob ") = true

3. public static boolean isBlank(String str) 
   判断某字符串是否为空或长度为0或由空白符(whitespace) 构成
   下面是示例：
      StringUtils.isBlank(null) = true
      StringUtils.isBlank("") = true
      StringUtils.isBlank(" ") = true
      StringUtils.isBlank("        ") = true
      StringUtils.isBlank("\t \n \f \r") = true   //对于制表符、换行符、换页符和回车符

      StringUtils.isBlank()   //均识为空白符
      StringUtils.isBlank("\b") = false   //"\b"为单词边界符
      StringUtils.isBlank("bob") = false
      StringUtils.isBlank(" bob ") = false

4. public static boolean isNotBlank(String str) 
   判断某字符串是否不为空且长度不为0且不由空白符(whitespace) 构成，等于 !isBlank(String str) 
   下面是示例：

      StringUtils.isNotBlank(null) = false
      StringUtils.isNotBlank("") = false
      StringUtils.isNotBlank(" ") = false
      StringUtils.isNotBlank("         ") = false
      StringUtils.isNotBlank("\t \n \f \r") = false
      StringUtils.isNotBlank("\b") = true
      StringUtils.isNotBlank("bob") = true
      StringUtils.isNotBlank(" bob ") = true

5. public static String trim(String str) 
   去掉字符串两端的控制符(control characters, char <= 32) , 如果输入为 null 则返回null 
   下面是示例：
      StringUtils.trim(null) = null
      StringUtils.trim("") = ""
      StringUtils.trim(" ") = ""
      StringUtils.trim(" \b \t \n \f \r    ") = ""
      StringUtils.trim("     \n\tss   \b") = "ss"
      StringUtils.trim(" d   d dd     ") = "d   d dd"
      StringUtils.trim("dd     ") = "dd"
      StringUtils.trim("     dd       ") = "dd"

6. public static String trimToNull(String str) 
   去掉字符串两端的控制符(control characters, char <= 32) ,如果变为 null 或""，则返回 null 
   下面是示例：
      StringUtils.trimToNull(null) = null
      StringUtils.trimToNull("") = null
      StringUtils.trimToNull(" ") = null
      StringUtils.trimToNull("     \b \t \n \f \r    ") = null
      StringUtils.trimToNull("     \n\tss   \b") = "ss"
      StringUtils.trimToNull(" d   d dd     ") = "d   d dd"
      StringUtils.trimToNull("dd     ") = "dd"
      StringUtils.trimToNull("     dd       ") = "dd"

7. public static String trimToEmpty(String str) 
   去掉字符串两端的控制符(control characters, char <= 32) ,如果变为 null 或 "" ，则返回 "" 
   下面是示例：
      StringUtils.trimToEmpty(null) = ""
      StringUtils.trimToEmpty("") = ""
      StringUtils.trimToEmpty(" ") = ""
      StringUtils.trimToEmpty("     \b \t \n \f \r    ") = ""
      StringUtils.trimToEmpty("     \n\tss   \b") = "ss"
      StringUtils.trimToEmpty(" d   d dd     ") = "d   d dd"
      StringUtils.trimToEmpty("dd     ") = "dd"
      StringUtils.trimToEmpty("     dd       ") = "dd"

8. public static String strip(String str) 
   去掉字符串两端的空白符(whitespace) ，如果输入为 null 则返回 null 
   下面是示例(注意和 trim() 的区别)：
      StringUtils.strip(null) = null
      StringUtils.strip("") = ""
      StringUtils.strip(" ") = ""
      StringUtils.strip("     \b \t \n \f \r    ") = "\b"
      StringUtils.strip("     \n\tss   \b") = "ss   \b"
      StringUtils.strip(" d   d dd     ") = "d   d dd"
      StringUtils.strip("dd     ") = "dd"
      StringUtils.strip("     dd       ") = "dd"

9. public static String stripToNull(String str) 
   去掉字符串两端的空白符(whitespace) ，如果变为 null 或""，则返回 null 
   下面是示例(注意和 trimToNull() 的区别)：
      StringUtils.stripToNull(null) = null
      StringUtils.stripToNull("") = null
      StringUtils.stripToNull(" ") = null
      StringUtils.stripToNull("     \b \t \n \f \r    ") = "\b"
      StringUtils.stripToNull("     \n\tss   \b") = "ss   \b"
      StringUtils.stripToNull(" d   d dd     ") = "d   d dd"
      StringUtils.stripToNull("dd     ") = "dd"
      StringUtils.stripToNull("     dd       ") = "dd"

10. public static String stripToEmpty(String str) 
    去掉字符串两端的空白符(whitespace) ，如果变为 null 或"" ，则返回"" 
    下面是示例(注意和 trimToEmpty() 的区别)：
      StringUtils.stripToNull(null) = ""
      StringUtils.stripToNull("") = ""
      StringUtils.stripToNull(" ") = ""
      StringUtils.stripToNull("     \b \t \n \f \r    ") = "\b"
      StringUtils.stripToNull("     \n\tss   \b") = "ss   \b"
      StringUtils.stripToNull(" d   d dd     ") = "d   d dd"
      StringUtils.stripToNull("dd     ") = "dd"
      StringUtils.stripToNull("     dd       ") = "dd"

以下方法只介绍其功能，不再举例：
11. public static String strip(String str, String stripChars) 
   去掉 str 两端的在 stripChars 中的字符。
   如果 str 为 null 或等于"" ，则返回它本身；
   如果 stripChars 为 null 或"" ，则返回 strip(String str) 。

12. public static String stripStart(String str, String stripChars) 
    和11相似，去掉 str 前端的在 stripChars 中的字符。

13. public static String stripEnd(String str, String stripChars) 
    和11相似，去掉 str 末端的在 stripChars 中的字符。

14. public static String[] stripAll(String[] strs) 
    对字符串数组中的每个字符串进行 strip(String str) ，然后返回。
    如果 strs 为 null 或 strs 长度为0，则返回 strs 本身

15. public static String[] stripAll(String[] strs, String stripChars) 
    对字符串数组中的每个字符串进行 strip(String str, String stripChars) ，然后返回。
    如果 strs 为 null 或 strs 长度为0，则返回 strs 本身

16. public static boolean equals(String str1, String str2) 
    比较两个字符串是否相等，如果两个均为空则也认为相等。

17. public static boolean equalsIgnoreCase(String str1, String str2) 
    比较两个字符串是否相等，不区分大小写，如果两个均为空则也认为相等。

18. public static int indexOf(String str, char searchChar) 
    返回字符 searchChar 在字符串 str 中第一次出现的位置。
    如果 searchChar 没有在 str 中出现则返回-1，
    如果 str 为 null 或 "" ，则也返回-1

19. public static int indexOf(String str, char searchChar, int startPos) 
    返回字符 searchChar 从 startPos 开始在字符串 str 中第一次出现的位置。
    如果从 startPos 开始 searchChar 没有在 str 中出现则返回-1，
    如果 str 为 null 或 "" ，则也返回-1

20. public static int indexOf(String str, String searchStr) 
    返回字符串 searchStr 在字符串 str 中第一次出现的位置。
    如果 str 为 null 或 searchStr 为 null 则返回-1，
    如果 searchStr 为 "" ,且 str 为不为 null ，则返回0，
    如果 searchStr 不在 str 中，则返回-1

21. public static int ordinalIndexOf(String str, String searchStr, int ordinal) 
    返回字符串 searchStr 在字符串 str 中第 ordinal 次出现的位置。
    如果 str=null 或 searchStr=null 或 ordinal<=0 则返回-1
    举例(*代表任意字符串)：
      StringUtils.ordinalIndexOf(null, *, *) = -1
      StringUtils.ordinalIndexOf(*, null, *) = -1
      StringUtils.ordinalIndexOf("", "", *) = 0
      StringUtils.ordinalIndexOf("aabaabaa", "a", 1) = 0
      StringUtils.ordinalIndexOf("aabaabaa", "a", 2) = 1
      StringUtils.ordinalIndexOf("aabaabaa", "b", 1) = 2
      StringUtils.ordinalIndexOf("aabaabaa", "b", 2) = 5
      StringUtils.ordinalIndexOf("aabaabaa", "ab", 1) = 1
      StringUtils.ordinalIndexOf("aabaabaa", "ab", 2) = 4
      StringUtils.ordinalIndexOf("aabaabaa", "bc", 1) = -1
      StringUtils.ordinalIndexOf("aabaabaa", "", 1) = 0
      StringUtils.ordinalIndexOf("aabaabaa", "", 2) = 0

22. public static int indexOf(String str, String searchStr, int startPos) 
    返回字符串 searchStr 从 startPos 开始在字符串 str 中第一次出现的位置。
    举例(*代表任意字符串)：
      StringUtils.indexOf(null, *, *) = -1
      StringUtils.indexOf(*, null, *) = -1
      StringUtils.indexOf("", "", 0) = 0
      StringUtils.indexOf("aabaabaa", "a", 0) = 0
      StringUtils.indexOf("aabaabaa", "b", 0) = 2
      StringUtils.indexOf("aabaabaa", "ab", 0) = 1
      StringUtils.indexOf("aabaabaa", "b", 3) = 5
      StringUtils.indexOf("aabaabaa", "b", 9) = -1
      StringUtils.indexOf("aabaabaa", "b", -1) = 2
      StringUtils.indexOf("aabaabaa", "", 2) = 2
      StringUtils.indexOf("abc", "", 9) = 3

23. public static int lastIndexOf(String str, char searchChar) 
    基本原理同18

24. public static int lastIndexOf(String str, char searchChar, int startPos) 
    基本原理同19

25. public static int lastIndexOf(String str, String searchStr) 
    基本原理同20

26. public static int lastIndexOf(String str, String searchStr, int startPos)

相关经验