Author:赵志乾
Date:2019-11-09
Declaration:All Right Reserved!!!
踩坑:
场景:项目中经常会封装一些工具类,方便通用流程的处理。
做法:封装工具类时,注意事项标注不全或命名不规范。使用工具类时,未充分了解工具类方法的特性。曾经踩过这样一个坑,使用工具类方法获取给定时间戳对应当日的凌晨0点时间戳。代码如下:
public static Timestamp getBeginOfCurrentDay(Timestamp currentTimestamp){
currentTimestamp.setHours(0);
currentTimestamp.setMinutes(0);
currentTimestamp.setSeconds(0);
currentTimestamp.setNanos(0);
return new Timestamp(currentTimestamp.getTime());
}
使用该工具类方法时,没有看源码实现。直接按方法名的语义理解方法的特性,导致入参时间戳被篡改成凌晨0点。使得后续用到入参时间戳的流程都是脏数据。
解决方案:
该问题产生的原因有两个:其一是工具类作者对方法名命名的不规范,其二是工具类使用者未充分了解方法的特性。对应的解决措施或者说建议有以下两条:
1、对工具类的方法名命名尽量体现出其特性,例如:get开头的方法中就不要有修改操作。对于比较长或比较复杂的方法要在方法上给出详细的注释,如注意事项、核心的处理流程。
2、使用工具类方法前一定要阅读方法的注释,了解方法的特性。对于没有注释的方法,要通过阅读代码的方式了解方法的特性,切记不可按自己的猜测来使用工具类中的方法。