Java学习笔记 -- Java定时调度工具Timer类

1 关于 (时间宝贵的小姐姐请跳过)

本教程是基于Java定时任务调度工具详解之Timer篇的学习笔记。

  • 什么是定时任务调度
    基于给定的时间点给定的时间间隔或者给定的执行次数自动执行的任务。
  • 在Java中的定时调度工具
    • Timer
    • Quartz
  • 两者主要区别
    1. 出身上,Timer是Java提供的原生Scheduler(任务调度)工具类,不需要导入其他jar包;而Quartz是OpenSymphony开源组织在任务调度领域的一个开源项目,完全基于Java实现。
    2. 功能上,如需要实现在某个具体时间执行什么任务的话,Timer足以胜任;如需要实现每个星期六8点闹钟提醒之类的复杂任务,就需要用Quartz。因此,Quartz在时间控制上的功能远比Timer强大和完善。

    3. 底层上,Timer使用一个后台线程去执行定时任务,Quartz拥有后台线程执行池(类比JDBC连接池),能够使用多个执行线程去执行定时任务。

简而言之,Quartz > Timer,Timer是被动地根据既定时间去调度任务的,Quartz则是自己主动定制时间规则去支持更加丰富地调度方法。
本文主要是讲解Timer工具类的,故而下文中不会过多讨论Quartz。

  • 前导知识
Timer, Quartz的使用 Quartz, Spring的整合
Java编程知识 Spring基础知识

2 Timer简介和配套视频课程

Timer类位于java.util包下,有关Timer类的详细描述信息请点击这里访问Oracle Java的官方api文档查阅。

Timer工具类图是Timer工具类及有关类的类图。
Java学习笔记 -- Java定时调度工具Timer类

快速开始:

/*
 * Foo.java -- JDK 1.8
 */

package timer;

import java.util.Timer;
import java.util.TimerTask;

/**
 * Description:
 * <p>
 * <p>
 * @author ascribed
 * @date 2019-04-03 Wed PM 19:15:08
 */

public class Foo {  
    public static void main(String[] args) {
        Timer timer = new Timer(); // 1. 创建Timer实例,关联线程不能是daemon(守护/后台)线程
        FooTimerTask fooTimerTask = new FooTimerTask(); // 2. 创建任务对象
        timer.schedule(fooTimerTask, 3000L, 2000L); // 3. 通过Timer定时定频率调用fooTimerTask的业务代码
    }
}

class FooTimerTask extends TimerTask {
    @Override
    public void run() {
        // TODO 业务代码......
        System.out.println("Hello Timer!");
    }
}

3 Timer函数和综合运用

3.1 Timer定时函数的用法

注意:Timer类在时间granularity(粒度)是毫秒级的,实际上Timer的schedule系列方法获取时间的方式是System.currentTimeMillis()(当前时间与Unix元年之差,类型为long),最多只能到毫秒级,而一些操作系统的计时精度会达到1/10毫秒。

3.1.1 schedule()方法的4种用法

  1. schedule(TimerTask task, Date time)
    作用
    在时间等于或超过time的时候执行且仅执行一次task (单次)。
    源码
    public void schedule(TimerTask task, Date time) {
        sched(task, time.getTime(), 0);
    }
  1. schedule(TimerTask task, Date firstTime, long period)
    作用
    时间等于或超过firstTime时首次执行task,之后每隔peroid毫秒重复执行一次task (多次)。
    源码
    public void schedule(TimerTask task, long delay, long period) {
        if (delay < 0)
            throw new IllegalArgumentException("Negative delay.");
        if (period <= 0)
            throw new IllegalArgumentException("Non-positive period.");
        sched(task, System.currentTimeMillis()+delay, -period);
    }
  1. schedule(TimerTask task, long delay)
    作用
    等待delay毫秒后执行且仅执行一次task (单次)。
    源码
    public void schedule(TimerTask task, long delay) {
        if (delay < 0)
            throw new IllegalArgumentException("Negative delay.");
        sched(task, System.currentTimeMillis()+delay, 0);
    }
  1. schedule(TimerTask task, long delay, long period)
    作用
    等待delay毫秒后首次执行task, 之后每个period毫秒重复执行一次task (多次)。
    源码
    public void scheduleAtFixedRate(TimerTask task, long delay, long period) {
        if (delay < 0)
            throw new IllegalArgumentException("Negative delay.");
        if (period <= 0)
            throw new IllegalArgumentException("Non-positive period.");
        sched(task, System.currentTimeMillis()+delay, period);
    }

3.1.2 scheduleAfixRate()的2种用法

  1. scheduleAtFixedRate(TimerTask task, Date firstTime, long period)
    作用
    时间等于或超过time时首次执行task,之后每隔peroid毫秒重复执行一次task (多次, 同schedule第2种用法)。
    源码
    public void scheduleAtFixedRate(TimerTask task, long delay, long period) {
        if (delay < 0)
            throw new IllegalArgumentException("Negative delay.");
        if (period <= 0)
            throw new IllegalArgumentException("Non-positive period.");
        sched(task, System.currentTimeMillis()+delay, period);
    }
  1. scheduleAtFixedRate(TimerTask task, long delay, long period)
    作用
    等待delay毫秒后首次执行task, 之后每个period毫秒重复执行一次task (多次, 同schedule第4种用法)。
    源码
    public void scheduleAtFixedRate(TimerTask task, Date firstTime, long period) {
        if (period <= 0)
            throw new IllegalArgumentException("Non-positive period.");
        sched(task, firstTime.getTime(), period);
    }

笔记:

  1. schedule()和scheduleAtFixedRate()方法都能实现对任务的一次或多次调度。
  2. schedule()按是否可重复执行分为单次和多次,按任务初次执行计算方式分为delay(long型延迟毫秒数)和time(Date型时间)。
  3. schedule()和scheduleAtFixedRate()最终都是调用Timer类下的sched()方法实现的。
    演示代码包含DemoTimer.java和TimerUtils.java,代码清单:
/*
 * DemoTimer.java -- JDK 1.8
 */

package timer;

import java.util.Calendar;
import java.util.Timer;
import java.util.TimerTask;

/**
 * Description:
 * <p>
 * <p>
 * @author ascribed
 * @date 2019-04-03 Wed PM 18:37:03
 */

public class DemoTimer {
    public static void main(String[] args) {
        Calendar calendar = TimerUtils.current();
        TimerUtils.miscellaneous("Current time is : ", calendar.getTime());
        calendar.add(Calendar.SECOND, 3); // 当前时间加3秒

        Timer timer = new Timer(); 
        DemoTimerTask demoTimerTask = new DemoTimerTask("No. 1"); 
        
        demoTimerTask.setName("schedule1"); 
        timer.schedule(demoTimerTask, calendar.getTime()); // 3.1.1.1
        
//        demoTimerTask.setName("schedule2");
//        timer.schedule(demoTimerTask, calendar.getTime(), 2000); // 3.1.1.2
//        
//        demoTimerTask.setName("schedule3");
//        timer.schedule(demoTimerTask, 3000); // 3.1.1.3
//        
//        demoTimerTask.setName("schedule4");
//        timer.schedule(demoTimerTask, 3000, 2000); // 3.1.1.4
//        
//        demoTimerTask.setName("scheduleAtFixedRate1");
//        timer.scheduleAtFixedRate(demoTimerTask, calendar.getTime(), 2000); // 3.1.2.1
//        
//        demoTimerTask.setName("scheduleAtFixedRate2"); 
//        timer.scheduleAtFixedRate(demoTimerTask, 3000, 2000); // 3.1.2.2
    }
}

class DemoTimerTask extends TimerTask {

    String name; // 任务名

    public DemoTimerTask(String name) {
        this.name = name;
    }

    @Override
    public void run() {
        TimerUtils.miscellaneous("Current time is : ", TimerUtils.current().getTime());
        System.out.println("Current exec name is : " + name); // 打印当前name的内容
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

/*
 * TimerUtils.java -- JDK 1.8
 */

package timer;

import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Date;
import java.util.TimerTask;

/**
 * Description:
 * <p>
 * <p>
 * @author ascribed
 * @date 2019-04-03 Wed PM 18:40:26
 */

public class TimerUtils {
    final static SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss"); // 定义日期格式
    static Calendar current() {
        Calendar calendar = Calendar.getInstance(); // 通过静态工厂方法创建Calendar实例
        return calendar;
    }
    static void schedtime(TimerTask task) {
        System.out.println("scheduled time is " + sdf.format(task.scheduledExecutionTime()));
    }
    
    static void miscellaneous(String str, Date date) {
        System.out.println(str + sdf.format(date));
    }
}

3.2 其他重要函数

3.2.1 TimerTask的cancel(), scheduledExecutionTime()

  1. cancel()
    作用
    终止此计时器,丢弃所有当前已安排(scheduled)的任务。
    说明
    通过查看源码,TimerTask的实现机制是通过设置标志位来记录timer task的状态,调用cancel()方法的timer task实例并没有从相应TaskQueue队列移除,这是和Timer类的cancel()方法不同之处。
    源码
    public boolean cancel() {
        synchronized(lock) {
            boolean result = (state == SCHEDULED);
            state = CANCELLED;
            return result;
        }
    }
    
  1. scheduledExecutionTime()
    作用
    从此计时器的任务队列中移除所有已取消(canceled)的任务。
    返回值
    从队列中移除的任务数。
    源码
    public long scheduledExecutionTime() {
        synchronized(lock) {
            return (period < 0 ? nextExecutionTime + period
                               : nextExecutionTime - period);
        }
    }

演示代码清单:

/*
 * CancelTest.java -- JDK 1.8
 */

package timer;

import java.util.Timer;
import java.util.TimerTask;

/**
 * Description:
 * <p>
 * <p>
 * @author ascribed
 * @date 2019-04-03 Wed PM 19:43:04
 */

public class CancelTest {
    public static void main(String[] args) {
        Timer timer = new Timer();
        MyTimerTask myTimerTask = new MyTimerTask("schedule");
        TimerUtils.miscellaneous("Current time is : ", TimerUtils.current().getTime());
        timer.schedule(myTimerTask, 3000, 2000); // 3.2.1
//        timer.schedule(myTimerTask, 3000); // 3.3.2
//        TimerUtils.schedtime(myTimerTask);
    }
}
class MyTimerTask extends TimerTask {
    private String name;
    private Integer count = 0;
    
    public MyTimerTask(String name) {
        this.name = name;
    }

    @Override
    public void run() {
        if (count < 3) {
            TimerUtils.miscellaneous("Current time is : ", TimerUtils.current().getTime());
            System.out.println("Current exec name is : " + name);
            count++;
        } else {
            cancel();
            System.out.println("Task canceled");
            System.exit(0);
        }
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

3.2.2 Timer的cancel(), purge()

  1. cancel()
    作用
    终止此计时器,丢弃所有当前已安排的任务。
    源码
    public void cancel() {
        synchronized(queue) {
            thread.newTasksMayBeScheduled = false;
            queue.clear();
            queue.notify();  // 防止队列已为空的处理
        }
    }
  1. purge()
    作用
    purge,意为净化;(将不需要的东西)从......清除,相比消灭显得优雅一些。从此计时器的任务队列中移除所有已取消的任务。
    返回值
    从队列中移除的任务数。
    源码
     public int purge() {
         int result = 0;

         synchronized(queue) {
             for (int i = queue.size(); i > 0; i--) {
                 if (queue.get(i).state == TimerTask.CANCELLED) {
                     queue.quickRemove(i);
                     result++;
                 }
             }

             if (result != 0)
                 queue.heapify();
         }

         return result;
     }
}

演示代碼:

/*
 * CancelTest.java -- JDK 1.8
 */

package timer;

import java.util.Date;
import java.util.Timer;
import java.util.TimerTask;

/**
 * Description:
 * <p>
 * <p>
 * @author ascribed
 * @date 2019-04-03 Wed PM 19:43:04
 */

public class CancelTest {
    public static void main(String[] args) throws InterruptedException {
        Timer timer = new Timer();
        MyTimerTask task1 = new MyTimerTask("task1");
        MyTimerTask task2 = new MyTimerTask("task2");
        TimerUtils.miscellaneous("start time is : ", new Date());
        // task1首次执行是距离现在时间2秒后,之后每隔2秒执行一次
        // task2首次执行是距离现在时间1秒后,之后每隔2秒执行一次
        timer.schedule(task1, 1000, 2000); // 奇数次执行
        timer.schedule(task2, 2000, 2000); // 偶数次执行
//        System.out.println("current canceled task number is : " + timer.purge());
        Thread.sleep(5000); // 当前线程休眠5秒后cancel生效,没有此句立即触发cancel
        TimerUtils.miscellaneous("cancel time is : ", new Date());
        /*3.2.2.1
        下面两句执行完后程序只剩下后台线程,JRE判定当前程序结束
        因为当前程序只有后台线程,所有前台线程结束,后台的工作无前台线程使用就是没有意义的
         */
        timer.cancel(); // 当前线程若检测到timer对队列中的任务进行调度则终止timer并从任务队列移除所有任务
        System.out.println("Tasks all canceled!"); // 若此句输出后看到还有任务运行则停止所有运行的程序,这可能是之前运行的程序未终止
        // 3.2.2.2
//        task1.cancel(); // 当前线程每次检测到timer对task1进行schedule取消task1
//        System.out.println("current canceled task number is : " + timer.purge());
    }
}

class MyTimerTask extends TimerTask {
    private String name;
    private Integer count = 0;

    public MyTimerTask(String name) {
        this.name = name;
    }

    @Override
    public void run() {
        if (count < 3) {
            TimerUtils.miscellaneous("Current time is : ", TimerUtils.current()
                    .getTime());
            System.out.println("Current exec name is : " + name);
            count++;
        } else {
            cancel();
            System.out.println("Task canceled");
            System.exit(0);
        }
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }
}

3.3 schedule()和scheduledAtFixedRate()的区别

两种情况看区别

  • 首次计划执行的时间在早于当前的时间
    1. schedule方法的"fixed-delay"
      "fixed-delay",用代码的形式理解就是scheduleAtfixedDelay();如果第一次执行时间被delay了,随后的执行时间按照上一次实际执行完成的时间点进行计算。
    2. scheduleAtFixedRate方法的"fixed-rate"
      "fixed-rate",义如其名;如果第一次执行时间按照上一次开始的时间点进行计算,并且为了赶上进度会多次执行任务,因此TimerTask中的执行体需要考虑同步
  • 任务执行所需的时间超出任务的执行周期间隔
    1. schedule方法
      下一次执行时间相对于上一次实际执行完成的时间点,因此执行时间会不断延后
    2. scheduledAtFixedRate方法
      下一次执行时间相对于上一次开始的时间点,因此执行时间一般不会延后,因此存在并发性

4 Timer的缺陷

天生的两种缺陷

  • 管理并发任务的缺陷
    Timer有且仅有一个线程去执行定时任务,如果存在多个任务,且任务时间过长,会导致执行结果与预期不符。
  • 当任务抛出异常时的缺陷
    如果TimerTask抛出RuntimeException,Timer会停止所有任务的运行。

    Timer的使用禁区

  • 对时效性要求较高的多任务并发作业
  • 对复杂的任务的调度

上一篇:浅析Spring框架中IOC与DI


下一篇:nodejs-爬虫