SWT实现简易Cron表达式编辑器

 

1.   关于Cron表达式

这部分内容参考了http://blog.csdn.net/tiwen818/article/details/6988105

1.1          表达式格式

一个cron表达式有至少6个（也可能7个）有空格分隔的时间元素。

 

{秒数} {分钟} {小时} {日期} {月份} {星期} {年份(可为空)}

 

1.2          cron表达式各占位符解释

{秒数}

允许值范围: 0~59 ,不允许为空值，若值不合法，调度器将抛出SchedulerException异常

 

l  "*" 代表每隔1秒钟触发。

l  "," 代表在指定的秒数触发，比如"0,15,45"代表0秒、15秒和45秒时触发任务。

l  "-" 代表在指定的范围内触发，比如"25-45"代表从25秒开始触发到45秒结束触发，每隔1秒触发1次。

l  "/" 代表触发步进(step)，"/"前面的值代表初始值("*"等同"0")，后面的值代表偏移量，比如"0/20"或者"*/20"代表从0秒钟开始，每隔20秒钟触发1次，即0秒触发1次，20秒触发1次，40秒触发1次；"5/20"代表5秒触发1次，25秒触发1次，45秒触发1次；"10-45/20"代表在[10,45]内步进20秒命中的时间点触发，即10秒触发1次，30秒触发1次。

{分钟}

允许值范围: 0~59 ,不允许为空值，若值不合法，调度器将抛出SchedulerException异常。

 

l  "*" 代表每隔1分钟触发。

l  "," 代表在指定的分钟触发，比如"10,20,40"代表10分钟、20分钟和40分钟时触发任务。

 

l  "-" 代表在指定的范围内触发，比如"5-30"代表从5分钟开始触发到30分钟结束触发，每隔1分钟触发。

l  "/" 代表触发步进(step)，"/"前面的值代表初始值("*"等同"0")，后面的值代表偏移量，比如"0/25"或者"*/25"代表从0分钟开始，每隔25分钟触发1次，即0分钟触发1次，第25分钟触发1次，第50分钟触发1次；"5/25"代表5分钟触发1次，30分钟触发1次，55分钟触发1次；"10-45/20"代表在[10,45]内步进20分钟命中的时间点触发，即10分钟触发1次，30分钟触发1次。

 

{小时}

允许值范围: 0~23 ,不允许为空值，若值不合法，调度器将抛出SchedulerException异常。

 

l  "*" 代表每隔1小时触发。

l  "," 代表在指定的时间点触发，比如"10,20,23"代表10点钟、20点钟和23点触发任务。

l  "-" 代表在指定的时间段内触发，比如"20-23"代表从20点开始触发到23点结束触发，每隔1小时触发。

l  "/" 代表触发步进(step)，"/"前面的值代表初始值("*"等同"0")，后面的值代表偏移量，比如"0/1"或者"*/1"代表从0点开始触发，每隔1小时触发1次；"1/2"代表从1点开始触发，以后每隔2小时触发一次；"19-20/2"表达式将只在19点触发。

 

{日期}

允许值范围: 1~31 ,不允许为空值，若值不合法，调度器将抛出SchedulerException异常。

 

l  "*" 代表每天触发。

l  "?" 与{星期}互斥，即意味着若明确指定{星期}触发，则表示{日期}无意义，以免引起冲突和混乱。

l  "," 代表在指定的日期触发，比如"1,10,20"代表1号、10号和20号这3天触发。

l  "-" 代表在指定的日期范围内触发，比如"10-15"代表从10号开始触发到15号结束触发，每隔1天触发。

l  "/" 代表触发步进(step)，"/"前面的值代表初始值("*"等同"1")，后面的值代表偏移量，比如"1/5"或者"*/5"代表从1号开始触发，每隔5天触发1次；"10/5"代表从10号开始触发，以后每隔5天触发一次；"1-10/2"表达式意味着在[1,10]范围内，每隔2天触发，即1号，3号，5号，7号，9号触发。

l  "L" 如果{日期}占位符如果是"L"，即意味着当月的最后一天触发。

l  "W "意味着在本月内离当天最近的工作日触发，所谓最近工作日，即当天到工作日的前后最短距离，如果当天即为工作日，则距离为0；所谓本月内的说法，就是不能跨月取到最近工作日，即使前/后月份的最后一天/第一天确实满足最近工作日；因此，"LW"则意味着本月的最后一个工作日触发，"W"强烈依赖{月份}。

l  "C" 根据日历触发，由于使用较少，暂时不做解释。

 

{月份}

允许值范围: 1~12 (JAN-DEC),不允许为空值，若值不合法，调度器将抛出SchedulerException异常。

 

l  "*" 代表每个月都触发。

l  "," 代表在指定的月份触发，比如"1,6,12"代表1月份、6月份和12月份触发任务。

l  "-" 代表在指定的月份范围内触发，比如"1-6"代表从1月份开始触发到6月份结束触发，每隔1个月触发。

l  "/" 代表触发步进(step)，"/"前面的值代表初始值("*"等同"1")，后面的值代表偏移量，比如"1/2"或者"*/2"代表从1月份开始触发，每隔2个月触发1次；"6/6"代表从6月份开始触发，以后每隔6个月触发一次；"1-6/12"表达式意味着每年1月份触发。

 

{星期}

允许值范围: 1~7 (SUN-SAT),1代表星期天(一星期的第一天)，以此类推，7代表星期六(一星期的最后一天)，不允许为空值，若值不合法，调度器将抛出SchedulerException异常。

 

l  "*" 代表每星期都触发。

l  "?" 与{日期}互斥，即意味着若明确指定{日期}触发，则表示{星期}无意义，以免引起冲突和混乱。

l  "," 代表在指定的星期约定触发，比如"1,3,5"代表星期天、星期二和星期四触发

l  "-" 代表在指定的星期范围内触发，比如"2-4"代表从星期一开始触发到星期三结束触发，每隔1天触发

l  "/" 代表触发步进(step)，"/"前面的值代表初始值("*"等同"1")，后面的值代表偏移量，比如"1/3"或者"*/3"代表从星期天开始触发，每隔3天触发1次；"1-5/2"表达式意味着在[1,5]范围内，每隔2天触发，即星期天、星期二、星期四触发

l  "L" 如果{星期}占位符如果是"L"，即意味着星期的的最后一天触发，即星期六触发，L= 7或者 L = SAT，因此，"5L"意味着一个月的最后一个星期四触发

l  "#" 用来指定具体的周数，"#"前面代表星期，"#"后面代表本月第几周，比如"2#2"表示本月第二周的星期一，"5#3"表示本月第三周的星期四，因此，"5L"这种形式只不过是"#"的特殊形式而已

l  "C" 根据日历触发，由于使用较少，暂时不做解释

{年份}

允许值范围: 1970~2099 ,允许为空，若值不合法，调度器将抛出SchedulerException异常

 

l  "*"代表每年都触发；

l  ","代表在指定的年份才触发，比如"2011,2012,2013"代表2011年、2012年和2013年触发任务

l  "-"代表在指定的年份范围内触发，比如"2011-2020"代表从2011年开始触发到2020年结束触发，每隔1年触发

l  "/"代表触发步进(step)，"/"前面的值代表初始值("*"等同"1970")，后面的值代表偏移量，比如"2011/2"或者"*/2"代表从2011年开始触发，每隔2年触发1次

 

注意：除了{日期}和{星期}可以使用"?"来实现互斥，表达无意义的信息之外，其他占位符都要具有具体的时间含义，且依赖关系为：年->月->日期(星期)->小时->分钟->秒数

 

1.3          经典案例

cron表达式的强大魅力在于灵活的横向和纵向组合以及简单的语法，用cron表达式几乎可以写出任何你想要触发的时间点。

 

"30 * * * * ?" 每半分钟触发任务

"30 10 * * * ?" 每小时的10分30秒触发任务

"30 10 1 * * ?" 每天1点10分30秒触发任务

"30 10 1 20 * ?" 每月20号1点10分30秒触发任务

"30 10 1 20 10 ? *" 每年10月20号1点10分30秒触发任务

"30 10 1 20 10 ? 2011" 2011年10月20号1点10分30秒触发任务

"30 10 1 ? 10 * 2011" 2011年10月每天1点10分30秒触发任务

"30 10 1 ? 10 SUN 2011" 2011年10月每周日1点10分30秒触发任务

"15,30,45 * * * * ?" 每15秒，30秒，45秒时触发任务

"15-45 * * * * ?" 15到45秒内，每秒都触发任务

"15/5 * * * * ?" 每分钟的每15秒开始触发，每隔5秒触发一次

"15-30/5 * * * * ?" 每分钟的15秒到30秒之间开始触发，每隔5秒触发一次

"0 0/3 * * * ?" 每小时的第0分0秒开始，每三分钟触发一次

"0 15 10 ? * MON-FRI" 星期一到星期五的10点15分0秒触发任务

"0 15 10 L * ?" 每个月最后一天的10点15分0秒触发任务

"0 15 10 LW * ?" 每个月最后一个工作日的10点15分0秒触发任务

"0 15 10 ? * 5L" 每个月最后一个星期四的10点15分0秒触发任务

"0 15 10 ? * 5#3" 每个月第三周的星期四的10点15分0秒触发任务

2.   实现功能

此部分代码详见：https://github.com/clamaa/cron-expression-editor-swt

 

由于该编辑器是使用SWT实现的，主要功能就是给用户提供一个可以用于界面配置的Cron编辑器。需要依赖eclipse的一些jar包，下图中展示了Reference Library中的包（并没有详细地过滤，当前是在eclipse 3.7下开发的）:

 

 

 

测试入口类，用来显示Cron表达式测试的对应SWT界面：

com.yonyou.clamaa.ui.cronexpression.CronExpressionTestUI

  

2.1          通配符

因为Cron编辑器中对于秒，分，小时，天，月份等设置的控件有重复并且差别不大，本实现中采用了抽象的方式对每个部分组合，最终实现整个界面对话框的开发。

 

经过分析，将每条配置抽象成IWildCardRule接口，用于定义任何通配符，根据分类，通配符的主要类型有以下几种：

 

 

 

因此总结出通配符的各种类型策略：

类型	表示
全部值	任何文本表示，*
单独值	单独一个值，比如1
多个值	可能发生的多个值，比如1，3
范围值	一个范围，比如2-5
第几个星期几（天）	5#3，表示第3个星期5
最后一个工作日（月）	LW
开始，间隔	1#4，第一个开始，间隔4，即1，5，9……
无值（年）	空
不确定（实现星期和日的互斥）	？
……	其他不再一一列出

 

 

2.2          通配符配置界面

通配符最重要的方法便是提供对应的用户界面，生成对应的通配符文本表示。其中的通配符界面对应每个通配符(IWildCardRule)实现。

 

 


 
 

 

注意，这部分的实现是与SWT中的控件紧密关联的，因此，如果想从这部分进行抽象分离，实现基于Swing或其他UI类型的需要从这层向上改起。

 

具体实现详见代码。

2.3          Cron配置页签

根据Cron表达式可能出现的特性，每种时间属性类型都是通配符的一系列组合。因此，将页签抽象出单独的接口来表示：

 

com.yonyou.clamaa.ui.cronexpression.ICronTimeConfigTab

 

其实现，也就是每种类型CronTimeConfig的表示，具体包括秒，分，小时，天，星期，月份，年等。

 

 

 

2.4          反向解析Cron表达式

该工具不仅能够将用户配置的策略转换成Cron表达式，还可以根据已经存在的Cron表达式进行验证，验证成功后，就可以更改当前的界面配置，属于反向Cron表达式解析过程。

 

具体的解析方法如下所示：

 


 
 

当用户配置的字符串出现错误时，会抛出相应的异常。

 

实现中大量使用了观察者模式，用于监听界面的变化对生成文本字段造成的影响。

 

 

3.   演示效果

自此，Cron编辑器就已经实现完成，其展示效果：

 

 

可以对每一级维度进行单独设置，最终显示成Cron Expression文本框中，注意‘天’和‘日期’必须至少一个为不确定类型!

 

 

 

由于Cron表达式可以使用英文表示，提供此选项。

 

熟悉Cron表达式语法的用户可以直接使用手动编辑器进行操作。