xxl-job 编写定时任务

·  阅读 877

这是我参与8月更文挑战的第30天,活动详情查看:8月更文挑战

xxl-job job

引入依赖

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-test</artifactId>
  <scope>test</scope>
</dependency>

<!-- xxl-job-core -->
<dependency>
  <groupId>com.xuxueli</groupId>
  <artifactId>xxl-job-core</artifactId>
  <version>2.3.0</version>
</dependency>
复制代码

application.properties配置文件 指定调度器admin的地址

### xxl-job admin address list, such as "http://address" or "http://address01,http://address02"
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin

### xxl-job, access token
xxl.job.accessToken=

### xxl-job executor appname
xxl.job.executor.appname=xxl-job-executor-sample
### xxl-job executor registry-address: default use address to registry , otherwise use ip:port if address is null
xxl.job.executor.address=
### xxl-job executor server-info
xxl.job.executor.ip=
xxl.job.executor.port=9999
### xxl-job executor log-path
xxl.job.executor.logpath=/Users/rubble/logs/xxl-job/jobhandler
### xxl-job executor log-retention-days
xxl.job.executor.logretentiondays=30
复制代码

编写任务

/** 
 * 开发步骤:
 *      1、任务开发:在Spring Bean实例中,开发Job方法;
 *      2、注解配置:为Job方法添加注解 "@XxlJob(value="自定义jobhandler名称", init = "JobHandler初始化方法", destroy = "JobHandler销毁方法")",注解value值对应的是调度中心新建任务的JobHandler属性的值。
 *      3、执行日志:需要通过 "XxlJobHelper.log" 打印执行日志;
 *      4、任务结果:默认任务结果为 "成功" 状态,不需要主动设置;如有诉求,比如设置任务结果为失败,可以通过 "XxlJobHelper.handleFail/handleSuccess" 自主设置任务结果;
 */
@Component
public class SampleXxlJob {
    private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);


    /**
     * 1、简单任务示例(Bean模式)
     */
    @XxlJob("demoJobHandler")
    public void demoJobHandler() throws Exception {
        XxlJobHelper.log("XXL-JOB, Hello World.");

        for (int i = 0; i < 5; i++) {
            XxlJobHelper.log("beat at:" + i);
            TimeUnit.SECONDS.sleep(2);
        }
        // default success
    }
}
复制代码

创建任务 0/30 * * * * ? * 30秒执行一次

image-20210812202445224.png

查看执行日志

image-20210812202521136.png

执行时间>任务间隔,会阻塞

阻塞处理策略:调度过于密集执行器来不及处理时的处理策略; 单机串行(默认):调度请求进入单机执行器后,调度请求进入FIFO队列并以串行方式运行; 丢弃后续调度:调度请求进入单机执行器后,发现执行器存在运行的调度任务,本次请求将会被丢弃并标记为失败; 覆盖之前调度:调度请求进入单机执行器后,发现执行器存在运行的调度任务,将会终止运行中的调度任务并清空队列,然后运行本地调度任务;

image-20210812202022446.png

GLUE模式(Shell)

步骤一:调度中心,新建调度任务

参考上文“配置属性详细说明”对新建的任务进行参数配置,运行模式选中 “GLUE模式(Shell)”;

image-20210812203657136.png

步骤二:开发任务代码:

任务代码

@Slf4j
@Controller
public class IndexController {

    @RequestMapping("/index")
    @ResponseBody
    String index() {
      log.info("xxl job executor running.");
      return "xxl job executor running.";
    }

}
复制代码

选中指定任务,点击该任务右侧“GLUE”按钮,将会前往GLUE任务的Web IDE界面,在该界面支持对任务代码进行开发(也可以在IDE中开发完成后,复制粘贴到编辑中)。

该模式的任务实际上是一段 “shell” 脚本;

image-20210812203740251.png

输入shell脚本任务

#!/bin/bash
echo "xxl-job: hello shell"
echo "脚本位置:$0"
echo "参数1:$1"
curl -d  ""  $1
sleep 1s
echo "Good bye!"
exit 0

复制代码

查看执行日志,response内容xxl job executor running.已打印到日志

2021-08-12 20:38:15 [com.xxl.job.core.thread.JobThread#run]-[130]-[Thread-66] 
----------- xxl-job job execute start -----------
----------- Param:http://localhost:8081/index
2021-08-12 20:38:15 [com.xxl.job.core.handler.impl.ScriptJobHandler#execute]-[80]-[Thread-66] ----------- script file:/Users/rubble/logs/xxl-job/jobhandler/gluesource/2_1628771461000.sh -----------
xxl-job: hello shell
脚本位置:/Users/rubble/logs/xxl-job/jobhandler/gluesource/2_1628771461000.sh
参数1:http://localhost:8081/index
  % Total    % Received % Xferd  Average Speed   Time    Time     Time  Current
                                 Dload  Upload   Total   Spent    Left  Speed

  0     0    0     0    0     0      0      0 --:--:-- --:--:-- --:--:--     0
100    25  100    25    0     0   4166      0 --:--:-- --:--:-- --:--:--  4166
xxl job executor running.Good bye!
2021-08-12 20:38:16 [com.xxl.job.core.thread.JobThread#run]-[176]-[Thread-66] 
----------- xxl-job job execute end(finish) -----------
----------- Result: handleCode=200, handleMsg = null
2021-08-12 20:38:16 [com.xxl.job.core.thread.TriggerCallbackThread#callbackLog]-[197]-[xxl-job, executor TriggerCallbackThread] 
----------- xxl-job job callback finish.

[Load Log Finish]
复制代码

至此java开发中定时任务常用的两种方式已完成。

分类:
后端
标签:
收藏成功!
已添加到「」, 点击更改