模块 org.redkale
程序包 org.redkale.scheduled

注释类型 Scheduled

  • @Documented
@Target(METHOD)
@Retention(RUNTIME)
public @interface Scheduled
    定时任务标记，只能作用于Service的无参数或者单一ScheduledEvent参数的菲static方法上, 功能类似Spring里的Scheduled注解

    详情见: https://redkale.org

    从以下版本开始:
    2.8.0
    作者:
    zhangjx

    • 可选元素概要

      可选元素 
      修饰符和类型 可选元素 说明
      String comment
      备注
      String cron
      cron表达式, 特殊值:
      @yearly、@annually、@monthly、@weekly、@daily、@midnight、@hourly、@minutely @1m、@2m、@3m、@5m、@10m、@15m、@30m、 @1h、@2h、@3h、@6h ${env.scheduling.cron}: 读取系统配置项
      String fixedDelay
      延迟时间，支持参数配置、乘法表达式和对象字段值
      参数值支持方式:
      100: 设置数值 ${env.scheduling.fixedDelay}: 读取系统配置项
      String fixedRate
      周期时间，支持参数配置、乘法表达式和对象字段值
      参数值支持方式:
      100: 设置数值 ${env.scheduling.fixedRate}: 读取系统配置项
      String initialDelay
      起始延迟时间，支持参数配置、乘法表达式和对象字段值
      参数值支持方式:
      100: 设置数值 ${env.scheduling.initialDelay}: 读取系统配置项
      LoadMode mode
      Service加载模式
      String name
      名称, 可用于第三方实现的定时任务组件的key
      TimeUnit timeUnit
      时间单元
      String zone
      时区, 例如: Asia/Shanghai

    • 元素详细资料

      • name

        String name
        名称, 可用于第三方实现的定时任务组件的key
        返回:
        名称
        默认值:
        ""

      • cron

        String cron
        cron表达式, 特殊值:
        @yearly、@annually、@monthly、@weekly、@daily、@midnight、@hourly、@minutely @1m、@2m、@3m、@5m、@10m、@15m、@30m、 @1h、@2h、@3h、@6h ${env.scheduling.cron}: 读取系统配置项
        返回:
        cron表达式
        默认值:
        ""

      • zone

        String zone
        时区, 例如: Asia/Shanghai
        返回:
        时区
        默认值:
        ""

      • fixedDelay

        String fixedDelay
        延迟时间，支持参数配置、乘法表达式和对象字段值
        参数值支持方式:
        100: 设置数值 ${env.scheduling.fixedDelay}: 读取系统配置项

        值大于0且fixedRate小于0则使用 ScheduledThreadPoolExecutor.scheduleWithFixedDelay

        返回:
        延迟时间
        默认值:
        "-1"

      • fixedRate

        String fixedRate
        周期时间，支持参数配置、乘法表达式和对象字段值
        参数值支持方式:
        100: 设置数值 ${env.scheduling.fixedRate}: 读取系统配置项

        值大于0则使用 ScheduledThreadPoolExecutor.scheduleAtFixedRate

        返回:
        周期时间
        默认值:
        "-1"

      • initialDelay

        String initialDelay
        起始延迟时间，支持参数配置、乘法表达式和对象字段值
        参数值支持方式:
        100: 设置数值 ${env.scheduling.initialDelay}: 读取系统配置项

        值大于0且fixedRate和fixedDelay小于0则使用 ScheduledThreadPoolExecutor.schedule

        返回:
        起始延迟时间
        默认值:
        "-1"

      • timeUnit

        TimeUnit timeUnit
        时间单元
        返回:
        时间单元
        默认值:
        java.util.concurrent.TimeUnit.SECONDS

      • comment

        String comment
        备注
        返回:
        备注
        默认值:
        ""

      • mode

        LoadMode mode
        Service加载模式
        返回:
        模式
        默认值:
        org.redkale.service.LoadMode.LOCAL