commons-lang开源API简介[转]

1
    

跟java.lang这个包的作用类似，Commons Lang这一组API也是提供一些基础的、通用的操作和处理，如自动生成toString()的结果、自动实现hashCode()和equals()方法、数组操作、枚举、日期和时间的处理等等。

 

这一组API的所有包名都以org.apache.commons.lang开头，共有如下8个包：

org.apache.commons.lang

org.apache.commons.lang.builder

org.apache.commons.lang.enum

org.apache.commons.lang.enums

org.apache.commons.lang.exception

org.apache.commons.lang.math

org.apache.commons.lang.mutable

org.apache.commons.lang.time

其中的lang.enum已不建议使用，替代它的是紧随其后的lang.enums包。 lang包主要是一些可以高度重用的Util类；lang.builder包包含了一组用于产生每个Java类中都常使用到的toString()、 hashCode()、equals()、compareTo()等等方法的构造器；lang.enums包顾名思义用于处理枚 举；lang.exception包用于处理Java标准API中的exception，为1.4之前版本提供Nested Exception功能；lang.math包用于处理数字；lang.mutable用于包装值型变量；lang.time包提供处理日期和时间的功 能。

由于Commons的包和类实在很多，不可能一个一个讲了，在接下来的专题文章中我就只分别过一下lang、lang.builder、lang.math和lang.time这几个包和常见的用法，其他的我们可以在用到时临时参考一下Javadoc。位置就在安装路径的

…\commons-lang-2.1\docs\api\index.html

我们首先来看org.apache.commons.lang包，这个包提供了一些有用的包含static方法的Util类。除了6个Exception类和2个已经deprecated的数字类之外，commons.lang包共包含了17个实用的类：

ArrayUtils – 用于对数组的操作，如添加、查找、删除、子数组、倒序、元素类型转换等；

BitField – 用于操作位元，提供了一些方便而安全的方法；

BooleanUtils – 用于操作和转换boolean或者Boolean及相应的数组；

CharEncoding – 包含了Java环境支持的字符编码，提供是否支持某种编码的判断；

CharRange – 用于设定字符范围并做相应检查；

CharSet – 用于设定一组字符作为范围并做相应检查；

CharSetUtils – 用于操作CharSet；

CharUtils – 用于操作char值和Character对象；

ClassUtils – 用于对Java类的操作，不使用反射；

ObjectUtils – 用于操作Java对象，提供null安全的访问和其他一些功能；

RandomStringUtils – 用于生成随机的字符串；

SerializationUtils – 用于处理对象序列化，提供比一般Java序列化更高级的处理能力；

StringEscapeUtils – 用于正确处理转义字符，产生正确的Java、JavaScript、HTML、XML和SQL代码；

StringUtils – 处理String的核心类，提供了相当多的功能；

SystemUtils – 在java.lang.System基础上提供更方便的访问，如用户路径、Java版本、时区、操作系统等判断；

Validate – 提供验证的操作，有点类似assert断言；

WordUtils – 用于处理单词大小写、换行等。

下面讲下最常用的两个类

ArrayUtils

数组是我们经常需要使用到的一种数据结构，但是由于Java本身并没有提供很好的API支持，使得很多操作实际上做起来相当繁琐，以至于我们实际编 码中甚至会不惜牺牲性能去使用Collections API，用Collection当然能够很方便的解决我们的问题，但是我们一定要以性能为代价吗？ArrayUtils帮我们解决了处理类似情况的大部分 问题。来看一个例子：

view plaincopy to clipboardprint?
package sean.study.jakarta.commons.lang;  
 
   
 
import java.util.Map;  
 
import org.apache.commons.lang.ArrayUtils;  
 
   
 
public class ArrayUtilsUsage {  
 
   
 
    public static void main(String[] args) {  
 
   
 
        // data setup  
 
        int[] intArray1 = { 2, 4, 8, 16 };  
 
        int[][] intArray2 = { { 1, 2 }, { 2, 4 }, { 3, 8 }, { 4, 16 } };  
 
        Object[][] notAMap = {   
 
                { "A", new Double(100) },  
 
                { "B", new Double(80) },   
 
                { "C", new Double(60) },  
 
                { "D", new Double(40) },   
 
                { "E", new Double(20) }   
 
        };  
 
   
 
        // printing arrays  
 
        System.out.println("intArray1: " + ArrayUtils.toString(intArray1));  
 
        System.out.println("intArray2: " + ArrayUtils.toString(intArray2));  
 
        System.out.println("notAMap: " + ArrayUtils.toString(notAMap));  
 
   
 
        // finding items  
 
        System.out.println("intArray1 contains '8'? "
 
                + ArrayUtils.contains(intArray1, 8));  
 
        System.out.println("intArray1 index of '8'? "
 
                + ArrayUtils.indexOf(intArray1, 8));  
 
        System.out.println("intArray1 last index of '8'? "
 
                + ArrayUtils.lastIndexOf(intArray1, 8));  
 
   
 
        // cloning and resversing  
 
        int[] intArray3 = ArrayUtils.clone(intArray1);  
 
        System.out.println("intArray3: " + ArrayUtils.toString(intArray3));  
 
        ArrayUtils.reverse(intArray3);  
 
        System.out.println("intArray3 reversed: "
 
                + ArrayUtils.toString(intArray3));  
 
   
 
        // primitive to Object array  
 
        Integer[] integerArray1 = ArrayUtils.toObject(intArray1);  
 
        System.out.println("integerArray1: "
 
                + ArrayUtils.toString(integerArray1));  
 
   
 
        // build Map from two dimensional array  
 
        Map map = ArrayUtils.toMap(notAMap);  
 
        Double res = (Double) map.get("C");  
 
        System.out.println("get 'C' from map: " + res);  
 
   
 
    }  
 
   
 
}  
 
   
 
以下是运行结果：  
 
   
 
intArray1: {2,4,8,16}  
 
intArray2: {{1,2},{2,4},{3,8},{4,16}}  
 
notAMap: {{A,100.0},{B,80.0},{C,60.0},{D,40.0},{E,20.0}}  
 
intArray1 contains '8'? true
 
intArray1 index of '8'? 2
 
intArray1 last index of '8'? 2
 
intArray3: {2,4,8,16}  
 
intArray3 reversed: {16,8,4,2}  
 
integerArray1: {2,4,8,16}  
 
get 'C' from map: 60.0
package sean.study.jakarta.commons.lang;

import java.util.Map;

import org.apache.commons.lang.ArrayUtils;

public class ArrayUtilsUsage {

    public static void main(String[] args) {

        // data setup

        int[] intArray1 = { 2, 4, 8, 16 };

        int[][] intArray2 = { { 1, 2 }, { 2, 4 }, { 3, 8 }, { 4, 16 } };

        Object[][] notAMap = {

                { "A", new Double(100) },

                { "B", new Double(80) },

                { "C", new Double(60) },

                { "D", new Double(40) },

                { "E", new Double(20) }

        };

        // printing arrays

        System.out.println("intArray1: " + ArrayUtils.toString(intArray1));

        System.out.println("intArray2: " + ArrayUtils.toString(intArray2));

        System.out.println("notAMap: " + ArrayUtils.toString(notAMap));

        // finding items

        System.out.println("intArray1 contains '8'? "

                + ArrayUtils.contains(intArray1, 8));

        System.out.println("intArray1 index of '8'? "

                + ArrayUtils.indexOf(intArray1, 8));

        System.out.println("intArray1 last index of '8'? "

                + ArrayUtils.lastIndexOf(intArray1, 8));

        // cloning and resversing

        int[] intArray3 = ArrayUtils.clone(intArray1);

        System.out.println("intArray3: " + ArrayUtils.toString(intArray3));

        ArrayUtils.reverse(intArray3);

        System.out.println("intArray3 reversed: "

                + ArrayUtils.toString(intArray3));

        // primitive to Object array

        Integer[] integerArray1 = ArrayUtils.toObject(intArray1);

        System.out.println("integerArray1: "

                + ArrayUtils.toString(integerArray1));

        // build Map from two dimensional array

        Map map = ArrayUtils.toMap(notAMap);

        Double res = (Double) map.get("C");

        System.out.println("get 'C' from map: " + res);

    }

}

以下是运行结果：

intArray1: {2,4,8,16}

intArray2: {{1,2},{2,4},{3,8},{4,16}}

notAMap: {{A,100.0},{B,80.0},{C,60.0},{D,40.0},{E,20.0}}

intArray1 contains '8'? true

intArray1 index of '8'? 2

intArray1 last index of '8'? 2

intArray3: {2,4,8,16}

intArray3 reversed: {16,8,4,2}

integerArray1: {2,4,8,16}

get 'C' from map: 60.0

这段代码说明了我们可以如何方便的利用ArrayUtils类帮我们完成数组的打印、查找、克隆、倒序、以及值型/对象数组之间的转换等操作。

StringUtils

处理文本对Java应用来说应该算是家常便饭了，在1.4出现之前，Java自身提供的API非常有限，如String、 StringTokenizer、StringBuffer，操作也比较单一。无非就是查找substring、分解、合并等等。到1.4的出现可以说 Java的文字处理上了一个台阶，因为它支持regular expression了。这可是个重量级而方便的东东啊，缺点是太复杂，学习起来有一定难度。相较而言，Jakarta Commons提供的StringUtils和WordUtils至今还维持着那种简洁而强大的美，使用起来也很顺手。来看一个例子：

view plaincopy to clipboardprint?
package sean.study.jakarta.commons.lang;  
 
   
 
import org.apache.commons.lang.StringUtils;  
 
   
 
public class StringUtilsAndWordUtilsUsage {  
 
   
 
    public static void main(String[] args) {  
 
          
 
        // data setup  
 
        String str1 = "";  
 
        String str2 = " ";  
 
        String str3 = "\t";  
 
        String str4 = null;  
 
        String str5 = "123";  
 
        String str6 = "ABCDEFG";  
 
        String str7 = "It feels good to use Jakarta Commons.\r\n";  
 
          
 
        // check for empty strings  
 
        System.out.println("==============================");  
 
        System.out.println("Is str1 blank? " + StringUtils.isBlank(str1));  
 
        System.out.println("Is str2 blank? " + StringUtils.isBlank(str2));  
 
        System.out.println("Is str3 blank? " + StringUtils.isBlank(str3));  
 
        System.out.println("Is str4 blank? " + StringUtils.isBlank(str4));  
 
          
 
        // check for numerics  
 
        System.out.println("==============================");  
 
        System.out.println("Is str5 numeric? " + StringUtils.isNumeric(str5));  
 
        System.out.println("Is str6 numeric? " + StringUtils.isNumeric(str6));  
 
          
 
        // reverse strings / whole words  
 
        System.out.println("==============================");  
 
        System.out.println("str6: " + str6);  
 
        System.out.println("str6 reversed: " + StringUtils.reverse(str6));  
 
        System.out.println("str7: " + str7);  
 
        String str8 = StringUtils.chomp(str7);  
 
        str8 = StringUtils.reverseDelimited(str8, ' ');  
 
        System.out.println("str7 reversed whole words : \r\n" + str8);  
 
          
 
        // build header (useful to print log messages that are easy to locate)  
 
        System.out.println("==============================");  
 
        System.out.println("print header:");  
 
        String padding = StringUtils.repeat("=", 50);  
 
        String msg = StringUtils.center(" Customised Header ", 50, "%");  
 
        Object[] raw = new Object[]{padding, msg, padding};  
 
        String header = StringUtils.join(raw, "\r\n");  
 
        System.out.println(header);  
 
   
 
    }  
 
}  
 
   
 
输出的结果如下：  
 
   
 
==============================  
 
Is str1 blank? true
 
Is str2 blank? true
 
Is str3 blank? true
 
Is str4 blank? true
 
==============================  
 
Is str5 numeric? true
 
Is str6 numeric? false
 
==============================  
 
str6: ABCDEFG  
 
str6 reversed: GFEDCBA  
 
str7: It feels good to use Jakarta Commons.  
 
   
 
str7 reversed whole words :   
 
Commons. Jakarta use to good feels It  
 
==============================  
 
print header:  
 
==================================================  
 
%%%%%%%%%%%%%%% Customised Header %%%%%%%%%%%%%%%%  
 
==================================================
package sean.study.jakarta.commons.lang;

import org.apache.commons.lang.StringUtils;

public class StringUtilsAndWordUtilsUsage {

    public static void main(String[] args) {

       

        // data setup

        String str1 = "";

        String str2 = " ";

        String str3 = "\t";

        String str4 = null;

        String str5 = "123";

        String str6 = "ABCDEFG";

        String str7 = "It feels good to use Jakarta Commons.\r\n";

       

        // check for empty strings

        System.out.println("==============================");

        System.out.println("Is str1 blank? " + StringUtils.isBlank(str1));

        System.out.println("Is str2 blank? " + StringUtils.isBlank(str2));

        System.out.println("Is str3 blank? " + StringUtils.isBlank(str3));

        System.out.println("Is str4 blank? " + StringUtils.isBlank(str4));

       

        // check for numerics

        System.out.println("==============================");

        System.out.println("Is str5 numeric? " + StringUtils.isNumeric(str5));

        System.out.println("Is str6 numeric? " + StringUtils.isNumeric(str6));

       

        // reverse strings / whole words

        System.out.println("==============================");

        System.out.println("str6: " + str6);

        System.out.println("str6 reversed: " + StringUtils.reverse(str6));

        System.out.println("str7: " + str7);

        String str8 = StringUtils.chomp(str7);

        str8 = StringUtils.reverseDelimited(str8, ' ');

        System.out.println("str7 reversed whole words : \r\n" + str8);

       

        // build header (useful to print log messages that are easy to locate)

        System.out.println("==============================");

        System.out.println("print header:");

        String padding = StringUtils.repeat("=", 50);

        String msg = StringUtils.center(" Customised Header ", 50, "%");

        Object[] raw = new Object[]{padding, msg, padding};

        String header = StringUtils.join(raw, "\r\n");

        System.out.println(header);

    }

}

输出的结果如下：

==============================

Is str1 blank? true

Is str2 blank? true

Is str3 blank? true

Is str4 blank? true

==============================

Is str5 numeric? true

Is str6 numeric? false

==============================

str6: ABCDEFG

str6 reversed: GFEDCBA

str7: It feels good to use Jakarta Commons.

str7 reversed whole words :

Commons. Jakarta use to good feels It

==============================

print header:

==================================================

%%%%%%%%%%%%%%% Customised Header %%%%%%%%%%%%%%%%

==================================================

从代码中我们可以大致了解到这个StringUtils类简单而强大的处理能力，从检查空串（对null的情况处理很得体），到分割子串，到生成格式化的字符串，使用都很简洁，也很直截了当