xxl-job基本使用
标签: xxl-job基本使用 Java博客 51CTO博客
2023-07-14 18:24:15 116浏览
1、xxl-job 简介
xxl-job是一个轻量级的分布式任务调度系统。
2、快速入门
因为xxl-job需要在任务调度中心来控制各种任务的调度。所以我们需要先下载任务调度中心。地址: https://github.com/xuxueli/xxl-job
2.1 任务中心的项目结构:
doc:主要是包含xxl-job 的一些文档,包含初始化db需要的sql文件,以及官方的一些文档。
xxl-job-admin:任务调度中心
xxl-job-core:xxl-job的核心依赖
xxl-job-executor-samples:xxl-job 执行器的简单样例,包含使用springboot和不使用springboot的版本
2.2 下载项目源码
源码地址:https://github.com/xuxueli/xxl-job
2.3 初始化调度中心数据库
数据库初始化sql在 xxl-job/doc/db下边。
2.4 配置调度中心信息
### web
server.port=8112
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.10.25: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
### 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
spring.mail.username=xxx@qq.com
spring.mail.from=xxx@qq.com
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
xxl.job.admin.allowedOrigins=*
修改数据库的配置信息,以及调度中心的端口号等基本信息。
2.4.1 重要参数说明:
xxl.job.accessToke:这个token使用默认的即可,方便调度中心绑定对应的执行器
xxl.job.admin.allowedOrigins=*:解决跨域的问题
2.4.2 部署调度中心
导入项目之后使用maven进行打包等操作进行相关的部署。
调度中心访问地址:http://IP地址:端口号/xxl-job-admin
调度中心默认账号密码:admin/123456
2.5 添加配置执行器
2.5.1 在新建的springboot项目中,或者现成的项目中导入xxl-job 的核心依赖
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.3.1</version>
</dependency>
2.5.2 配置执行器的信息
xxl:
job:
accessToken: default_token
admin:
addresses: http://192.168.10.152:8112/xxl-job-admin
executor:
address: ''
appname: xxl-job-analysis-dev
ip: '192.168.10.35'
logpath: ./data/applogs/xxl-job/jobhandler
logretentiondays: 30
port: 9998
重要配置说明:
xxl.job.accessToken:这个值要和调度中心中配置的Token值相同,否则调度中心无法识别执行器。
xxl.job.executor.appname:执行器的名字,在注册中心中需要使用名字来注入对应的执行器。
xxl.job.executor.ip:执行器的IP地址,如果IP地址不对就无法执行对应任务。
2.5.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.logretentiondays}")
private int logRetentionDays;
@Bean
public XxlJobSpringExecutor xxlJobExecutor() {
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.5.6 添加任务处理类
@Service
@Slf4j
public class XxlJobBiz {
@XxlJob("xxlTest")
public void xxlTest() {
log.info("xxl-job测试");
}
}
@XxlJob("xxlTest"):使用这个注解可以添加任务处理类,交给Spring来进行管理。
2.6 运行首个xxl-job任务
2.6.1 添加执行器
点击新增之后填写对应的执行器的地址,名称等信息。
AppName:就是在执行器配置中填写的名称。
填写完成之后就可以在执行器列表中看到所有的执行器。
2.6.2 添加任务
选择相应的执行器点击新增就可以添加相应的定时任务。
填写相应的执行器等基础信息。
调度配置主要配置的是任务执行的方式,是定时执行还是其他的方式。
任务配置中是配置jobHandler运行的信息。JobHandler中填写的是执行器中用@XxlJob注解的方法。
好博客就要一起分享哦!分享海报
此处可发布评论
评论(0)展开评论
展开评论