一个项目工具类是比不可少的,工具类可以为我们的业务提供最基础的支持,比如日期格式、文件操作、格式的转换等等。
但随着项目的扩展,工具类的维护渐渐的就偏离的初心,容易出现以下几个问题:
问题
- 找不到:工具类太多
- 满足不了:工具类找不到想用的方法
- 工具类可靠性:是否有更加可靠完善的写法
找不到
-
工具类名和支持功能模糊或不匹配
想找一个方法, 但是不确定在哪个类里
比如:想获取手机相关属性,由于应用核心是设备,可能不会首先联想到
DeviceUtils
,那么如果是MobileUtils
或者是PhoneUtils
是不是更容易被联想到 -
方法分类不准确
目标方法在别的类中
比如,想获取当前应用的分辨率,感觉应该在
DisplayUtils
里,结果发现没有,它在哪里?发现在
DeviceUtils
中。DeviceUtils.getDensity()
瓦特? -
方法分类不明确
(由于找不到,重新开发了,不准确的后遗症)
同样的方法出现在多个工具类中,实现方式可能不同
比如:
AppUtils.getVersionCode
和DeviceUtils.getClientVersion
的作用一样的再比如:
DisplayUtils#getStatusBarHeight
DeviceUtils#getStatusBarHeight
-
上面的例子又暴露一个问题,命名不准确,容易混淆功能使用
AppUtils.getVersionCode
一看返回的应该是 int 型的 versionCode
其实DeviceUtils.getClientVersion
返回的也是int,相比之下命名就有点误人子弟了
满足不了
- 找到了对应的工具类,但是不知道有没有需要的方法,不确定方法是不是我需要的
- 提高方法的可读性 -- 提高方法击中率
- 方法注释尽可能表达清楚,有返回值可添加返回示例
- 方法名称和参数名称尽可能贴切
- 如果是自己创建方法,可能会叫什么名字,是否会更加贴切,前期逐步完善,避免后期大面积修改
- 提高方法的可读性 -- 提高方法击中率
要想找得到,先把名起好,名字起得好,不怕找不到,如果找不到,新建个名号,名号怎么搞,让人能找到。
建议
封装(解耦)
- 定义自己的工具类,不要在代码里调用第三方的工具类(封装-解耦)
- 不同的开发者协作时可能会使用不同三方库
- 一旦三方库更换或者更新对业务逻辑可能会产生影响
举例,如果有个三方的类库判断字符的长度,有 StringUtils#getLength() 方法,如果后面要求默认一个中文占两个字符,这个时候再去替换,工作量不言而喻。如果使用我们自己封装的方法, 就可以避免较好避免这个问题(需求变更)。
使用父类 / 接口 (抽象)
举例:
写一个判断 ArrayList 是否为空的函数
public static boolean isEmpty(ArrayList<?> list) {
return list == null || list.size() == 0;
}
这个时候可以考参数能不能使用父类
ArrayList 的继承关系 --> List --> Collection, Collection 也有size()
方法,
可改写成,同时修改下入参参数名
public static boolean isEmpty(Collection<?> col) {
return col == null || col.size() == 0;
}
这样使得方法更加的通用
类似的例子比如 String
作为入参的 可以使用实现的接口CharSquence
,HashMap
可以使用父类Map
处理等。
重载
我们在使用一些工具库或者 API 的时候,会有很多重载函数,在调用的时候会灵活很多。比如 Android 中 Handler#sendMessge
系列方法。
举例:把日期转换成目标格式
/**
* 根据给定的格式与时间(Date类型的),返回时间字符串
*
* @param date 指定的日期
* @param format 日期格式字符串
* @return String 指定格式的日期字符串
*/
public static String getFormatDate(Date date, String format) {
SimpleDateFormat sdf = new SimpleDateFormat(format, Locale.getDefault());
return sdf.format(date);
}
现在需要根据时间戳返回目标格式的字符串
分析:如果把 long 型的时间戳转换成 Date就可以了
/**
* 根据格林尼治时间获取当地年月日时间
*
* @param microsecond 时间戳(秒)
* @param format 日期格式字符串
* @return String 指定格式的日期字符串
*/
public static String getFormatDate(long microsecond, String format) {
return getFormatDate(new Date(microsecond * 1000), format);
}
如果返回的不是 数字类型呢,可能是个时间戳字符串,那么把字符串先转换成 long
/**
* 解析服务器传回的时间戳
*
* @param strSecond
* @param format
* @return
*/
public static String getFormatDate(String strSecond, String format) {
long dateTime = 0;
try {
dateTime = Long.valueOf(strSecond).longValue();
} catch (NumberFormatException e) {
e.printStackTrace();
}
return getFormatDate(dateTime, format);
}
三个方法,其主题只有一份,提供了不同的类型的参数。重载函数使得调用有更多选择性,也会减少重复代码。
工具类中的异常处理
catch or throw
- 如果异常出现的概率很低,可以不抛出去
- 给异常情况增加处理方式
- 如果异常处理情况和业务强相关(不好封装到工具类中)可以抛出去,交给调用方处理
尾声
- 多考虑面向对象思想的特性
- 工具类在参数优化:和类型或者含义相匹配
- 写个工具类的时候多考虑,多考虑可读性和灵活性(重用性)
网友评论