Files
redkale/docs/scheduled.md
redkale a4f8519bcf doc
2023-12-29 11:52:17 +08:00

3.4 KiB
Raw Blame History

定时任务

@Scheduled注解在Service的方法上实现对方法结果进行定时运行。方法必须是无参数或者ScheduleEvent参数。

属性说明

属性 默认值 说明
name 未定义 名称, 可用于第三方实现的定时任务组件的key, 比如xxl-job的任务标识
cron 未定义 cron表达式也可以使用常量值:
@yearly、@annually、@monthly、@weekly、
@daily、@midnight、@hourly、@minutely
@1m、@2m、@3m、@5m、@10m、@15m、@30m
@1h、@2h、@3h、@6h
${env.scheduling.cron}: 读取系统配置项
zone 未定义 时区,cron有值才有效, 例如: "UTC+08"
fixedDelay -1 延迟时间,负数为无效值,支持参数配置、乘法表达式和对象字段值
参数值支持方式:
100: 设置数值
5*60: 乘法表达式值为30
${env.scheduling.fixedDelay}: 读取系统配置项
#delays: 读取宿主对象的delays字段值作为值,
字段类型必须是int、long数值类型
值大于0且fixedRate小于0则使用 ScheduledThreadPoolExecutor.scheduleWithFixedDelay
fixedRate -1 周期时间,负数为无效值,支持参数配置、乘法表达式和对象字段值
参数值支持方式:
100: 设置数值
5*60: 乘法表达式值为30
${env.scheduling.fixedRate}: 读取系统配置项
#intervals: 读取宿主对象的intervals字段值作为值,
字段类型必须是int、long数值类型
值大于0且fixedRate小于0则使用 ScheduledThreadPoolExecutor.scheduleAtFixedRate
initialDelay -1 起始延迟时间,负数为无效值,支持参数配置、乘法表达式和对象字段值
参数值支持方式:
100: 设置数值
5*60: 乘法表达式值为30
${env.scheduling.initialDelay}: 读取系统配置项
#inits: 读取宿主对象的inits字段值作为值,
字段类型必须是int、long数值类型
值大于0且fixedRate和fixedDelay小于0则使用 ScheduledThreadPoolExecutor.schedule
timeUnit TimeUnit.SECONDS 时间单位TimeUnit
comment 未定义 备注描述
mode LoadMode.LOCAL 作用于Service模式默认值为LOCAL
LOCAL: 表示远程模式的Service对象中的定时任务不起作用

用法

  每秒执行

    @Scheduled(cron = "0/1 * * * * ?")
    public void task1() {
        System.out.println(Times.nowMillis() + "执行一次");
    }

环境配置, 定时间隔时间由环境变量env.schedule.fixedRate配置没配置采用默认值60秒)

    @Scheduled(fixedRate = "${env.schedule.fixedRate:60}")
    public String task2() {
        System.out.println(Times.nowMillis() + "执行一次");
        return "";
    }

支持乘法表达式, 系统启动后延迟10分钟后每60分钟执行一次

    @Scheduled(fixedDelay = "10", fixedRate = "2*30", timeUnit = TimeUnit.MINUTES)
    private void task3() {
        System.out.println(Times.nowMillis() + "执行一次");
    }

定时配置

    <!--
        全局Serivce的定时任务设置没配置该节点将自动创建一个。
        enabled 是否开启缓存功能。默认: true
    -->
    <schedule enabled="true"/>