5分钟从quartz到xxl-job

738 阅读4分钟

携手创作,共同成长!这是我参与「掘金日新计划 · 8 月更文挑战」的第18天,点击查看活动详情

背景

本猿入行的时候第一次接触quartz的时候感觉真牛逼,定时执行还可以这么灵活,而且支持在业务层创建修和改定时任务,用得飞起。后来接触了分布式,越来越觉得quartz有点吃力了,后面又接触了xxl-job,发现是国产的框架,使用了一下,真香定律再次触发,用起来超级简单,当然如果你需要复杂功能的化它也具备,真实一山还比一山高,今天咱们就来入门一下xxl-job。

实战

xxl-job一般分为2个模块,第一个就是调度中心,就像地铁的调度中心一样,在这里指定规则,指挥着各条地铁线路有条不紊地奔跑,xxl-job则调度指挥各个服务的任务去执行;还有一个就是被调度端,即任务的执行端,就相当于一条条被调度的地铁。

调度中心

调度中心可在github上下载下来,包含2个模块:一个xxl-job-core,一个xxl-job-admin。

  • 在doc/db目录下有一个tables_xxl_job.sql文件,导入数据库。
  • 在xxl-job-admin模块中的application.properties中修改数据库配置为上个步骤导入的数据库信息。
  • 打包部署(其他配置均可不改,用到了再说)
### xxl-job, datasource
spring.datasource.url=jdbc:mysql://localhost:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

任务端

任务端即真正的定时任务的业务执行逻辑,这个部分需要我们按照业务逻辑来实现。这里简单写个例子。

@Component
public class TestJob {
    private Logger logger = LoggerFactory.getLogger(TestJob.class);
    
    @XxlJob("testJob")
    @Transactional(rollbackFor = Exception.class)
    public void orderCancelCheckJob() {
        logger.info("【定时任务】 testJob start");
        //do something
        logger.info("【定时任务】 testJob end");
    }
}

那这个时候我们任务端怎么样才能被调度中心调度呢?肯定要让自己被调度中心发现才行。这里需要一个注册机制,任务主动向调度中心注册,告诉调度中心我上线了,你按规则来调度我。所以任务端这里需要一些配置。

xxl:
  job:
    admin:
      ### 调度中心部署跟地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调";为空则关闭自动注册;
      addresses: http://localhost:18080/xxl-job-admin
    ### 执行器通讯TOKEN [选填]:非空时启用
    accesstoken:
    executor:
      ### 执行器AppName [选填]:执行器心跳注册分组依据;为空则关闭自动注册
      appname: testjob
      ### 执行器注册 [选填]:优先使用该配置作为注册地址,为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
      address:
      ### 执行器IP [选填]:默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册" 和 "调度中心请求并触发任务";
      ip:
      ### 执行器端口号 [选填]:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口;
      port: 9999
      ### 执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径;
      #logpath:/opt/joblogs/
      logpath: D:/try/
      ### 执行器日志文件保存天数 [选填] : 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能;
      logretentiondays: 30

这些配置都有相应的含义注释,功能还是比较清楚的,但是我们这里没有看到任务执行的规则,那任务的规则在哪里配置呢?我们想一下,地铁调度规则肯定不会在被调度的地铁车上,而是在调度中心,所以我们登录调度中心看下。使用admin/123456登录http://localhost:18080/xxl-job-admin/。

我们看到执行器管理,空空如也,新增一个,AppName正好对应我们任务端配置的appname,然后选择【自动注册】,一段时间之后可以看到有一台任务服务注册上来了。这个时候我们再到任务管理,同样新建一个任务

图片.png 执行器不用说选择新增的那个,调度类型我们选个熟悉的cron表达式把,然后输入Cron表达式,我们使用了Spring,运行模式选择BEAN,接下来JobHandler注意了,我们要选择我们任务类@XxlJob注解里的值,即testJob,然后保存即可。

大功告成,接下来我们就等待任务执行就可以了。

总结

我这里使用xxl-job的原因是遇到了分布式情况下quartz用抢占的问题,之前引入分布式锁来解决竞争问题,搞得比较麻烦了,用了xxl-job之后发现,这是个功能齐全的框架,一般场景的调度功能在这里都能得到解决。以后还要多多使用和研究。