您可以通过以下三种不同的启动方式提前安排自动化操作:
第一个参数 Time.ScheduledTimeEvent
可让你根据时钟时间或太阳事件(即日出或日落)安排自动化操作在未来的某个精确时间启动,或按周期性启动。
例如,以下启动器会每天晚上 10:00 启动自动化操作:
starter<_>(structure, Time.ScheduledTimeEvent) { parameter(Time.ScheduledTimeEvent.clockTime(LocalTime.of(22, 0, 0, 0))) }
或者,您也可以指定太阳时间事件,而不是时钟时间。此类启动器的参数是 SolarTimeStruct
,其中包含:
type
,即SolarTimeType.Sunrise
或SolarTimeType.Sunset
。offset
,可让您将开始时间相对于太阳事件 сдвинуть на любое время. 正值会在太阳事件发生后延迟启动,负值会导致启动器在太阳事件发生前触发。
以下示例是一个启动器,用于每天在日出前 15 分钟启动自动化操作:
starter<_>(structure, Time.ScheduledTimeEvent) { parameter( Time.ScheduledTimeEvent.solarTime( SolarTimeStruct(SolarTimeType.Sunrise, java.time.Duration.ofMinutes(-15)) ) ) }
后两个启动器是周期性安排的事件启动器,可让您创建根据更具体的条件(既可以是基于时间的条件,也可以是基于日历的条件)定期运行的自动化操作。
借助 Time.RecurringClockTimeScheduledEvent
,您可以根据一个或多个时间或日期条件安排自动化操作。此起始配置使用的语法与 Unix cron
实用程序用于指定周期性自动化操作的时间表的语法类似。
借助 Time.RecurringSolarTimeScheduledEvent
,您可以根据日出或日落时间安排自动化操作,还可以根据日历条件进行组合。
cron
表达式
您可能已经熟悉 cron
,它是用于在 Unix 和 Linux 系统上调度周期性作业的命令。
重复性预定事件启动器使用的调度表达式语法与 cron
使用的语法类似,因此,与这些启动器搭配使用的调度表达式称为 cron
表达式。
cron
有几种不同的“变种”,这些实现中的语法也有几种变体。定期安排的事件启动器 cron
表达式使用与 Quartz 调度程序相同的语法。如需了解 Quartz cron
表达式语法,请参阅 Quartz 的 CronExpression
文档。
示例
下面举例说明。
使用场景 | 第二步 | 分钟 | 小时 | 日期 | 月 | 周几 | 年 |
---|---|---|---|---|---|---|---|
每 24 小时运行一次(午夜) | 0 |
0 |
0 |
? |
* |
* |
* |
每周二上午 6:00 运行 | 0 |
30 |
19 |
? |
* |
3 |
* |
在 2 月份的每个小时 15 分运行 | 0 |
15 |
* |
? |
2 |
* |
* |
每小时运行一次 | 0 |
0 |
* |
? |
* |
* |
* |
在 1 月至 3 月期间,每 24 小时运行一次,时间为午夜,运行日期为离当月 1 日最近的工作日 | 0 |
0 |
0 |
? |
1-3 |
1W |
* |
在 2 月的第二个星期四,每小时一次,在 15 分 | 0 |
15 |
* |
? |
2 |
5#2 |
* |
在 2 月的最后一天,每小时 15 分运行一次 | 0 |
15 |
* |
L |
2 |
? |
* |
每周二和周四上午 6:00 运行 | 0 |
30 |
19 |
? |
* |
3,5 |
* |
RecurringClockTimeScheduledEvent
在 RecurringClockTimeScheduledEvent
启动器中,cron
表达式字符串会分配给 Time.RecurringClockTimeScheduledEvent.cronExpression
字段。
以下示例展示了一个 RecurringClockTimeScheduledEvent
启动器,该启动器会在 4 月的每个星期三晚上 8:00 启动自动化操作:
starter<_>(structure, event = Time.RecurringClockTimeScheduledEvent) { parameter(Time.RecurringClockTimeScheduledEvent.cronExpression("0 0 20 ? 4 4 *")) }
RecurringSolarTimeScheduleEvent
RecurringSolarTimeScheduleEvent
启动器接受两个参数:
- 一个
SolarTimeStruct
。 cronExpression
:cron
表达式的子集,仅包含“日期”“月份”“星期几”和“年份”字段。太阳时间决定了自动化操作的确切开始时间,因此“秒”“分钟”和“小时”字段会被省略。
以下示例是一个启动器,会导致自动化操作在 4 月每个星期三日出后一小时启动:
starter<_>(structure, event = Time.RecurringSolarTimeScheduledEvent) { parameter( Time.RecurringSolarTimeScheduledEvent.solarTime( TimeTrait.SolarTimeStruct(SolarTimeType.Sunrise, Duration.ofHours(1)) ) ) parameter(Time.RecurringSolarTimeScheduledEvent.cronExpression("? 4 4 *")) }