@@ -1,85 +1,85 @@
# 定时任务 # 定时任务
   @Scheduled注解在Service的方法上 ，实现对方法结果进行定时运行。方法必须是无参数或者```ScheduledEvent` ``参数。    @Scheduled注解在Service的方法上 ，实现对方法结果进行定时运行。方法必须是无参数或者```ScheduledEvent` ``参数。
## 属性说明 ## 属性说明
|属性|默认值|说明| |属性|默认值|说明|
| --- | --- | --- | | --- | --- | --- |
|name|未定义|名称, 可用于第三方实现的定时任务组件的key, 比如xxl-job的任务标识| |name|未定义|名称, 可用于第三方实现的定时任务组件的key, 比如xxl-job的任务标识|
|cron|未定义|cron表达式， |cron|未定义|cron表达式，
|zone|未定义|时区，` ``cron` ``有值才有效, 例如: "Asia/Shanghai"| |zone|未定义|时区，` ``cron` ``有值才有效, 例如: "Asia/Shanghai"|
|fixedDelay|-1|延迟时间，负数为无效值，支持参数配置、乘法表达式和对象字段值 <br> 参数值支持方式:<br>  100: 设置数值 <br>  ${env.scheduled.fixedDelay}: 读取系统配置项 <br> 值大于0且fixedRate小于0则使用 ScheduledThreadPoolExecutor.scheduleWithFixedDelay | |fixedDelay|-1|延迟时间，负数为无效值，支持参数配置、乘法表达式和对象字段值 <br> 参数值支持方式:<br>  100: 设置数值 <br>  ${env.scheduled.fixedDelay}: 读取系统配置项 <br> 值大于0且fixedRate小于0则使用 ScheduledThreadPoolExecutor.scheduleWithFixedDelay |
|fixedRate|-1|周期时间，负数为无效值，支持参数配置、乘法表达式和对象字段值 <br> 参数值支持方式:<br>  100: 设置数值 <br>  ${env.scheduled.fixedRate}: 读取系统配置项 <br> 值大于0且fixedRate小于0则使用 ScheduledThreadPoolExecutor.scheduleAtFixedRate | |fixedRate|-1|周期时间，负数为无效值，支持参数配置、乘法表达式和对象字段值 <br> 参数值支持方式:<br>  100: 设置数值 <br>  ${env.scheduled.fixedRate}: 读取系统配置项 <br> 值大于0且fixedRate小于0则使用 ScheduledThreadPoolExecutor.scheduleAtFixedRate |
|initialDelay|-1|起始延迟时间，负数为无效值，支持参数配置、乘法表达式和对象字段值 <br> 参数值支持方式:<br>  100: 设置数值 <br>  ${env.scheduled.initialDelay}: 读取系统配置项 <br> 值大于0且fixedRate和fixedDelay小于0则使用 ScheduledThreadPoolExecutor.schedule | |initialDelay|-1|起始延迟时间，负数为无效值，支持参数配置、乘法表达式和对象字段值 <br> 参数值支持方式:<br>  100: 设置数值 <br>  ${env.scheduled.initialDelay}: 读取系统配置项 <br> 值大于0且fixedRate和fixedDelay小于0则使用 ScheduledThreadPoolExecutor.schedule |
|timeUnit|` ``TimeUnit.SECONDS` ``|时间单位TimeUnit| |timeUnit|` ``TimeUnit.SECONDS` ``|时间单位TimeUnit|
|comment|未定义|备注描述| |comment|未定义|备注描述|
|mode|` ``LoadMode.LOCAL` ``|作用于Service模式， ： ， |mode|` ``LoadMode.LOCAL` ``|作用于Service模式， ： ，
## 基本用法 ## 基本用法
  每秒执行   每秒执行
` ``java ` ``java
@Scheduled(cron = "0/1 * * * * ?") @Scheduled(cron = "0/1 * * * * ?")
public void task1() { public void task1() {
System.out.println(Times.nowMillis() + "执行一次"); System.out.println(Times.nowMillis() + "执行一次");
} }
` `` ` ``
  <b>数值配置</b>, 系统启动后延迟10分钟后每60分钟执行一次，   <b>数值配置</b>, 系统启动后延迟10分钟后每60分钟执行一次，
` ``java ` ``java
@Scheduled(fixedDelay = "10", fixedRate = "60", timeUnit = TimeUnit.MINUTES) @Scheduled(fixedDelay = "10", fixedRate = "60", timeUnit = TimeUnit.MINUTES)
private void task3() { private void task3() {
System.out.println(Times.nowMillis() + "执行一次"); System.out.println(Times.nowMillis() + "执行一次");
} }
` `` ` ``
  <b>环境配置</b>, 定时间隔时间由环境变量` ``env.scheduled.fixedRate` ``配置，   <b>环境配置</b>, 定时间隔时间由环境变量` ``env.scheduled.fixedRate` ``配置，
` ``java ` ``java
@Scheduled(fixedRate = "${env.scheduled.fixedRate:60}") @Scheduled(fixedRate = "${env.scheduled.fixedRate:60}")
public String task2() { public String task2() {
System.out.println(Times.nowMillis() + "执行一次"); System.out.println(Times.nowMillis() + "执行一次");
return ""; return "";
} }
` `` ` ``
## 基本配置 ## 基本配置
` ``xml ` ``xml
<!-- <!--
全局Serivce的定时任务设置， 全局Serivce的定时任务设置，
enabled： enabled：
--> -->
<scheduled enabled="true"/> <scheduled enabled="true"/>
` `` ` ``
## 使用Xxl-Job ## 使用Xxl-Job
  Scheduled可以采用第三方实现, 官方扩展包` ``redkale-plugins` ``提供了xxl-job实现，   Scheduled可以采用第三方实现, 官方扩展包` ``redkale-plugins` ``提供了xxl-job实现，
### pom依赖 ### pom依赖
` ``xml ` ``xml
<dependency> <dependency>
<groupId>org.redkalex</groupId> <groupId>org.redkalex</groupId>
<artifactId>redkale-plugins</artifactId> <artifactId>redkale-plugins</artifactId>
<version>2.8.0</version> <version>2.8.0</version>
</dependency> </dependency>
` `` ` ``
### 配置文件 ### 配置文件
` ``xml ` ``xml
<scheduled enabled="true"> <scheduled enabled="true">
<xxljob addresses="http://localhost:8080/xxl-job-admin" <xxljob addresses="http://localhost:8080/xxl-job-admin"
executorName="redkale-examples" executorName="redkale-examples"
ip="127.0.0.1" <!-- 可选 --> ip="127.0.0.1" <!-- 可选 -->
port="5678" <!-- 可选 --> port="5678" <!-- 可选 -->
accessToken="default_token" /> accessToken="default_token" />
</scheduled> </scheduled>
` `` ` ``
### 使用方法 ### 使用方法
` ``java ` ``java
@Scheduled(name = "testTask") @Scheduled(name = "testTask")
public void runTask(ScheduleEvent event) { public void runTask(Scheduled Event event) {
System.out.println("xxl-job参数param: " + event.getString("param")); System.out.println("xxl-job参数param: " + event.getString("param"));
System.out.println("xxl-job参数index: " + event.getInteger("index")); System.out.println("xxl-job参数index: " + event.getInteger("index"));
System.out.println("xxl-job参数total: " + event.getInteger("total")); System.out.println("xxl-job参数total: " + event.getInteger("total"));
} }
` ``` ``
redkale