xxl-job

-doc 各种文档，包括最重要的sql

-xxl-job-admin xxl调度中心

-xxl-job-core xxl核心依赖

-xxl-job-executor-samples xxl执行器示例

-xxl-job-executor-sample-frameless 无框架版

-xxl-job-executor-sample-springboot springboot版

创建数据库

执行/xxl-job/doc/db/tables_xxl_job.sql

调度中心

调度中心是所有执行器的控制管理中心，管理着所有“注册”在调度中心的执行器。

修改配置

修改数据库地址，需要的话配置一下邮箱。其他如端口、应用名，自己确认需要改不。

### 调度中心JDBC链接：链接地址请保持和 2.1章节 所创建的调度数据库的地址一致
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_pwd
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
### 报警邮箱
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=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
### 调度中心通讯TOKEN [选填]：非空时启用；
xxl.job.accessToken=
### 调度中心国际化配置 [必填]： 默认为 "zh_CN"/中文简体, 可选范围为 "zh_CN"/中文简体, "zh_TC"/中文繁体 and "en"/英文；
xxl.job.i18n=zh_CN
## 调度线程池最大线程配置【必填】
xxl.job.triggerpool.fast.max=200
xxl.job.triggerpool.slow.max=100
### 调度中心日志表数据保存天数 [必填]：过期日志自动清理；限制大于等于7时生效，否则, 如-1，关闭自动清理功能；
xxl.job.logretentiondays=30

另外建议修改日志路径

1	<property name="log.path" value="logs/xxl-job/xxl-job-admin.log"/>

启动

现在本地启动一下，看有没有问题，如果正常启动，访问:http://localhost:8080/xxl-job-admin也没有问题，那么准备部署吧。

部署

jar包部署，Docker镜像部署都可以，我这里是Docker镜像部署方式，有需要的可以参考，用官方的镜像也是不错的选择！

FROM openjdk:8-jre-slim
MAINTAINER wnhyang

# 创建目录
RUN mkdir -p /home/app
# 指定路径
WORKDIR /home/app

ENV PARAMS=""

ENV TZ=PRC JAVA_OPTS="-Xms128m -Xmx256m -Djava.security.egd=file:/dev/./urandom"

RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone

ADD target/xxl-job-admin-*.jar app.jar

EXPOSE 8803

ENTRYPOINT ["sh","-c","java -jar $JAVA_OPTS app.jar $PARAMS"]

怎么流程化部署看自己的需要了，可以传包到服务器，再通过docker build -t构建镜像并启动，也可以通过自动化，流水线类似的做CI/CD。

执行器

可以先学习一下官方的示例，我就不啰嗦了，直接在自己的项目中集成。

pom

引入xxl-job-core依赖

<dependency>
  	<groupId>com.xuxueli</groupId>
  	<artifactId>xxl-job-core</artifactId>
  	<version>${xxl-job.version}</version>
</dependency>

配置

注意调度中心地址、token，ip和端口看情况，我是用的默认的，如果之后要docker部署，那么一定记得开放对应端口，日志目录我也改为了自己统一的目录了。

### 调度中心部署根地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
xxl.job.admin.addresses=http://ip:8083/xxl-job-admin
### 执行器通讯TOKEN [选填]：非空时启用；
xxl.job.accessToken=default_token
### 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
xxl.job.executor.appname=${spring.application.name}
### 执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
xxl.job.executor.address=
### 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；
xxl.job.executor.ip=
### 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
xxl.job.executor.port=9999
### 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
xxl.job.executor.logpath=logs/xxl-job/jobhandler
### 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
xxl.job.executor.logretentiondays=30

组件配置

@Configuration
public class XxlJobConfig {

		@Bean
    public XxlJobSpringExecutor xxlJobExecutor() {
        logger.info(">>>>>>>>>>> xxl-job config init.");
        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;
    }
}

自己的执行器

@Component
@RequiredArgsConstructor
public class MyXxlJob {
    private static final Logger LOGGER = LoggerFactory.getLogger(MyXxlJob.class);

    private final LinkMapMapper linkMapMapper;

    @XxlJob("emailJobHandler")
    public void emailJobHandler() {
        LOGGER.info("emailJobHandler exec......");
        XxlJobHelper.log("XXL-JOB, emailJobHandler.");
        LocalDate now = LocalDate.now();
        LocalDate now3 = now.plusDays(3);
        List<LinkMap> linkMaps = linkMapMapper.selectList(new LambdaQueryWrapper<LinkMap>()
                .ge(LinkMap::getExpireTime, now)
                .le(LinkMap::getExpireTime, now3));
        XxlJobHelper.log(linkMaps.toString());
    }
}

部署

部署方式任意，一定要注意，Docker部署方式，一定要开放对应的端口后运行。

配置执行器

在调度中心-执行器管理，配置执行器。

AppName: 是每个执行器集群的唯一标示AppName, 执行器会周期性以AppName为对象进行自动注册。可通过该配置自动发现注册成功的执行器, 供任务调度时使用;

名称: 执行器的名称, 因为AppName限制字母数字等组成,可读性不强, 名称为了提高执行器的可读性;

注册方式：调度中心获取执行器地址的方式；

自动注册：执行器自动进行执行器注册，调度中心通过底层注册表可以动态发现执行器机器地址；

手动录入：人工手动录入执行器的地址信息，多地址逗号分隔，供调度中心使用；

机器地址："注册方式"为"手动录入"时有效，支持人工维护执行器的地址信息；

注意⚠️：当执行器是Docker部署时调度中心获取执行器机器地址会是docker分配的虚地址，后面任务执行时会出错，如下。所以当使用docker部署时直接配置宿主机地址。

github上也有相关issues，如果你有好的解决办法请务必告诉我。

https://github.com/xuxueli/xxl-job/issues/1121

https://github.com/xuxueli/xxl-job/issues/191

xxl-job remoting error(Connection refused (Connection refused)), for url : http://172.17.0.2:9999/run

任务

配置

配置中心-任务管理，配置任务，参考官方配置说明即可。

基础配置： - 执行器：任务的绑定的执行器，任务触发调度时将会自动发现注册成功的执行器, 实现任务自动发现功能; 另一方面也可以方便的进行任务分组。每个任务必须绑定一个执行器, 可在 "执行器管理" 进行设置; - 任务描述：任务的描述信息，便于任务管理； - 负责人：任务的负责人； - 报警邮件：任务调度失败时邮件通知的邮箱地址，支持配置多邮箱地址，配置多个邮箱地址时用逗号分隔；触发配置： - 调度类型：无：该类型不会主动触发调度； CRON：该类型将会通过CRON，触发任务调度；固定速度：该类型将会以固定速度，触发任务调度；按照固定的间隔时间，周期性触发；固定延迟：该类型将会以固定延迟，触发任务调度；按照固定的延迟时间，从上次调度结束后开始计算延迟时间，到达延迟时间后触发下次调度； - CRON：触发任务执行的Cron表达式； - 固定速度：固定速度的时间间隔，单位为秒； - 固定延迟：固定延迟的时间间隔，单位为秒；任务配置： - 运行模式： BEAN模式：任务以JobHandler方式维护在执行器端；需要结合 "JobHandler" 属性匹配执行器中任务； GLUE模式(Java)：任务以源码方式维护在调度中心；该模式的任务实际上是一段继承自IJobHandler的Java类代码并 "groovy" 源码方式维护，它在执行器项目中运行，可使用@Resource/@Autowire注入执行器里中的其他服务； GLUE模式(Shell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "shell" 脚本； GLUE模式(Python)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "python" 脚本； GLUE模式(PHP)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "php" 脚本； GLUE模式(NodeJS)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "nodejs" 脚本； GLUE模式(PowerShell)：任务以源码方式维护在调度中心；该模式的任务实际上是一段 "PowerShell" 脚本； - JobHandler：运行模式为 "BEAN模式" 时生效，对应执行器中新开发的JobHandler类“@JobHandler”注解自定义的value值； - 执行参数：任务执行所需的参数；
高级配置： - 路由策略：当执行器集群部署时，提供丰富的路由策略，包括； FIRST（第一个）：固定选择第一个机器； LAST（最后一个）：固定选择最后一个机器； ROUND（轮询）：； RANDOM（随机）：随机选择在线的机器； CONSISTENT_HASH（一致性HASH）：每个任务按照Hash算法固定选择某一台机器，且所有任务均匀散列在不同机器上。 LEAST_FREQUENTLY_USED（最不经常使用）：使用频率最低的机器优先被选举； LEAST_RECENTLY_USED（最近最久未使用）：最久未使用的机器优先被选举； FAILOVER（故障转移）：按照顺序依次进行心跳检测，第一个心跳检测成功的机器选定为目标执行器并发起调度； BUSYOVER（忙碌转移）：按照顺序依次进行空闲检测，第一个空闲检测成功的机器选定为目标执行器并发起调度； SHARDING_BROADCAST(分片广播)：广播触发对应集群中所有机器执行一次任务，同时系统自动传递分片参数；可根据分片参数开发分片任务； - 子任务：每个任务都拥有一个唯一的任务ID(任务ID可以从任务列表获取)，当本任务执行结束并且执行成功时，将会触发子任务ID所对应的任务的一次主动调度。 - 调度过期策略： - 忽略：调度过期后，忽略过期的任务，从当前时间开始重新计算下次触发时间； - 立即执行一次：调度过期后，立即执行一次，并从当前时间开始重新计算下次触发时间； - 阻塞处理策略：调度过于密集执行器来不及处理时的处理策略；单机串行（默认）：调度请求进入单机执行器后，调度请求进入FIFO队列并以串行方式运行；丢弃后续调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，本次请求将会被丢弃并标记为失败；覆盖之前调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，将会终止运行中的调度任务并清空队列，然后运行本地调度任务； - 任务超时时间：支持自定义任务超时时间，任务运行超时将会主动中断任务； - 失败重试次数；支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；

我的配置如下