- 官方文档及其项目仓库:
https://www.xuxueli.com/xxl-job/ (演示为2.3.0版本)
准备
- 首先先去官方地址 把项目拷贝下来(后续在定时任务那边结合自己实际业务改动就行)
- xxljob主要分为调度中心和执行器,简单来讲,调度中心就是后台管理,执行器就是执行定时任务的
建立对应的数据库表及其配置
启动调度中心项目
- 直接启动
admin模块 项目就行,真实环境中就是打jar包发布执行。 启动后,访问:http://localhost:8080/xxl-job-admin (端口可以自己后续改) (该地址后面要装的执行器将会使用到,作为回调地址。) - 账号:admin ,密码123 默认
执行器配置
- 执行器就是xxl-job-executor-samples工程里面的项目,我们选择第二个springboot项目即可,当然,你也可以单独把这个项目摘取出来,我反正每次不去管它,没啥影响。
打开application.properties,需要修改的也就是调度中心的地址,因为执行器要注册到调度中心才能执行任务,其他的都是执行器的选填项,一般没必要不改就行。
- 同样的,检查完配置后启动这个springboot项目即可,也可以打成jar包发布。
启动后,一般过一会儿就会注册到调度中心,打开调度中心后台的执行器管理就能发现已经连上了。 - 至此,xxl-job实际上就搭建完成了,可以发现,作者从一开始就是想着开箱即用,所以非常简单。
使用
BEAN模式创建定时任务(重点)
- 直接在方法上贴
@XxlJob 注解创建任务,此处设置的值 在调度中心中创建任务的时候要根据这个值写入JobHandler 参数内 即可开启该任务的调度
- 效果演示
- 定时任务调度成功跑起来
GET/POST 定时调度方式请求接口
@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<String, String> reqMap) {
log.debug("[XXLJOB]>>>> 新增订单信息....reqMap={}", reqMap);
return "成功";
}
}
GET方式
- 打开任务管理,点击新增,然后按照图示配置即可,这里特别说明,JobHandler一栏必须填写httpJobHandler,这是xxl-job内置的handler,不能写错名称。传参就在url后面写即可
POST方式
- 和上面一样写法,唯一不同就是传参这里,post方式的data中参数对象传json格式,不能换行,要连着写,否则会报错。
- 启动测试项目两个接口,然后将调度中心我们新建的两个定时任务打开,看10秒和15秒后是不是分别开始执行两个测试接口。
|