参考学习视频并特别鸣谢:https://www.bilibili.com/video/BV1QM411n75R/?spm_id_from=333.337.search-card.all.click
xxl-job入门实践
1 常见任务调度方案
- Timer
- ExectorService(执行器)
- Spring@scheduled(注解)
- quartz(第三方任务调度框架)
- xxljob
- elastic-job
后三个是分布式调度系统,elastic-job是基于quartz重构的系统
xxl-job原理
xxljob:分布式任务蒂埃杜平台,有调度中兴和执行器组成,调度中心提供一个web管理界面配置任务和执行器,调度中心通过rpc接口调用触发执行器运行。
特性:
- 高可用:集群部署,执行器可切换;保证数据的一致性,基于数据库的组件冲突,任务不会重复执行
- 弹性扩容:一旦有新执行器机器上线或者下线,下次调度时将会重新分配任务
- 日志
- 动态分片:假如有三个给每个执行器配置不同的参数,做到分片处理,与mapreduce思想一样
- 监控告警
架构
- xxl-job-admin:调度中心
- xxl-job-core:公共依赖
- xxl-job-executor-samples:执行器Sample示例(选择合适的版本执行器,可直接使用,也可以参考其并将现有项目改造成执行器)
- xxl-job-executor-sample-springboot:Springboot版本,通过Springboot管理执行器,推荐这种方式;
- xxl-job-executor-sample-frameless:无框架版本;
2 快速入门
2.1 下载源码、初始化调度数据库
略
2.2 编译源码
略
2.3 配置部署调度中心
2.3.1 调度中心配置
略
2.3.2 部署项目
略
2.4 配置部署执行器项目
2.4.1 添加Maven依赖
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.3.1</version>
</dependency>
2.4.2 执行器配置
spring.application.name=xxl-job-demo
server.port=8088
## 调度中心部署根地址【选项】:如果调度中心集群部署存在多个地址则用逗号分隔,执行器将会使用改地址进行“执行器心跳注册”和“任务结果回调”:为空则关闭自动注册;
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=127.0.0.1:9999
## 执行器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.logrententiondays=30
2.4.3 添加执行器配置
@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.logrententiondays}")
private int logRententionDays;
@Bean
public XxlJobSpringExecutor xxlJobSpringExecutor(){
XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
xxlJobSpringExecutor.setAccessToken(accessToken);
xxlJobSpringExecutor.setAppname(appname);
xxlJobSpringExecutor.setAddress(address);
xxlJobSpringExecutor.setIp(ip);
xxlJobSpringExecutor.setPort(port);
xxlJobSpringExecutor.setLogPath(logPath);
xxlJobSpringExecutor.setLogRetentionDays(logRententionDays);
return xxlJobSpringExecutor;
}
}
2.4.4 添加任务处理类
@Component
public class SimpleXxlJob {
@XxlJob("demoJobHandler")
public void demoJobHandler() throws Exception{
System.out.println("执行定时任务,执行时间:"+new Date());
}
}
2.5 运行HelloWorld程序
2.5.1 任务配置&触发执行
2.6 GLUE模式
bean模式:需要在程序中写一个xxljob注解
GLUE模式:项目上线,但想定期执行某段代码,但是不想项目下线
添加service
@Service
public class HelloService {
public void methodA(){
System.out.println("执行MethodA的方法");
}
public void methodB(){
System.out.println("执行methodB的方法");
}
}
编写内容如下:
package com.xxl.job.service.handler;
import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.handler.IJobHandler;
import cn.wolfcode.xxljobdemo.service.HelloService;
import org.springframework.beans.factory.annotation.Autowired;
public class DemoGlueJobHandler extends IJobHandler {
@Autowired
private HelloService helloService;
@Override
public void execute() throws Exception {
helloService.methodA();
}
}
遇到的问题:jdk版本过高导致annotation的相关jar包没有导入,程序运行失败,报错
Caused by: java.lang.ClassNotFoundException: javax.annotation.Resource
解决方法:在pom文件中主动导入annotation依赖
2.6 执行器集群
2.6.1 集群环境搭建
2.6.2 调度路由算法讲解
轮询:在几台执行器上轮流切换执行
3 分片功能讲解
3.1 案例需求讲解
需求:我们现在是先这样的需求,在指定节假日需要给平台的所有用户去发送祝福的短信
3.1.1 初始化数据
在数据库中导入xxl_job_demo.sql数据
3.1.2 集成Durid&Mybatis
<!-- Mybatis驱动-->
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.2.0</version>
</dependency>
<!-- mysql驱动-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.28</version>
</dependency>
<!-- lombok依赖-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.1.10</version>
</dependency>
添加配置
spring.datasource.url=jdbc:mysql://localhost:3306/xxl_job_demo?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.type=com.alibaba.druid.pool.DruidDataSource
添加实体类
@Setter@Getter
public class UserMobilePlan {
private Long id;//主键
private String username;//用户名
private String nickname;//昵称
private String phone;//手机号码
private String info;//备注
}
添加Mapper处理类
@Mapper
public interface UserMobilePlanMapper {
@Select("select * from t_user_mobile_plan")
List<UserMobilePlan> selectAll();
}
3.1.3 业务功能实现
任务处理方法实现
@XxlJob("sendMsgHandler")
public void sendMsgHandler() throws Exception{
List<UserMobilePlan> userMobilePlans = userMobilePlanMapper.selectAll();
System.out.println("任务开始时间:"+new Date()+",处理任务数量:"+userMobilePlans.size());
Long startTime = System.currentTimeMillis();
userMobilePlans.forEach(item->{
try {
//模拟发送短信动作
TimeUnit.MILLISECONDS.sleep(10);
}catch (InterruptedException e){
e.printStackTrace();
}
});
}
在前面加入
@Autowired
private UserMobilePlanMapper mobilePlanMapper;
在启动类中添加@MapperScan(basePackages = “com.example.xxljobdemo.mapper”)
任务信息配置
3.2 分片概念讲解
2000+条数据,如果不采取分片形式的话,任务只会在一台机器上执行,这样的话就需要20+秒才能执行完任务
如果采用分片广播的形式的话,一次任务调度将会广播触发对应集群中所有执行器执行一次任务,同时系统自动传递分片参数,可根据分片参数开发分片任务
获取分片参数方式:
//可参考Sample实力执行其中的示例任务“ShardingJobHandler”了解试用
int shardIndex = XxlJobHelper.getShardIndex();
int shardTotal = XxlJobHelper.getShardTotal();
通过这两个参数,我们可以通过求模取余的方式,分别查询,分别执行,这样的话就可以提高处理的速度
之前2000+条数据只在一台机器上执行需要20+秒才能完成任务,分片后,有两台机器可以共同完成2000+条数据,每台机器处理1000+条数据,这样的话只需要10+秒就能完成任务
3.3案例改造成任务分片
Mapper增加查询方法
@Mapper
public interface UserMobilePlanMapper {
@Select("select * from t_user_mobile_plan where mod(id,#{shardingTotal})=#{shardingIndex}")
List<UserMobilePlan> selectByMod(@Param("shardingIndex") Integer shardingIndex, @Param("shardingTotal")Integer shardingTotal);
@Select("select * from t_user_mobile_plan")
List<UserMobilePlan> selectAll();
}
任务类方法
@XxlJob("sendMsgHandler")
public void sendMsgHandler() throws Exception{
System.out.println("任务开始时间:"+new Date());
int shardTotal = XxlJobHelper.getShardTotal();//分片总数
int shardIndex = XxlJobHelper.getShardIndex();//分片索引
List<UserMobilePlan> userMobilePlans = null;
if(shardTotal==1){
//如果没有分片就直接查询所有数据
userMobilePlans = userMobilePlanMapper.selectAll();
}else{
userMobilePlans = userMobilePlanMapper.selectByMod(shardIndex,shardTotal);
}
System.out.println("处理任务数量:"+userMobilePlans.size());
Long startTime = System.currentTimeMillis();//获取当前的总毫秒数
userMobilePlans.forEach(item->{
try {
TimeUnit.MILLISECONDS.sleep(10);
}catch (InterruptedException e){
e.printStackTrace();
}
});
System.out.println("任务结束时间:"+new Date());
System.out.println("任务耗时:"+(System.currentTimeMillis()-startTime)+"毫秒");
}
案例
- 在秒杀项目中的pom文件中加入xxljob依赖
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.3.1</version>
</dependency>
- 添加xxljob的配置信息xxxx.yaml(根据application.properties修改)
xxl:
job:
admin:
addresses: http://127.0.0.1:8080/xxl-job-admin
accessToken: default_token
executor:
appname: seckill-executor
ip: 127.0.0.1
port: 9999
logpath: /data/applogs/xxl-job/jobhandler
logrententiondays: 30