• commons-lang開源API簡介

    1
    Java HTML Apache C/C++ Go 30676 次瀏覽

    跟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的情況處理很得體),到分割子串,到生成格式化的字符串,使用都很簡潔,也很直截了當

    相似問題

    相關經驗

    相關資訊

    相關文檔

  • sesese色