xxljob 配置文件_xxl-job搭建、部署、SpringBoot集成xxl-job

一、搭建xxl-job

1、下载xxl-job代码

2、执行SQL

在数据库执行   \xxl-job\doc\db\tables_xxl_job.sql

3、导入idea

导入已存在的模块：File--New--Module from Existing Sources...

选择pom文件，直接导入

4、修改配置文件

修改配置文件：xxl-job\xxl-job-admin\src\main\resources\application.properties

调整数据库连接、控制台用户名密码等内容

此处特别说明一点，邮箱配置的password并不是邮箱密码，而是邮箱的授权码(授权码获取步骤自己百度)，如果配置成邮箱密码，当定时任务异常需要发邮件时，会出现邮件发送535错误。

### 调度中心项目的端口号以及访问路径

server.port=8081server.context-path=/xxl-job-admin

### 配置静态文件的前缀

spring.mvc.static-path-pattern=/static/**spring.resources.static-locations=classpath:/static/

### 配置模板文件

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的mapper文件地址

mybatis.mapper-locations=classpath:/mybatis-mapper/*Mapper.xml

### 配置数据库的地址

spring.datasource.url=jdbc:mysql://***:3306/xxl_job?Unicode=true&characterEncoding=UTF-8

spring.datasource.username=root

spring.datasource.password=123456

spring.datasource.driver-class-name=com.mysql.jdbc.Driver

spring.datasource.type=org.apache.tomcat.jdbc.pool.DataSource

spring.datasource.tomcat.max-wait=10000

spring.datasource.tomcat.max-active=30

spring.datasource.tomcat.test-on-borrow=true

spring.datasource.tomcat.validation-query=SELECT 1

spring.datasource.tomcat.validation-interval=30000

### 配置报警邮箱

spring.mail.host=smtp.qq.com

spring.mail.port=25

[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

### 调度中心通讯TOKEN，非空时启用

xxl.job.accessToken=

### 调度中心国际化设置，默认为中文版本，值设置为“en”时切换为英文版本 xxl-job, i18n (default empty as chinese, "en" as english)

xxl.job.i18n=

### 7、管理界面的登录用户名密码

xxl.job.login.username=admin

xxl.job.login.password=123456

5、启动项目

运行main函数，访问  http://localhost:8081/xxl-job-admin/toLogin  ，输入用户名密码(在application.properties中配置的)，登陆，到此为止，xxl-job项目部署成功。

二、项目中使用xxl-job

1、导入xxl-job依赖

com.xuxueli

xxl-job-core

2.0.2

2、配置文件中(application.yml)配置xxl-job配置

其中appname为项目名

xxl:

job:

accessToken:

executor:

appname: demo

ip:

logpath: /data/applogs/xxl-job/jobhandler

logretentiondays: -1

port: 9999

admin:

addresses: http://localhost:8081/xxl-job-admin

3、添加xxl-job配置类

直接复制，无需更改。

packagecom.example.demo.config;importcom.xxl.job.core.executor.impl.XxlJobSpringExecutor;importlombok.extern.slf4j.Slf4j;importorg.springframework.beans.factory.annotation.Value;importorg.springframework.context.annotation.Bean;importorg.springframework.context.annotation.Configuration;

@Slf4j

@Configurationpublic classXXlJobConfig {

@Value("${xxl.job.admin.addresses}")privateString adminAddresses;

@Value("${xxl.job.executor.appname}")privateString appName;

@Value("${xxl.job.executor.ip}")privateString ip;

@Value("${xxl.job.executor.port}")private intport;

@Value("${xxl.job.accessToken}")privateString accessToken;

@Value("${xxl.job.executor.logpath}")privateString logPath;

@Value("${xxl.job.executor.logretentiondays}")private intlogRetentionDays;

@Bean(initMethod= "start", destroyMethod = "destroy")publicXxlJobSpringExecutor xxlJobExecutor() {

log.info(">>>>>>>>>>> xxl-job config init.");

XxlJobSpringExecutor xxlJobSpringExecutor= newXxlJobSpringExecutor();

xxlJobSpringExecutor.setAdminAddresses(adminAddresses);

xxlJobSpringExecutor.setAppName(appName);

xxlJobSpringExecutor.setIp(ip);

xxlJobSpringExecutor.setPort(port);

xxlJobSpringExecutor.setAccessToken(accessToken);

xxlJobSpringExecutor.setLogPath(logPath);

xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);returnxxlJobSpringExecutor;

}

}

4、定时任务控制器

(1)定时任务实现类

此处模拟一个最简单的打印输出

packagecom.example.demo.service;importorg.springframework.stereotype.Service;

@Servicepublic classDemoJobService {public voiddemoTest(String s1){

System.out.println("==============" +s1);

}

}

(2)handler

此处注解非常重要。

packagecom.example.demo.handler;importcom.example.demo.service.DemoJobService;importcom.xxl.job.core.biz.model.ReturnT;importcom.xxl.job.core.handler.IJobHandler;importcom.xxl.job.core.handler.annotation.JobHandler;importcom.xxl.job.core.log.XxlJobLogger;importlombok.RequiredArgsConstructor;importlombok.extern.slf4j.Slf4j;importorg.springframework.stereotype.Component;

@JobHandler(value= "demoHandler")

@Component

@Slf4j

@RequiredArgsConstructorpublic class DemoHandler extendsIJobHandler {private finalDemoJobService demoJobService;

@Overridepublic ReturnT execute(String s1) throwsException {

XxlJobLogger.log("xxl-job测试任务开始执行。【args: {}】", s1);try{

demoJobService.demoTest(s1);

XxlJobLogger.log("xxl-job测试任务执行结束。");returnSUCCESS;

}catch(Exception e) {

XxlJobLogger.log("xxl-job测试任务执行出错!", e);returnFAIL;

}

}

}

至此，使用xxl-job的项目配置处理完毕。

三、定时任务执行配置

1、执行器配置

登陆xxl-job控制台后，点击执行器管理------新增执行器。

执行器中内容：

AppName：在使用xxl-job项目中配置的appname(见第二步中的第2点)

名称：随便填写(由于可能会多个项目同时使用xxl-job，因此建议一个项目一个执行器，且执行器名称直接可以看出是哪个项目)

排序：1

注册方式：自动注入

机器地址：空(xxl-job会自动扫描识别地址)

2、定时任务配置

任务管理---新增

任务中内容：

执行器：选择指定的执行器

任务描述：定时任务的名称

路由策略：可以根据自己的需要选择(一般选择轮询)

FIRST(第一个)：固定选择第一个机器

LAST(最后一个)：固定选择最后一个机器

ROUND(轮询)：轮询执行

RANDOM(随机)：随机选择在线的机器；

CONSISTENT_HASH(一致性HASH)：每个任务按照Hash算法固定选择某一台机器，且所有任务均匀散列在不同机器上。

LEAST_FREQUENTLY_USED(最不经常使用)：使用频率最低的机器优先被选举；

LEAST_RECENTLY_USED(最近最久未使用)：最久为使用的机器优先被选举

FAILOVER(故障转移)：按照顺序依次进行心跳检测，第一个心跳检测成功的机器选定为目标执行器并发起调度；

BUSYOVER(忙碌转移)：按照顺序依次进行空闲检测，第一个空闲检测成功的机器选定为目标执行器并发起调度；

SHARDING_BROADCAST(分片广播)：广播触发对应集群中所有机器执行一次任务，同时系统自动传递分片参数；可根据分片参数开发分片任务；

Cron：定时任务执行时间(此处测试是每秒执行一次，所以配置的* * * * * ?)

运行模式：可根据自己需要选择(一般选择BEGAN)

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：定时任务中@JobHandler注解中的配置

阻塞处理策略：根据自己需要选择(一般选择单机串行)

单机串行(默认)：调度请求进入单机执行器后，调度请求进入FIFO队列并以串行方式运行；

弃后续调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，本次请求将会被丢弃并标记为失败；

覆盖之前调度：调度请求进入单机执行器后，发现执行器存在运行的调度任务，将会终止运行中的调度任务并清空队列，然后运行本地调度任务；

子任务ID：每个任务都拥有一个唯一的任务ID(任务ID可以从任务列表获取)，当本任务执行结束并且执行成功时，将会触发子任务ID所对应的任务的一次主动调度。一般为空。

任务超时时间：支持自定义任务超时时间，任务运行超时将会主动中断任务

失败重试次数；支持自定义任务失败重试次数，当任务失败时将会按照预设的失败重试次数主动进行重试；

报警邮件：任务调度失败时邮件通知的邮箱地址，支持配置多邮箱地址，配置多个邮箱地址时用逗号分隔；

负责人：任务的负责人

执行参数：任务执行所需的参数，多个参数时用逗号分隔，任务执行时将会把多个参数转换成数组传入；

3、测试

点击操作，执行一次，然后查看日志，看是否执行成功

此处显示执行成功，然后可以在操作按钮下正式启动定时任务。

开启定时任务后，可见后台在持续执行(按照配置的一秒输出一次)

校验失败通知和重试次数：

在实现类中添加代码：int k = 10/0;

查看执行日志，失败了6次(原因是调度平台配置了失败后重试5次)

在看调度平台中配置的异常警告邮件，也是有6次告警。这里可以将异常抛出，并在告警邮件中展示。

四、在docker上部署xxl-job

1、打包xxl-job-admin

2、在服务器中创建xxl-job文件夹： mkdir /usr/data/xxl-job

3、进入新创建的xxl-job文件夹，新建一个dockerfile文件，编辑文件

# Docker image forspringboot file run

# VERSION0.0.1# Author: eangulee

# 基础镜像使用java

FROM java:8# 作者

MAINTAINER lcl# VOLUME 指定了临时文件目录为/tmp。

# 其效果是在主机/var/lib/docker 目录下创建了一个临时文件，并链接到容器的/tmp

VOLUME/tmp

# 将jar包添加到容器中并更名为app.jar，此处的jar包名称一定要与要部署的jar包名称一致

ADD xxl-job-admin-2.1.1-SNAPSHOT.jar app.jar# 运行jar包

RUN bash-c 'touch /app.jar'ENTRYPOINT ["java","-Djava.security.egd=file:/dev/./urandom","-jar","/app.jar"]

命令详解：

FROM：基础镜像名称

MAINTAINER：作者信息

VOLUME：数据挂载

ADD：项目的 jar 文件作为 “app.jar” 添加到容器的 ENTRYPOINT 执行项目 app.jar

ENTRYPOINT：指定容器启动时需要执行的命令(为了缩短 Tomcat 启动时间，添加一个系统属性指向 “/dev/./urandom” 作为 Entropy Source 如果是第一次打包，它会自动下载java 8的镜像作为基础镜像，以后再制作镜像的时候就不会再下载了)

4、将xxl-job-admin.jar上传至xxl-job文件夹

5、构建新的镜像

docker build -t xxl-job-admin .    (后面的.一定不要遗漏)

6、使用xxl-job-admin镜像启动新容器

docker run -d -p 8081:8081 xxl-job-admin

-d：后台运行

-p：端口映射

7、验证

五、调整项目配置

更改第二步第2点中的xxl-job地址

六、按照第三步重新配置定时任务即可。