# 定时任务
平台提供了两种定时任务机制:
- 基于Timer的普通单机定时任务
- 基于Quartz的持久化支持集群定时任务
我们支持集群多服务器部署,开发过程中一定要思考定时任务的应用范围!
# Quartz
Quartz是平台基于第三方框架封装的定时任务,此定时任务的特点是:两台服务器集群下,只会有一台服务器执行,即一个OA系统下只有一个节点执行定时任务,以防止任务重复执行。
核心类com.seeyon.ctp.common.quartz.QuartzHolder
# 基本原理
定时任务采用异步处理模式,在生成定时任务的时候需要指定:任务处理器Bean + 参数。 任务处理器Bean是解释执行特定任务的JavaBean,通过参数来描述业务特征。
# 开发案例
定义一个QuartzJob类,实现com.seeyon.ctp.common.quartz.QuartzJob接口
class ABCQuartz implement QuartzJob{
public void execute(Map<String, String> parameters){
Long id = parameters.get("id");
// TODO
}
}
按照插件化开发规范,将QuartzJob注册到Spring容器中spring-xx.xx.xml:
<bean name="abcQuartz" class="package.ABCQuartz" >
# 注册任务
开发QuartzJob之后,需要注册这个Job的执行时间、循环周期、以及每次触发时传递的参数。
// 将如下代码放在希望触发定时任务的地方
Map<String, String> parameters = new HashMap<String, String>();
parameters.put("id", String.valueOf(id));
if(!QuartzHolder.hasQuartzJob("jobName"){
QuartzHolder.newQuartzJob("jobName", new Date(109, 1, 1), "abcQuartz", parameters);
}
# 常用API
QuartzHolder其它接口
/**
* 检测任务是否存在
*
* @param name 任务名称
* @return
*/
public static boolean hasQuartzJob(String name);
/**
* 删除任务
*
* @param name 任务名称
* @return
*/
public static boolean deleteQuartzJob(String name);
/**
* 只运行一次,默认分组
* @param jobName 任务名称,要求每一个任务唯一
* @param runTime 触发运行的时间点
* @param jobBeanId 任务执行类的BeanId, implement QuartzJob接口
* @param parameters
* @return
* @throws MutiQuartzJobNameException
*/
public static boolean newQuartzJob(String jobName, Date runTime,
String jobBeanId, Map<String, String> parameters) throws MutiQuartzJobNameException, NoSuchQuartzJobBeanException {
return newQuartzJob(jobName, runTime, 0, 0, jobBeanId, parameters);
}
/**
* 创建每天的定时任务,时间以beginTime为准
* @param groupName 可以为<code>null</code>
* @param jobName
* @param beginTime
* @param jobBeanId 任务执行类的BeanId, implement QuartzJob接口
* @param parameters
* @return
*/
public static boolean newQuartzJobPerDay(String groupName, String jobName, Date beginTime, String jobBeanId, Map<String, String> parameters) throws MutiQuartzJobNameException, NoSuchQuartzJobBeanException{
return newQuartzJobPerDay(groupName, jobName, beginTime,null, jobBeanId, parameters);
}
# Timer
Timer利用Java自带特性进行封装,Timer只能在当前机器运行,即如果是两台服务器集群环境,两台服务器都会执行各自的Timer任务:
// 其中sampleTask是一个Runnable
TimerHolder.newTimer(sampleTask, 60 * 60 * 1000);
平台封装了TimerHolder用于定时任务创建,常见API如下:
/**
* 创建定时任务,从现在开始,周期性运行无限次
* @param task 任务
* @param period 运行周期,必须大于0,毫秒
* @return
*/
public static boolean newTimer(Runnable task, long period) {
timer.schedule(new TimerTaskProxy(task, true), new Date(), period);
return true;
}
/**
* 创建定时任务,延迟一段时间后再开始,周期性运行无限次
* @param task 任务
* @param delay 延迟时间,必须大于0,毫秒
* @param period 运行周期,必须大于0,毫秒
* @return
*/
public static boolean newTimer(Runnable task, long delay, long period) {
timer.schedule(new TimerTaskProxy(task, true), delay, period);
return true;
}
/**
* 创建定时任务,在指定时间点运行一次
* @param task 任务
* @param runTime 运行时间点
* @return
*/
public static boolean newTimer(Runnable task, Date runTime) {
timer.schedule(new TimerTaskProxy(task, true), runTime);
return true;
}
# 扩展:QuartzJob表达式
QuartzJob拥有灵活的表达式,如果标准的API无法满足需求,完全可以使用cron表达式来完成定时任务的创建。
一个cron表达式有至少6个(也可能7个)有空格分隔的时间元素。
按顺序依次为
秒(0~59)
分钟(0~59)
小时(0~23)
天(月)(0~31,但是你需要考虑你月的天数)
月(0~11)
天(星期)(1~7 1=SUN 或 SUN,MON,TUE,WED,THU,FRI,SAT)
7.年份(1970-2099) 其中每个元素可以是一个值(如6),一个连续区间(9-12),一个间隔时间(8-18/4)(/表示每隔4小时),一个列表(1,3,5),通配符。由于"月份中的日期"和"星期中的日期"这两个元素互斥的,必须要对其中一个设置?.
0 0 10,14,16 ? 每天上午10点,下午2点,4点
0 0/30 9-17 ? 朝九晚五工作时间内每半小时
0 0 12 ? * WED 表示每个星期三中午12点
"0 0 12 ?" 每天中午12点触发
"0 15 10 ? " 每天上午10:15触发
"0 15 10 ?" 每天上午10:15触发
"0 15 10 ? *" 每天上午10:15触发
"0 15 10 ? 2005" 2005年的每天上午10:15触发
"0 14 * ?" 在每天下午2点到下午2:59期间的每1分钟触发
"0 0/5 14 ?" 在每天下午2点到下午2:55期间的每5分钟触发
"0 0/5 14,18 ?" 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发
"0 0-5 14 ?" 在每天下午2点到下午2:05期间的每1分钟触发
"0 10,44 14 ? 3 WED" 每年三月的星期三的下午2:10和2:44触发
"0 15 10 ? * MON-FRI" 周一至周五的上午10:15触发
"0 15 10 15 * ?" 每月15日上午10:15触发
"0 15 10 L * ?" 每月最后一日的上午10:15触发
"0 15 10 ? * 6L" 每月的最后一个星期五上午10:15触发
"0 15 10 ? * 6L 2002-2005" 2002年至2005年的每月的最后一个星期五上午10:15触发
"0 15 10 ? * 6#3" 每月的第三个星期五上午10:15触发
有些子表达式能包含一些范围或列表
例如:子表达式(天(星期))可以为 “MON-FRI”,“MON,WED,FRI”,“MON-WED,SAT”
“*”字符代表所有可能的值
因此,“”在子表达式(月)里表示每个月的含义,“”在子表达式(天(星期))表示星期的每一天
“/”字符用来指定数值的增量
例如:在子表达式(分钟)里的“0/15”表示从第0分钟开始,每15分钟
在子表达式(分钟)里的“3/20”表示从第3分钟开始,每20分钟(它和“3,23,43”)的含义一样
“?”字符仅被用于天(月)和天(星期)两个子表达式,表示不指定值
当2个子表达式其中之一被指定了值以后,为了避免冲突,需要将另一个子表达式的值设为“?”
“L” 字符仅被用于天(月)和天(星期)两个子表达式,它是单词“last”的缩写
但是它在两个子表达式里的含义是不同的。
在天(月)子表达式中,“L”表示一个月的最后一天
在天(星期)自表达式中,“L”表示一个星期的最后一天,也就是SAT
如果在“L”前有具体的内容,它就具有其他的含义了
例如:“6L”表示这个月的倒数第6天,“FRIL”表示这个月的最一个星期五
注意:在使用“L”参数时,不要指定列表或范围,因为这会导致问题
单位 | 范围 | 表达式 | ||
---|---|---|---|---|
秒 | 0-59 | , - * / | ||
分 | 0-59 | , - * / | ||
小时 | 0-23 | , - * / | ||
日期 | 1-31 | , - * ? / L W C | ||
月份 | 1-12 或者 JAN-DEC | , - * / | ||
星期 | 1-7 或者 SUN-SAT | , - * ? / L C # | ||
年(可选) | 留空, 1970-2099 | , - * / |