前言
大家好,我是福隆苑居士,今天给大家聊聊XXL-JOB的使用。
XXL-JOB是本人呆过的三家公司都使用到的分布式任务调度平台,前两家都是服务于传统行业(某大型移动基地和某大型电网),现在这家是服务于互联网行业(和腾讯阿里都有战略合作),从1.9.x版本使用到现在的2.3.0版本,我认为XXL-JOB的使用方式越来越简单且高效,刚发版时的BUG也修复了很多,并且跟上了这些年技术发展的节奏,可以预见会继续被更多中小企业所亲睐。
推荐原因
1)、经过几年的发展,受众多,中小企业尤其喜欢;
2)、持续更新迭代,修复了很多BUG,2.0版本开始引入了新的特性,耦合性降低;
3)、搭建相当简单,几乎是傻瓜式,开箱即用,这也是我最喜欢的原因;
4)、源码有很多学习的地方,虽然刚开始有被一些资深程序员诟病,但经过大量线上环境洗礼,已经非常稳定,个人以前有读过源码,几乎都是java最基础的开发方式,朴实无华到你以为自己穿越到十年前,但换成自己又写不出来,就是这种奇妙的感觉。
安装方法
这里我以xxl-job最新版2.3.0为例讲解
官方文档:https://www.xuxueli.com/xxl-job/
1、下载
源码仓库地址
源码仓库地址 | Release Download |
---|---|
https://github.com/xuxueli/xxl-job | Download |
http://gitee.com/xuxueli0323/xxl-job | Download |
中央仓库地址
com.xuxueli
xxl-job-core
${最新稳定版本}
友情提示:个人推荐使用源码安装方式,然后打jar包部署,因为xxljob本身使用了springboot框架,可以和其他项目一起发布到k8s,且后期更便于维护。
2、安装
xxljob主要分为调度中心和执行器,简单来讲,调度中心就是后台管理,执行器就是执行定时任务的,就这么理解就行,没那么高大上。
1)、执行sql
2)、调度中心
调度中心就是xxl-job-admin,打开application.properties,修改数据源中的地址和账号密码即可。
然后直接启动项目就行,真实环境中就是打jar包发布执行。
启动后,访问:http://localhost:8080/xxl-job-admin
(该地址后面要装的执行器将会使用到,作为回调地址。)
3)、执行器
执行器就是xxl-job-executor-samples工程里面的项目,我们选择第二个springboot项目即可,当然,你也可以单独把这个项目摘取出来,我反正每次不去管它,没啥影响。
打开application.properties,需要修改的也就是调度中心的地址,因为执行器要注册到调度中心才能执行任务,其他的都是执行器的选填项,一般没必要不改就行。
同样的,检查完配置后启动这个springboot项目即可,也可以打成jar包发布。
启动后,一般过一会儿就会注册到调度中心,打开调度中心后台的执行器管理就能发现已经连上了。
至此,xxl-job实际上就搭建完成了,可以发现,作者从一开始就是想着开箱即用,所以非常简单。
最佳使用方法
这里我专门说下,我从在广州工作经历的两家公司到现在的互联网公司,都用了xxl-job,前面的公司分别用到了两种调度方式,直到目前的公司,使用了新版开始才用到了第三种方式,也是我认为对程序员最友好的方式。
这种方式叫做原生内置Bean模式任务,在官网有一个小小的位置讲到了,后面会贴给大家看。
1)、编写测试方法
这里我们编写两个简单的获取用户信息接口(GET方式)和新增订单接口(POST方式)
package com.example.demo.controller;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.*;
import java.util.Map;
/**
*
* 测试控制器
*
*
* @author 福隆苑居士,公众号:【Java分享客栈】
* @since 2022-02-23 15:46
*/
@RestController
@RequestMapping("/api")
public class TestController {
private static final Logger log = LoggerFactory.getLogger(TestController.class);
/**
* 获取用户信息
*/
@GetMapping("/getUser")
public String getUser(@RequestParam(value = "userId") String userId,
@RequestParam(value = "param") String param) {
log.debug("[XXLJOB]>>>> 获取用户信息....userId={}, param={}", userId, param);
return "成功";
}
/**
* 新增订单信息
*/
@PostMapping(value = "/saveOrder", produces = MediaType.APPLICATION_JSON_VALUE)
public String saveOrder(@RequestBody(required = false) Map reqMap) {
log.debug("[XXLJOB]>>>> 新增订单信息....reqMap={}", reqMap);
return "成功";
}
}
2)、GET方式
打开任务管理,点击新增,然后按照图示配置即可,这里特别说明,JobHandler一栏必须填写httpJobHandler,这是xxl-job内置的handler,不能写错名称。
传参就在url后面写即可
3)、POST方式
4)、效果
启动测试项目两个接口,然后将调度中心我们新建的两个定时任务打开,看10秒和15秒后是不是分别开始执行两个测试接口。
可以看到,两个接口都会根据cron表达式配置的时间开始执行调度任务,说明我们整个调度平台搭建是成功的。
说明
官网文档其实写的很清晰,我这里贴出几种调度方式给大家看,里面最常用的其实是BEAN模式类形式,这种需要人工开发Job类,然后调度中心新建任务指向这个JobHandler,本人前两个公司都是这么用的,当时就总觉得不太习惯。
红框中的就是本文讲到的BEAN方法形式中的内置模式,也就是直接调http接口就行,不需要额外编写Job类,这种其实最符合高内聚低耦合的原则,项目中调度任务越多越能发现这种方式维护起来有多清爽。
这里贴出来数据库表中的内容,可以发现xxl_job_info表存的就是我们新建的定时任务信息。
然后xxl_job_log表存的就是我们执行调度任务产生的日志,可以发现一会儿就几十条了,那么会不会在线上环境把日志表撑爆呢,看下面一张图。
前面讲过的调度中心和执行器的application.properties文件中,最后有一行都有配置日志保存天数的,默认是30天,可以根据项目规模进行修改。
实际上,用了好几年,我认为这个日志作用不大,不需要保留太久,项目规模不大的话就默认也行。
总结
xxl-job的使用非常简单,中小厂甚至不需要集群都是够用的,这个调度平台哪怕挂掉了,重启后依然能继续执行,基本不影响原有业务逻辑,我呆过的这三个公司都是单机部署,线上也没出现过任何问题,这也是我极力推荐给大家的原因,好学好用,不就是懒人必备么。
如果大家觉得有一滴滴帮助的话,就请一键……伸出芊芊玉手点个推荐推荐推荐吧~~