2.快速入门
2.1 下载源码
a.源码下载地址:
github地址
gitee地址
2.2.环境搭建:
a.初始化调度数据库:
- 1.请下载项目源码并解压,获取 “调度数据库初始化SQL脚本” 并执行即可
b.编译源码:
- 1.解压源码,按照maven格式将源码导入IDE, 使用maven进行编译即可,源码结构如下:
2.3.置部署调度中心
a.调度中心配置:
- 1.修改
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
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
b.部署项目
- 1.运行
XxlJobAdminApplication
程序即可.- 调度中心访问地址: http://localhost:8080/xxl-job-admin
- 默认登录账号 “admin/123456”, 登录后运行界面如下图所示。
至此“调度中心”项目已经部署成功
2.4 配置部署执行器项目
a.添加Maven依赖
- 1.创建SpringBoot项目并且添加如下依赖:
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.3.1</version>
</dependency>
b.执行器配置
- 1.在配置文件中添加如下配置:
### 调度中心部署根地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调";为空则关闭自动注册;
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
c.添加执行器配置
- 1.创建
XxlJobConfig
配置对象:
@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;
}
}
d.添加任务处理类
- 1.添加任务处理类,交给Spring容器管理,在处理方法上贴上
@XxlJob
注解
@Component
public class SimpleXxlJob {
@XxlJob("demoJobHandler")
public void demoJobHandler() throws Exception {
System.out.println("执行定时任务,执行时间:"+new Date());
}
}
2.5 运行HelloWorld程序:
a.执行器管理:
b.任务配置&触发执行
- 1.登录调度中心,在任务管理中新增任务,配置内容如下:
- 2.新增后界面如下:
- 3.接着启动定时调度任务
c.查看日志
- 1.在调度中心的调度日志中就可以看到,任务的执行结果.
- 2.管控台也可以看到任务的执行信息.
2.6 GLUE模式(Java):
a.概念:
- 1.任务以源码方式维护在调度中心,支持通过Web IDE在线更新,实时编译和生效,因此不需要指定JobHandler
- 2.( “GLUE模式(Java)” 运行模式的任务
实际上是一段继承自IJobHandler的Java类代码,它在执行器项目中运行
,可使用@Resource/@Autowire注入执行器里中的其他服务
b.案例实现:
- 1.添加Service:
@Service public class HelloService { public void methodA(){ System.out.println("执行MethodA的方法"); } public void methodB(){ System.out.println("执行MethodB的方法"); } }
上述项目已经上线,但是后来想让他每隔十分钟来执行一次,然后页不想下线项目,那么可以就通过如下方式进行实现:
- 2.添加任务配置:
- 3.通过GLUE IDE在线编辑代码:
- 4.编写内容如下:
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();
}
}
- 5.启动并执行程序
2.7.执行器集群
a.集群环境搭建
- 1.在IDEA中设置SpringBoot项目运行开启多个集群
- 2.启动两个SpringBoot程序,需要修改Tomcat端口和执行器端口
- Tomcat端口8090程序的命令行参数如下:
-Dserver.port=8090 -Dxxl.job.executor.port=9998
- Tomcat端口8090程序的命令行参数如下:
-Dserver.port=8091 -Dxxl.job.executor.port=9999
- 3.在任务管理中,修改路由策略,修改成
轮询
- 4.重新启动,我们可以看到效果是,定时任务会在这两台机器中进行轮询的执行
- 8090端口的控制台日志如下:
- 8091端口的控制台日志如下:
- 8090端口的控制台日志如下:
b.调度路由算法讲解:
当执行器集群部署时,提供丰富的路由策略,包括:
FIRST(第一个):固定选择第一个机器
LAST(最后一个):固定选择最后一个机器;
ROUND(轮询):依次的选择在线的机器发起调度
RANDOM(随机):随机选择在线的机器;
CONSISTENT_HASH(一致性HASH):
每个任务按照Hash算法固定选择某一台机器,且所有任务均匀散列在不同机器上。
LEAST_FREQUENTLY_USED(最不经常使用):使用频率最低的机器优先被选举;
LEAST_RECENTLY_USED(最近最久未使用):最久未使用的机器优先被选举;
FAILOVER(故障转移):按照顺序依次进行心跳检测,第一个心跳检测成功的机器选定为目标执行器并发起调度;
BUSYOVER(忙碌转移):按照顺序依次进行空闲检测,第一个空闲检测成功的机器选定为目标执行器并发起调度;
SHARDING_BROADCAST(分片广播):
广播触发对应集群中所有机器执行一次任务,同时系统自动传递分片参数;可根据分片参数开发分片任务;