本文源码托管在https://github.com/ASCE1885/asce-common,欢迎fork
最近抽空在做代码的优化工作,或者说小步的重构,我们从著名的《重构》一书中可知,代码的坏味道首当其冲的就是重复代码,当同一个类中不同函数包含重复代码时,应该考虑将重复代码抽取成函数,当不相干的两个类中出现重复代码时,则应该考虑将重复的代码抽取成一个类。这篇文章就来讲讲去除重复代码的一个例子。
在项目开发中,经常会在不同的地方用到定时器Timer,Timer要定时执行的任务是TimerTask,一般我们会在需要用到定时功能的地方直接new出这两个类的实例,使用完了之后再进行释放操作,这样一来,当项目进行到中后期,多个地方使用到类似的定时功能时,我们就会发现在代码Timer的创建和释放代码重复了,不仅增大了代码体积,以后如果要对定时功能统一修改的话(例如替换成另一个更优的实现),需要遍历这所有的地方并逐个修改,相当繁琐且容易出错,这时就是需要进行代码重构的时候了,很明显,需要将定时器功能抽象成一个单独的类,将创建和释放操作放到这个类中进行统一管理,唯一需要定制的功能是TimerTask中执行的处理,我们可以通过回调的方式让调用者自己实现特殊的处理要求。
在我们的例子中,将提取出两个类,TimerProcessor类定义定时执行的函数接口,以抽象类的形式提供,由调用者定制实现,类定义如下:
package com.asce1885;
/**
* 抽象类,定义定时执行的接口函数
* @author ASCE1885
*
*/
public abstract class TimerProcessor {
/**
* 在TimerTask中执行的操作,由调用者定制
*/
public abstract void process();
}
TimerHelper类负责创建和释放定时器资源,包括Timer和TimerTask。类定义如下:
package com.asce1885;
import java.util.Timer;
import java.util.TimerTask;
/**
* 定时器管理类,负责定时器相关对象的创建和释放,提供统一的接口供调用者使用
* @author ASCE1885
*
*/
public class TimerHelper {
private TimerProcessor mProcessor;
private int mDelayMs;
private Timer mTimer;
private TimerTask mTimerTask;
/**
* 构造函数
* @param delayMs 延时
* @param processor 定时处理器,由调用者定制实现
*/
public TimerHelper(int delayMs, TimerProcessor processor) {
mProcessor = processor;
mDelayMs = delayMs;
}
/**
* 启动定时器
*/
public void startTimer() {
mTimer = new Timer(true);
mTimerTask = new TimerTask() {
@Override
public void run() {
if (mProcessor != null) {
mProcessor.process();
}
}
};
mTimer.schedule(mTimerTask, mDelayMs);
}
/**
* 停止定时器
*/
public void stopTimer() {
if (mTimer != null) {
mTimer.cancel();
mTimer = null;
}
if (mTimerTask != null) {
mTimerTask.cancel();
mTimerTask = null;
}
}
}
TimerHelper的使用方法如下所示:
// 实例化TimerHelper对象,并定制业务相关的定时任务
TimerHelper helper = new TimerHelper(1000, new TimerProcessor() {
@Override
public void process() {
// do some stuff
}
});
// 在需要开始定时任务的地方调用
helper.startTimer();
// .....
// 在需要结束定时任务的地方调用
helper.stopTimer();