本篇笔记是跟学 1小时掌握XXL-JOB分布式调度实战-带你掌握java定时任务框架-面试必问之后记录的笔记,希望各位支持原视频。
课程中的资料:课程资料
提取码:b7ku
我们可以思考一下下面业务场景的解决方案:
以上场景就是任务调度所需要解决的问题
任务调度是为了自动完成特定任务,在约定的特定时刻去执行任务的过程
使用Spring中提供的注解@Scheduled,也能实现调度的功能
在业务类中方法中贴上这个注解,然后在启动类上贴上@EnableScheduling
注解
@Scheduled(cron = "0/20 * * * * ? ")
public void doWork(){
//doSomething
}
感觉Spring给我们提供的这个注解可以完成任务调度的功能,好像已经完美解决问题了,为什么还需要分布式呢?
主要有如下这几点原因:
XXL-Job:是大众点评的分布式任务调度平台,是一个轻量级分布式任务调度平台, 其核心设计目标是开发迅速、学习简单、轻量级、易扩展。
大众点评目前已接入XXL-JOB,该系统在内部已调度约100万次,表现优异。
目前已有多家公司接入xxl-job,包括比较知名的大众点评,京东,优信二手车,360金融 (360),联想集团 (联想),易信 (网易)等等
官网地址 XXL-JOB官网
设计思想
将调度行为抽象形成“调度中心”公共平台,而平台自身并不承担业务逻辑,“调度中心”负责发起调度请求。
将任务抽象成分散的JobHandler,交由“执行器”统一管理,“执行器”负责接收调度请求并执行对应的JobHandler中业务逻辑。
因此,“调度”和“任务”两部分可以相互解耦,提高系统整体稳定性和扩展性;
调度中心代码:
源码下载地址:
https://github.com/xuxueli/xxl-job
https://gitee.com/xuxueli0323/xxl-job
请下载项目源码并解压,获取 “调度数据库初始化SQL脚本” 并执行即可。
“调度数据库初始化SQL脚本” 位置为:
/xxl-job-master/doc/db/tables_xxl_job.sql
解压源码,按照maven格式将源码导入IDE, 使用maven进行编译即可,源码结构如下:
修改xxl-job-admin
项目的配置文件application.properties
,把数据库账号密码配置上
### web
server.port=8080
server.servlet.context-path=/xxl-job-admin
### actuator
management.server.servlet.context-path=/actuator
management.health.mail.enabled=false
### resources
spring.mvc.servlet.load-on-startup=0
spring.mvc.static-path-pattern=/static/**
spring.resources.static-locations=classpath:/static/
### freemarker
spring.freemarker.templateLoaderPath=classpath:/templates/
spring.freemarker.suffix=.ftl
spring.freemarker.charset=UTF-8
spring.freemarker.request-context-attribute=request
spring.freemarker.settings.number_format=0.##########
### mybatis
mybatis.mapper-locations=classpath:/mybatis-mapper/*Mapper.xml
#mybatis.type-aliases-package=com.xxl.job.admin.core.model
### xxl-job, datasource
spring.datasource.url=jdbc:mysql://192.168.202.200:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=WolfCode_2017
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
### datasource-pool
spring.datasource.type=com.zaxxer.hikari.HikariDataSource
spring.datasource.hikari.minimum-idle=10
spring.datasource.hikari.maximum-pool-size=30
spring.datasource.hikari.auto-commit=true
spring.datasource.hikari.idle-timeout=30000
spring.datasource.hikari.pool-name=HikariCP
spring.datasource.hikari.max-lifetime=900000
spring.datasource.hikari.connection-timeout=10000
spring.datasource.hikari.connection-test-query=SELECT 1
spring.datasource.hikari.validation-timeout=1000
### xxl-job, email
spring.mail.host=smtp.qq.com
spring.mail.port=25
[email protected]
[email protected]
spring.mail.password=xxx
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory
### xxl-job, access token
xxl.job.accessToken=default_token
### xxl-job, i18n (default is zh_CN, and you can choose "zh_CN", "zh_TC" and "en")
xxl.job.i18n=zh_CN
## xxl-job, triggerpool max size
xxl.job.triggerpool.fast.max=200
xxl.job.triggerpool.slow.max=100
### xxl-job, log retention days
xxl.job.logretentiondays=30
运行XxlJobAdminApplication
程序即可。
调度中心访问地址:
http://localhost:8080/xxl-job-admin
默认登录账号 “admin/123456”, 登录后运行界面如下图所示。
至此“调度中心”项目已经部署成功。
新建项目
选择Spring Initializr
Group:cn.wolfcode
Artifact:xxl-job-demo
选择spring boot的版本和Spring Web
创建SpringBoot项目并且添加如下依赖:
<dependency>
<groupId>com.xuxueligroupId>
<artifactId>xxl-job-coreartifactId>
<version>2.3.1version>
dependency>
在配置文件中添加如下配置:
application.properties
### 调度中心部署根地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调";为空则关闭自动注册;
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
### 执行器通讯TOKEN [选填]:非空时启用;
xxl.job.accessToken=default_token
### 执行器AppName [选填]:执行器心跳注册分组依据;为空则关闭自动注册
xxl.job.executor.appname=xxl-job-executor-sample
### 执行器注册 [选填]:优先使用该配置作为注册地址,为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
xxl.job.executor.address=
### 执行器IP [选填]:默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册" 和 "调度中心请求并触发任务";
xxl.job.executor.ip=127.0.0.1
### 执行器端口号 [选填]:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口;
xxl.job.executor.port=9999
### 执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径;
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### 执行器日志文件保存天数 [选填] : 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能;
xxl.job.executor.logretentiondays=30
创建XxlJobConfig
配置对象:
XxlJobConfig.java
@Configuration
public class XxlJobConfig {
@Value("${xxl.job.admin.addresses}")
private String adminAddresses;
@Value("${xxl.job.accessToken}")
private String accessToken;
@Value("${xxl.job.executor.appname}")
private String appname;
@Value("${xxl.job.executor.address}")
private String address;
@Value("${xxl.job.executor.ip}")
private String ip;
@Value("${xxl.job.executor.port}")
private int port;
@Value("${xxl.job.executor.logpath}")
private String logPath;
@Value("${xxl.job.executor.logretentiondays}")
private int logRetentionDays;
@Bean
public XxlJobSpringExecutor xxlJobExecutor() {
XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
xxlJobSpringExecutor.setAppname(appname);
xxlJobSpringExecutor.setAddress(address);
xxlJobSpringExecutor.setIp(ip);
xxlJobSpringExecutor.setPort(port);
xxlJobSpringExecutor.setAccessToken(accessToken);
xxlJobSpringExecutor.setLogPath(logPath);
xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
return xxlJobSpringExecutor;
}
}
添加任务处理类,交给Spring容器管理,在处理方法上贴上@XxlJob
注解
SimpleXxlJob.java
@Component
public class SimpleXxlJob {
@XxlJob("demoJobHandler")
public void demoJobHandler() {
LocalDateTime now = LocalDateTime.now();
String format = now.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
System.out.println("执行完毕" + format);
}
}
运行启动类
运行后发现8080端口被占用了
修改application.properties,增加配置
重启启动类,发现此时是没有输出的
登录调度中心
http://localhost:8080/xxl-job-admin/jobgroup
配置内容如下:
注意JobHandler和注解中的值保持一致即可
新增后界面如下:
我们先执行一次
点击保存
我这里查看日志发现报错
报错信息
在网上查询了一下处理方法,原来是没有添加注解@Component
重启再执行,就看到控制台打印了
接着启动定时调度任务
会发现每隔5秒执行一次
任务以源码方式维护在调度中心,支持通过Web IDE在线更新,实时编译和生效,因此不需要指定JobHandler。
( “GLUE模式(Java)” 运行模式的任务实际上是一段继承自IJobHandler的Java类代码,它在执行器项目中运行,可使用@Resource/@Autowire注入执行器里中的其他服务.
我们在HelloService类中添加
@Service
public class HelloService {
public void methodA(){
System.out.println("执行MethodA的方法");
}
public void methodB(){
System.out.println("执行MethodB的方法");
}
}
重新启动该服务
假如我们现在想给这个方法A和B添加为定时任务,我们就可以采用glue的方式
添加任务配置
package com.xxl.job.service.handler;
import cn.wolfcode.xxljobdemo.service.HelloService;
import com.xxl.job.core.handler.IJobHandler;
import org.springframework.beans.factory.annotation.Autowired;
public class DemoGlueJobHandler extends IJobHandler {
@Autowired
private HelloService helloService;
@Override
public void execute() throws Exception {
helloService.methodA();
}
}
点击保存即可,添加上版本号
我们可以先执行一次尝试一下
控制台打印结果
那我们想调用B方法呢,只需要修改调度中心的代码,然后保存版本号
点击执行一次之后
启动并执行程序
修改执行器模块
在IDEA中设置SpringBoot项目运行开启多个集群
配置如下:
-Dserver.port=8089
启动两个SpringBoot程序,需要修改Tomcat端口和执行器端口
启动后发现报错
原因是tomcat的端口虽然不一样,但是执行器的端口冲突了
-Dserver.port=8088 -Dxxl.job.executor.port=9999
-Dserver.port=8089 -Dxxl.job.executor.port=9998
这时候就启动成功了,在调度中心可以看到,执行器有2台了
然后我们点击启动,看一下定时任务的执行效果在集群中是怎么样的
发现只在其中的一台服务器上执行,另一台不执行,这样保证了不会重复执行代码。
8089端口
8088端口
那这样的话,我们集群就没意义了啊,我们想到要调整成负载均衡的策略
我们先停止定时任务,然后编辑一下任务
重新启动,我们可以看到效果是,定时任务会在这两台机器中进行轮询的执行
当执行器集群部署时,提供丰富的路由策略,包括:
FIRST(第一个):固定选择第一个机器
LAST(最后一个):固定选择最后一个机器;
ROUND(轮询):依次的选择在线的机器发起调度
RANDOM(随机):随机选择在线的机器;
CONSISTENT_HASH(一致性HASH):
每个任务按照Hash算法固定选择某一台机器,且所有任务均匀散列在不同机器上。
LEAST_FREQUENTLY_USED(最不经常使用):使用频率最低的机器优先被选举;
LEAST_RECENTLY_USED(最近最久未使用):最久未使用的机器优先被选举;
FAILOVER(故障转移):按照顺序依次进行心跳检测,第一个心跳检测成功的机器选定为目标执行器并发起调度;
BUSYOVER(忙碌转移):按照顺序依次进行空闲检测,第一个空闲检测成功的机器选定为目标执行器并发起调度;
SHARDING_BROADCAST(分片广播):
广播触发对应集群中所有机器执行一次任务,同时系统自动传递分片参数;可根据分片参数开发分片任务;
需求:我们现在实现这样的需求,在指定节假日,需要给平台的所有用户去发送祝福的短信.
在数据库中导入xxl_job_demo.sql
数据
CREATE DATABASE xxl_job_demo;
USE xxl_job_demo;
在xxl-job-demo项目的pom.xml
添加依赖
<dependency>
<groupId>org.mybatis.spring.bootgroupId>
<artifactId>mybatis-spring-boot-starterartifactId>
<version>1.2.0version>
dependency>
<dependency>
<groupId>mysqlgroupId>
<artifactId>mysql-connector-javaartifactId>
<version>5.1.8version>
dependency>
<dependency>
<groupId>org.projectlombokgroupId>
<artifactId>lombokartifactId>
<scope>providedscope>
dependency>
<dependency>
<groupId>com.alibabagroupId>
<artifactId>druidartifactId>
<version>1.1.10version>
dependency>
在xxl-job-demo的application.properties中
添加配置
spring.datasource.url=jdbc:mysql://localhost:3306/xxl_job_demo?serverTimezone=GMT%2B8&useUnicode=true&characterEncoding=UTF-8
spring.datasource.driverClassName=com.mysql.jdbc.Driver
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
spring.datasource.username=root
spring.datasource.password=WolfCode_2017
UserMobilePlan
@Data
@AllArgsConstructor
@NoArgsConstructor
public class UserMobilePlan {
private Long id;//主键
private String username;//用户名
private String nickname;//昵称
private String phone;//手机号码
private String info;//备注
}
添加Mapper处理类
UserMobilePlanMapper
UserMobilePlanMapper接口
@Mapper
public interface UserMobilePlanMapper {
@Select("select * from t_user_mobile_plan")
List<UserMobilePlan> selectAll();
}
任务处理方法实现
修改SimpleXxlJob.java
@Autowired
private UserMobilePlanMapper userMobilePlanMapper;
@XxlJob("sendMsgHandler")
public void sendMsgHandler() throws Exception {
List<UserMobilePlan> userMobilePlans = userMobilePlanMapper.selectAll();
LocalDateTime now = LocalDateTime.now();
String format = now.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
System.out.println("任务开始时间:" + format + ",处理任务数量:" + userMobilePlans.size());
Long startTime = System.currentTimeMillis();
userMobilePlans.forEach(item -> {
try {
//模拟发送短信动作
TimeUnit.MILLISECONDS.sleep(10);
} catch (InterruptedException e) {
e.printStackTrace();
}
});
Long endTime = System.currentTimeMillis();
LocalDateTime now2 = LocalDateTime.now();
String format2 = now2.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
System.out.println("任务结束时间:" + format2);
System.out.println("任务耗时:" + (endTime - startTime) + "毫秒");
}
修改XxlJobDemoApplication.java
添加@MapperScan注解
@SpringBootApplication
@MapperScan(basePackages = "cn.wolfcode.xxljobdemo.mapper")
public class XxlJobDemoApplication {
public static void main(String[] args) {
SpringApplication.run(XxlJobDemoApplication.class, args);
}
}
之后启动程序
任务配置信息
新增任务,这里就不设置轮询了
启动任务
看一下控制台:我们花了31秒执行完
比如我们的案例中有2000+条数据,如果不采取分片形式的话,任务只会在一台机器上执行,这样的话需要20+秒才能执行完任务.
如果采取分片广播的形式的话,一次任务调度将会广播触发对应集群中所有执行器执行一次任务,同时系统自动传递分片参数;可根据分片参数开发分片任务;
修改任务为分片广播的形式
原理如下:
获取分片参数方式:
// 可参考Sample示例执行器中的示例任务"ShardingJobHandler"了解试用
int shardIndex = XxlJobHelper.getShardIndex();
int shardTotal = XxlJobHelper.getShardTotal();
修改SimpleXxlJob.java
@XxlJob("sendMsgHandler")
public void sendMsgHandler() throws Exception {
// 分片
// 可参考Sample示例执行器中的示例任务"ShardingJobHandler"了解试用
int shardIndex = XxlJobHelper.getShardIndex();
int shardTotal = XxlJobHelper.getShardTotal();
System.out.println("分片的总数:" + shardTotal + ",分片的索引:" + shardIndex);
}
修改完后重启服务
然后我们刷新一下调度中心,2台无误
然后启动祝福短信
执行结果如下:
通过这两个参数,我们可以通过求模取余的方式,分别查询,分别执行,这样的话就可以提高处理的速度。
之前2000+条数据只在一台机器上执行需要20+秒才能完成任务,分片后,有两台机器可以共同完成2000+条数据,每台机器处理1000+条数据,这样的话只需要10+秒就能完成任务
Mapper增加查询方法
修改UserMobilePlanMapper.java添加方法
@Mapper
public interface UserMobilePlanMapper {
@Select("select * from t_user_mobile_plan where mod(id,#{shardingTotal})=#{shardingIndex}")
List<UserMobilePlan> selectByMod(@Param("shardingTotal") Integer shardingTotal, @Param("shardingIndex") Integer shardingIndex);
}
任务类方法
@XxlJob("sendMsgHandler")
public void sendMsgHandler() throws Exception {
LocalDateTime now = LocalDateTime.now();
String format = now.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
System.out.println("任务开始时间:" + format);
int shardTotal = XxlJobHelper.getShardTotal();
int shardIndex = XxlJobHelper.getShardIndex();
List<UserMobilePlan> userMobilePlans = null;
if (shardTotal == 1) {
//如果没有分片就直接查询所有数据
userMobilePlans = userMobilePlanMapper.selectAll();
} else {
userMobilePlans = userMobilePlanMapper.selectByMod(shardTotal, shardIndex);
}
System.out.println("处理任务数量:" + userMobilePlans.size());
Long startTime = System.currentTimeMillis();
userMobilePlans.forEach(item -> {
try {
TimeUnit.MILLISECONDS.sleep(10);
} catch (InterruptedException e) {
e.printStackTrace();
}
});
Long endTime = System.currentTimeMillis();
LocalDateTime now2 = LocalDateTime.now();
String format2 = now.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
System.out.println("任务结束时间:" + format2);
System.out.println("任务耗时:" + (endTime - startTime) + "毫秒");
}
重启服务,再此启动,执行一次
查看IDEA控制台
8088端口
8089端口
我们现在做一个商品的定时上架功能
1.在秒杀项目中pom.xml添加xxl-job依赖
<dependency>
<groupId>com.xuxueligroupId>
<artifactId>xxl-job-coreartifactId>
<version>2.3.1version>
dependency>
2.添加xxl-job的配置信息
把原先application.properties配置文件变为application.yaml
一般是放到nacos配置中心
xxl:
job:
admin:
addresses: http://127.0.0.1:8080/xx1-job-admin
accessToken: default_token
executor:
appname: seckill-executor
ip: 127.0.0.1
port: 9999
logpath: /data/applogs/xxl-job/jobhandler
logretentiondays: 30
3.新建配置类
XxlJobConfig.java
@Configuration
public class XxlJobConfig {
@Value("${xxl.job.admin.addresses}")
private String adminAddresses;
@Value("${xxl.job.accessToken}")
private String accessToken;
@Value("${xxl.job.executor.appname}")
private String appname;
//@Value("${xxl.job.executor.address}")
//private String address;
@Value("${xxl.job.executor.ip}")
private String ip;
@Value("${xxl.job.executor.port}")
private int port;
@Value("${xxl.job.executor.logpath}")
private String logPath;
@Value("${xxl.job.executor.logretentiondays}")
private int logRetentionDays;
@Bean
public XxlJobSpringExecutor xxlJobExecutor() {
XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
xxlJobSpringExecutor.setAppname(appname);
//xxlJobSpringExecutor.setAddress(address);
xxlJobSpringExecutor.setIp(ip);
xxlJobSpringExecutor.setPort(port);
xxlJobSpringExecutor.setAccessToken(accessToken);
xxlJobSpringExecutor.setLogPath(logPath);
xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
return xxlJobSpringExecutor;
}
}
输入AppName:seckill-executor
名称:秒杀服务
注册方式:自动注册
启动SeckillApplication,查看执行管理器
5.添加执行器的代码逻辑即可
修改SimpleXxlJob
@Component
public class SimpleXxlJob {
@XxlJob("seckillProductCacheHandler")
public void demoJobHandler() throws Exception {
LocalDateTime now = LocalDateTime.now();
String format = now.format(DateTimeFormatter.ofPattern("yyyy-MM-dd HH:mm:ss"));
System.out.println("执行完毕" + format);
}
}
6.配置任务管理
新增任务
配置如下:
7.修改代码逻辑即可
SimpleXxlJob 添加方法
@Autowired
private ISeckillProductService seckillProductService;
@Autowired
private StringRedisTemplate redisTemplate;
@Xx1Job("seckillProductCacheHandler")
public void seckillProductCacheHandler(){
//查询当天的秒杀商品数据
List<SeckillProductVo> vos_10 = seckillProductService. queryByTime(10);
syncToRedis(10, vos_10) ;
List<SeckillProductVo> vos_12 = seckillProduc tService. queryByTime(12) ;
syncToRedis(12, vos_12);
List<SeckillProductVo> vos_14 = seckillProductService. queryByTime(14) ;
syncToRedis(14, vos_14);
}
public void syncToRedis(Integer time, List<SeckillProductVo> vos) {
String key = SeckillRedisKey.SECKILL_PRODUCT_HASH.getRealKey(time+"");
// 删除之前的数据
redisTemplate.delete(key);
for(SeckillProductVo vo:vos){
redisTemplate.opsForHash().put(key,vo.getId()+"",JSON.toJSONString(vo));
}
}