java---工具类的设计

工具类:顾名思义是一个工具,作为工具就是给别人使用的,所以原则,提供简单的调用接口,封装复杂的内部结构.

写一个工具类,大体模式如以下代码所示
1.不能被继承
2.不能实例化
3.封装性好
具体也可以参考java提供的Math等工具类

import java.util.Arrays;

//工具类不是为了继承的,多疑定义为final,不可继承
public final class ArrayTool {
    private static int max;//能私有化的都私有封装起来
    private static int min;//能私有化的都私有封装起来
    //工具类一般不需要建立对象.所以直接私有化构造方法
    private ArrayTool(){

    }
    //静态方法的是对外提供的工具
    public static void getMax(int arr[]) {
        max = arr[0];
        for (int  x : arr) {
            if (max < x) {
                max = x;
            }
        }
    }
    //静态方法的是对外提供的工具
    public static int[] sort(int arr[]) {
        Arrays.sort(arr);
        return arr;
    }
}

另外,写好工具类既然是提供给别人的,所以也需要一份易读的说明书,也就是javadoc文件,这个使用很简单,在相应的函数或者类的签名用以下注释来修饰即可

/** javadoc注释
     * 对一个整型数组排序
     * @param arr 需要排序的数组
     * @return 排序好的数组
     */
    public static int[] sort(int arr[]) {
        Arrays.sort(arr);
        return arr;
    }

接下来在eclipse中生成javadoc文件即可

版权声明：本文为博主原创文章，未经博主允许不得转载。