JAVA定时任务Timer

故事起因

因业务需要，写了一个定时任务Timer，任务将在每天的凌晨2点执行，代码顺利码完，一切就绪，开始测试。运行程序，为了节省时间，将系统时间调整为第二天凌晨1点59分，看着秒针滴答滴答的转动，期盼着到2点时程序能正确运行，正暗暗欣喜之时，时间滑过2点，但是程序没有任何反应，啊哦，难道是我程序写错了。悲剧。 

二次测试

首先检查自己写的程序没有什么问题。再次测试，先将时间调整为1点59分，打上断点，再运行程序，2点到来，程序运行到断点处，一步一步往下走，一切正常。为何，刚刚不是还是不能运行吗。又重复测试了几次，发现一个规律，先调整好时间后再运行程序一切正常，但是先运行程序再调整时间就什么没有任何反应。没办法了，只能研究一下JDK的Timer源码，看看内部有什么玄机。 

了解内幕

我们先看看类的关系，见下图：

图1

其中Task是我自己写的任务类，这个类需要继承TimerTask，并且实现run()抽象方法，需要将任务执行的相关代码写在run方法中。

public class Task extends TimerTask {
    @Override
    public void run() {
        System.out.println("do task...");
    }
}

执行任务的方法如下：

public class TimerManager {
   public TimerManager() {
      ……

      Timer timer = new Timer();
      Task task = new Task();
      // 安排指定的任务在指定的时间开始进行重复的固定延迟执行。
      timer.schedule(task, date, ConfigData.getDeltaTime() * 1000);
   }
}

在执行任务的时候，我们只跟Timer打交道，所以先来了解一下Timer.

Timer的构造函数如下，又调用了自己的另一个构造函数 :

public Timer() {
        this("Timer-" + serialNumber());
}

public Timer(String name) {
        thread.setName(name);
        thread.start();
}

到了这一步，我们需要了解thread是个什么玩意儿，我们来看看他的定义：

private TimerThread thread = new TimerThread(queue);

此时我们需要了解的对象成了TimerThread了，顺藤摸瓜，接着往下看吧： 

class TimerThread extends Thread {
    boolean newTasksMayBeScheduled = true;

    private TaskQueue queue;

    TimerThread(TaskQueue queue) {
        this.queue = queue;
    }

    public void run() {
        try {
            mainLoop();
        } finally {
            // Someone killed this Thread, behave as if Timer cancelled
            synchronized(queue) {
                newTasksMayBeScheduled = false;
                queue.clear();  // Eliminate obsolete references
            }
        }
    }

    /**
     * The main timer loop.  (See class comment.)
     */
    private void mainLoop() {
        while (true) {
            try {
                TimerTask task;
                boolean taskFired;
                synchronized(queue) {
                    // Wait for queue to become non-empty
                    while (queue.isEmpty() && newTasksMayBeScheduled) 
                        queue.wait();
                    if (queue.isEmpty())
                        break; // Queue is empty and will forever remain; die

                    // Queue nonempty; look at first evt and do the right thing
                    long currentTime, executionTime;
                    task = queue.getMin();
                    synchronized(task.lock) {
                        if (task.state == TimerTask.CANCELLED) {
                            queue.removeMin();
                            continue;  // No action required, poll queue again
                        }
                        currentTime = System.currentTimeMillis();
                        executionTime = task.nextExecutionTime;
                        if (taskFired = (executionTime<=currentTime)) {
                            if (task.period == 0) { // Non-repeating, remove
                                queue.removeMin();
                                task.state = TimerTask.EXECUTED;
                            } else { // Repeating task, reschedule
                                queue.rescheduleMin(
                                  task.period<0 ? currentTime   - task.period
                                                : executionTime + task.period);
                            }
                        }
                    }
                    if (!taskFired) // Task hasn't yet fired; wait
                        queue.wait(executionTime - currentTime);
                }
                if (taskFired) // Task fired; run it, holding no locks
                    task.run();
            } catch(InterruptedException e) {
            }
        }
    }
}

我们可以看到TimerThread主要就是mianLoop()方法,在mainLoop方法中有这么两行代码：

while (queue.isEmpty() && newTasksMayBeScheduled) 
    queue.wait();

当我们 new Timer()，然后两次调用Timer()的构造函数，并调用thread.start()时，就到了mainLoop方法的这两行代码了，此时的queue.isEmpty()为true，所以线程就wait在这个地方了。什么时候将他notify呢？我们接着往下看我们自己的代码，new Timer(),new Task()之后就到了下面的这行代码了：

timer.schedule(task, date, ConfigData.getDeltaTime() * 1000);

继续摸索一下timer.schedule()是怎么工作的：

public void schedule(TimerTask task, Date firstTime, long period) {
        if (period <= 0)
            throw new IllegalArgumentException("Non-positive period.");
        sched(task, firstTime.getTime(), -period);
}

     private void sched(TimerTask task, long time, long period) {
        if (time < 0)
            throw new IllegalArgumentException("Illegal execution time.");

        synchronized(queue) {
            if (!thread.newTasksMayBeScheduled)
                throw new IllegalStateException("Timer already cancelled.");

            synchronized(task.lock) {
                if (task.state != TimerTask.VIRGIN)
                    throw new IllegalStateException(
                        "Task already scheduled or cancelled");
                task.nextExecutionTime = time;
                task.period = period;
                task.state = TimerTask.SCHEDULED;
            }

            queue.add(task);
            if (queue.getMin() == task)
                queue.notify();
        }
    }

当我们跟踪到方法sched时可以看到，这方法中设置了任务的下一次执行时间为传入的时间task.nextExecutionTime = time，然后把添加任务到队列中并notify队列。

到了这里我们要回到之前的wait位置了：

while (queue.isEmpty() && newTasksMayBeScheduled) 
    queue.wait();

现在queue.isEmpty()为false了，得继续往下运行，

currentTime = System.currentTimeMillis();
executionTime = task.nextExecutionTime;
if (taskFired = (executionTime<=currentTime))

程序取得当前的时间和任务下一次执行的时间，比较如果执行的时间还未到则任务执行为false，即taskFired=false。

if (!taskFired) // Task hasn't yet fired; wait
    queue.wait(executionTime - currentTime);

所以程序为进入wait状态，要wait多久呢？时间为executionTime – currentTime

而如果当前执行程序的时间在任务执行的时间之后了，则任务执行为true，即taskFired=true。

if (taskFired) // Task fired; run it, holding no locks
    task.run();

任务立即会被执行。

豁然开朗

到这里我们就清楚了为什么之前的测试是那样一个现象，当我们先运行程序再将时间调整为1点59分后，程序一直处于queue.wait(executionTime - currentTime)状态，需要wait的时间为executionTime – currentTime，所以刚过2点时程序是不会马上运行的，必须要等待 executionTime – currentTime的时间后才能执行任务。