--- theme: cyanosis --- **《从零打造项目》系列文章** > **工具** > > - [比MyBatis Generator更强大的代码生成器](https://juejin.cn/post/6952520736720289805) > > **ORM框架选型** > > - [SpringBoot项目基础设施搭建](https://juejin.cn/post/7166760176899325988) > - [SpringBoot集成Mybatis项目实操](https://juejin.cn/post/7168245119022268430) > - [SpringBoot集成Mybatis Plus项目实操](https://juejin.cn/post/7168731998549671967) > - [SpringBoot集成Spring Data JPA项目实操](https://juejin.cn/post/7169472183184719886) > > **数据库变更管理** > > - [数据库变更管理：Liquibase or Flyway](https://juejin.cn/post/7170857098538909732/) > - [SpringBoot结合Liquibase实现数据库变更管理](https://juejin.cn/post/7171232605478584328/) > > **定时任务框架** > > - [Java定时任务技术分析](https://juejin.cn/post/7171604341437136909) > - [SpringBoot结合Quartz实现定时任务](https://juejin.cn/post/7171955839517851678/) > - [SpringBoot结合XXL-JOB实现定时任务](https://juejin.cn/post/7172325382320816165) > > **缓存** > > - [Spring Security结合Redis实现缓存功能](https://juejin.cn/post/7177188004677550141) > > **安全框架** > > - [Java应用程序安全框架](https://juejin.cn/post/7173443126550822925) > - [Spring Security系列文章](https://juejin.cn/post/7173833497830752286/) > - [Spring Security结合JWT实现认证与授权](https://juejin.cn/post/7176803095525982269) > > **开发规范** > > - [后端必知：遵循Google Java规范并引入checkstyle检查](https://juejin.cn/post/7178683426852044858/) ## 前言上篇文章我们介绍了 Quartz 的使用，当时实现了两个简单的需求，不过最后我们总结的时候也提到 Quartz 有不少缺点，代码侵入太严重，所以本篇将介绍 xxl-job 这个定时任务框架。 ### Quartz的不足 Quartz 的不足：Quartz 作为开源任务调度中的佼佼者，是任务调度的首选。但是在集群环境中，Quartz采用API的方式对任务进行管理，这样存在以下问题： - 通过调用API的方式操作任务，不人性化。 - 需要持久化业务的 QuartzJobBean 到底层数据表中，系统侵入性相当严重。 - 调度逻辑和QuartzJobBean耦合在同一个项目中，这将导致一个问题，在调度任务数量逐渐增多，同时调度任务逻辑逐渐加重的情况下，此时调度系统的性能将大大受限于业务。 ### Xxl-job介绍官方说明：XXL-JOB 是一个轻量级分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。通俗来讲：XXL-JOB 是一个任务调度框架，通过引入 XXL-JOB 相关的依赖，按照相关格式撰写代码后，可在其可视化界面进行任务的**启动**，**执行**，**中止**以及包含了**日志记录与查询**和**任务状态监控**。更多详细介绍推荐阅读[官方文档](https://www.xuxueli.com/xxl-job/)。 ## 项目实践 ### Spring Boot集成XXL-JOB Spring Boot 集成 XXL-JOB 主要分为以下两步： 1. 配置运行调度中心（xxl-job-admin） 2. 配置运行执行器项目 xxl-job-admin 可以从源码仓库中下载代码，代码地址有两个： 1. GitHub：[https://github.com/xuxueli/xxl-job](https://link.zhihu.com/?target=https%3A//github.com/xuxueli/xxl-job) 2. Gitee：[http://gitee.com/xuxueli0323/xxl-job](https://link.zhihu.com/?target=http%3A//gitee.com/xuxueli0323/xxl-job) ![xxl-job项目源码结构](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/15845a3aff0c4373bc11effa9c63fe9e~tplv-k3u1fbpfcp-zoom-1.image) 下载完之后，在 `doc/db` 目录下有数据库脚本 `tables_xxl_job.sql`，执行下脚本初始化调度数据库 `xxl_job`，如下图所示： ![xxl-job数据表](https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/43bf21f8b0b542deaccab8c1e25a18bb~tplv-k3u1fbpfcp-zoom-1.image) ### 配置调度中心将下载的源码解压，用 IDEA 打开，我们需要修改一下 xxl-job-admin 中的一些配置。（我这里下载的是最新版 2.3.1） 1、修改 application.properties，主要是配置一下 datasource 以及 email，其他不需要改变。 ```properties ### xxl-job, datasource spring.datasource.url=jdbc:mysql://127.0.0.1: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 ### xxl-job, email spring.mail.host=smtp.qq.com spring.mail.port=25 spring.mail.username=1739468244@qq.com spring.mail.from=1739468244@qq.com # 此处不是邮箱登录密码，而是开启SMTP服务后的授权码 spring.mail.password=xxxxx ``` 2、修改 logback.xml，配置日志输出路径，我是在解压的 xxl-job-2.3.1 项目包中新建了一个 logs 文件夹。 ```xml ``` 然后启动项目，正常启动后，访问地址为：http://localhost:8080/xxl-job-admin，默认的账户为 admin，密码为 123456，访问后台管理系统后台。这样就表示调度中心已经搞定了，下一步就是创建执行器项目。 ### 创建执行器项目本项目与 Quartz 项目用的业务表和业务逻辑都一样，所以引入的依赖会比较多。 #### 环境配置 1、引入依赖： ```xml org.springframework.boot spring-boot-starter-parent 2.6.3 1.8 1.2.73 5.5.1 8.0.19 1.4.2.Final 1.18.20 1.1.18 1.6.9 org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-aop com.xuxueli xxl-job-core 2.3.1 com.baomidou mybatis-plus-boot-starter 3.5.1 com.baomidou mybatis-plus 3.5.1 mysql mysql-connector-java ${mysql.version} runtime com.alibaba druid-spring-boot-starter ${druid.version} org.projectlombok lombok 1.18.20 com.alibaba.fastjson2 fastjson2 2.0.12 org.mapstruct mapstruct ${org.mapstruct.version} org.mapstruct mapstruct-processor ${org.mapstruct.version} cn.hutool hutool-all ${hutool.version} org.springdoc springdoc-openapi-ui ${springdoc.version} org.springframework.boot spring-boot-maven-plugin ``` 2、application.yml 配置文件 ```yaml server: port: 9090 # xxl-job xxl: job: admin: addresses: http://127.0.0.1:8080/xxl-job-admin # 调度中心部署跟地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册； executor: appname: hresh-job-executor # 执行器 AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册 ip: # 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"； port: 6666 # ### 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口； logpath: /Users/xxx/xxl-job-2.3.1/logs/xxl-job # 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径； logretentiondays: 30 # 执行器日志文件保存天数 [选填] ：过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能； accessToken: default_token # 执行器通讯TOKEN [选填]：非空时启用； spring: application: name: xxl-job-practice datasource: type: com.alibaba.druid.pool.DruidDataSource driver-class-name: com.mysql.cj.jdbc.Driver url: jdbc:mysql://localhost:3306/xxl_job?serverTimezone=Hongkong&characterEncoding=utf-8&useSSL=false username: root password: root mybatis: mapper-locations: classpath:mapper/*Mapper.xml configuration: log-impl: org.apache.ibatis.logging.stdout.StdOutImpl lazy-loading-enabled: true ``` 上述 xxl-job 的 logpath 配置与调度中心的输出日志用的是同一个目录，accessToken 也与调度中心的 xxl.job.accessToken 一致。 #### 核心类 1、xxl-job 配置类 ```java @Configuration public class XxlJobConfig { @Value("${xxl.job.admin.addresses}") private String adminAddresses; @Value("${xxl.job.executor.appname}") private String appName; @Value("${xxl.job.executor.ip}") private String ip; @Value("${xxl.job.executor.port}") private int port; @Value("${xxl.job.accessToken}") private String accessToken; @Value("${xxl.job.executor.logpath}") private String logPath; @Value("${xxl.job.executor.logretentiondays}") private int logRetentionDays; @Bean public XxlJobSpringExecutor xxlJobExecutor() { // 创建 XxlJobSpringExecutor 执行器 XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor(); xxlJobSpringExecutor.setAdminAddresses(adminAddresses); xxlJobSpringExecutor.setAppname(appName); xxlJobSpringExecutor.setIp(ip); xxlJobSpringExecutor.setPort(port); xxlJobSpringExecutor.setAccessToken(accessToken); xxlJobSpringExecutor.setLogPath(logPath); xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays); // 返回 return xxlJobSpringExecutor; } } ``` 2、xxl-job 工具类 ```java @Component @RequiredArgsConstructor public class XxlUtil { @Value("${xxl.job.admin.addresses}") private String xxlJobAdminAddress; private final RestTemplate restTemplate; // 请求Url private static final String ADD_INFO_URL = "/jobinfo/addJob"; private static final String REMOVE_INFO_URL = "/jobinfo/removeJob"; private static final String GET_GROUP_ID = "/jobgroup/loadByAppName"; /** * 添加任务 * * @param xxlJobInfo * @param appName * @return */ public String addJob(XxlJobInfo xxlJobInfo, String appName) { Map params = new HashMap<>(); params.put("appName", appName); String json = JSONUtil.toJsonStr(params); String result = doPost(xxlJobAdminAddress + GET_GROUP_ID, json); JSONObject jsonObject = JSON.parseObject(result); Map map = (Map) jsonObject.get("content"); Integer groupId = (Integer) map.get("id"); xxlJobInfo.setJobGroup(groupId); String xxlJobInfoJson = JSONUtil.toJsonStr(xxlJobInfo); return doPost(xxlJobAdminAddress + ADD_INFO_URL, xxlJobInfoJson); } // 删除job public String removeJob(long jobId) { MultiValueMap map = new LinkedMultiValueMap(); map.add("id", String.valueOf(jobId)); return doPostWithFormData(xxlJobAdminAddress + REMOVE_INFO_URL, map); } /** * 远程调用 * * @param url * @param json */ private String doPost(String url, String json) { HttpHeaders headers = new HttpHeaders(); headers.setContentType(MediaType.APPLICATION_JSON); HttpEntity entity = new HttpEntity<>(json, headers); ResponseEntity responseEntity = restTemplate.postForEntity(url, entity, String.class); return responseEntity.getBody(); } private String doPostWithFormData(String url, MultiValueMap map) { HttpHeaders headers = new HttpHeaders(); headers.setContentType(MediaType.APPLICATION_FORM_URLENCODED); HttpEntity> entity = new HttpEntity<>(map, headers); ResponseEntity responseEntity = restTemplate.postForEntity(url, entity, String.class); return responseEntity.getBody(); } } ``` 此处我们利用 RestTemplate 来远程调用 xxl-job-admin 中的服务，从而实现动态创建定时任务，而不是局限于通过 UI 界面来创建任务。这里我们用到三个接口，都需要我们在 xxl-job-admin 中手动添加，这样在调用接口时，就不需要登录验证了，这就要求在定义接口时加上一个 `PermissionLimit`并设置 limit 为 false，那么这样就不用去登录就可以调用接口。 3、修改 JobGroupController，新增 loadByAppName 方法 ```java @RequestMapping("/loadByAppName") @ResponseBody @PermissionLimit(limit = false) public ReturnT loadByAppName(@RequestBody Map map) { XxlJobGroup jobGroup = xxlJobGroupDao.loadByAppName(map); return jobGroup != null ? new ReturnT(jobGroup) : new ReturnT(ReturnT.FAIL_CODE, null); } ``` XxlJobGroupDao 文件以及对应的 xml 文件 ```java XxlJobGroup loadByAppName(Map map); ``` ```xml ``` 4、修改 JobInfoController，增加 addJob 方法和 removeJob 方法 ```java @RequestMapping("/addJob") @ResponseBody @PermissionLimit(limit = false) public ReturnT addJob(@RequestBody XxlJobInfo jobInfo) { return xxlJobService.add(jobInfo); } @RequestMapping("/removeJob") @ResponseBody @PermissionLimit(limit = false) public ReturnT removeJob(String id) { return xxlJobService.remove(Integer.parseInt(id)); } ``` addJob 方法与 JobInfoController 文件中的 add 方法具体逻辑是一样的，只是换个接口名。 ```java @RequestMapping("/add") @ResponseBody public ReturnT add(XxlJobInfo jobInfo) { return xxlJobService.add(jobInfo); } ``` 至此，关于调度中心的修改就结束了。 5、XxlService 创建任务 ```java @Service @Slf4j @RequiredArgsConstructor public class XxlService { private final XxlUtil xxlUtil; @Value("${xxl.job.executor.appname}") private String appName; public void addJob(XxlJobInfo xxlJobInfo) { xxlUtil.addJob(xxlJobInfo, appName); long triggerNextTime = xxlJobInfo.getTriggerNextTime(); log.info("任务已添加，将在{}开始执行任务", DateUtils.formatDate(triggerNextTime)); } } ``` #### 业务代码 1、UserService，包括用户注册，给用户发送欢迎消息，以及发送天气温度通知。 ```java @Service @RequiredArgsConstructor @Slf4j public class UserService { private final UserMapper userMapper; private final UserStruct userStruct; private final WeatherService weatherService; private final XxlService xxlService; /** * 假设有这样一个业务需求，每当有新用户注册，则1分钟后会给用户发送欢迎通知. * * @param userRequest 用户请求体 */ @Transactional public void register(UserRequest userRequest) { if (Objects.isNull(userRequest) || isBlank(userRequest.getUsername()) || isBlank(userRequest.getPassword())) { BusinessException.fail("账号或密码为空！"); } User user = userStruct.toUser(userRequest); userMapper.insert(user); LocalDateTime scheduleTime = LocalDateTime.now().plusMinutes(1L); XxlJobInfo xxlJobInfo = XxlJobInfo.builder().jobDesc("定时给用户发送通知").author("hresh") .scheduleType("CRON").scheduleConf(DateUtils.getCron(scheduleTime)).glueType("BEAN") .glueType("BEAN") .executorHandler("sayHelloHandler") .executorParam(user.getUsername()) .misfireStrategy("DO_NOTHING") .executorRouteStrategy("FIRST") .triggerNextTime(DateUtils.toEpochMilli(scheduleTime)) .executorBlockStrategy("SERIAL_EXECUTION").triggerStatus(1).build(); xxlService.addJob(xxlJobInfo); } public void sayHelloToUser(String username) { if (StrUtil.isBlank(username)) { log.error("用户名为空"); } User user = userMapper.selectByUserName(username); String message = "Welcome to Java,I am hresh."; log.info(user.getUsername() + " , hello, " + message); } public void pushWeatherNotification() { List users = userMapper.queryAll(); log.info("执行发送天气通知给用户的任务。。。"); WeatherInfo weatherInfo = weatherService.getWeather(WeatherConstant.WU_HAN); for (User user : users) { log.info(user.getUsername() + "----" + weatherInfo.toString()); } } } ``` 2、WeatherService，获取天气温度等信息，这里就不贴代码了。 3、UserController，只有一个用户注册方法 ```java @RestController @RequiredArgsConstructor public class UserController { private final UserService userService; @PostMapping("/register") public Result