XXL-JOB是一个分布式任务调度平台，其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用
文档地址中文文档English documentation 源码仓库地址
| 源码仓库地址 | Release Download |
|---|---|
| https://github.com/xuxueli/xxl-job | Download |
| http://gitee.com/xuxueli0323/xxl-job | Download |
二、运行 xxl-jobcom.xuxueli xxl-job-core ${最新稳定版本}
我们先把 xxl-job 跑起来，再写我们自己的代码。
首先我们先把 xxl-job 的代码搞下来，地址：
https://github.com/xuxueli/xxl-job
然后用 IDEA 打开项目，打开之后，有四个主要的文件夹：
xxl-job-admin：调度中心 xxl-job-core：公共依赖 xxl-job-executor-samples：执行器Sample示例（选择合适的版本执行器，可直接使用，也可以参考其并将现有项目改造成执行器） ：xxl-job-executor-sample-springboot：Springboot版本，通过Springboot管理执行器，推荐这种方式； ：xxl-job-executor-sample-frameless：无框架版本；
由于 xxl-job 运行需要数据库，所以接下来我们就来配置数据库，先找到数据库脚本，在doc/db/tables_xxl_job.sql 位置
找到数据库脚本后，导入到数据库中执行一下，执行完成后，生成如下库和表：
接下来找到 xxl-job-admin/src/main/resources/application.properties 文件，修改数据库连接信息：
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=123 spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
日志配置也要修改一下，在 xxl-job-admin/src/main/resources/logback.xml 文件中，有如下一行：
# windows系统下是这样修改的,直接./表示项目的根目录下生成一个applogs的文件夹用来存放日志
找到com.xxl.job.admin.XxlJobAdminApplication运行main方法即可启动“调度中心”项目
项目启动成功后，浏览器输入如下地址 http://localhost:8080/xxl-job-admin/toLogin，就可以看到登录页面了：
登录账号:admin 登录密码:123456
登录后运行界面如下图所示：
至此“调度中心”项目已经部署成功
“执行器”项目：xxl-job-executor-sample-springboot (提供多种版本执行器供选择，现以 springboot 版本为例，可直接使用，也可以参考其并将现有项目改造成执行器) 作用：负责接收“调度中心”的调度并执行；可直接部署执行器，也可以将执行器集成到现有业务项目中。
我这里自动手动新建一个项目,教大家如何通过现有项目改造成执行器
首先创建一个 SpringBoot 项目，引入 Web 依赖，如下：
步骤二：执行器配置com.xuxueli xxl-job-core 2.3.0
然后在 resources 目录下新建 logback.xml，并添加如下内容：
logback %d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n ${log.path} ${log.path}.%d{yyyy-MM-dd}.zip %date %level [%thread] %logger{36} [%file : %line] %msg%n
修改 application.properties 文件，内容如下：
# 启动端口 server.port=8089 # 日志配置 logging.config=classpath:logback.xml ### 调度中心部署跟地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册； xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin ### 执行器通讯TOKEN [选填]：非空时启用； xxl.job.accessToken= ### 执行器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= ### 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口； xxl.job.executor.port=9999 ### 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径； xxl.job.executor.logpath=./applogs/xxl-job/jobhandler ### 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能； xxl.job.executor.logretentiondays=30步骤三：执行器组件配置
执行器组件，配置文件地址：
/xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/java/com/xxl/job/executor/core/config/XxlJobConfig.java
执行器组件，配置内容如下：
@Configuration
public class XxlJobConfig {
private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);
@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() {
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;
}
}
步骤四：部署执行器项目：
官方提供了三种部署执行器项目的方式:
BEAN模式（类形式）BEAN模式（方法形式）GLUE模式(Java)
1.BEAN模式（类形式）
Bean模式任务，支持基于类的开发方式，每个任务对应一个Java类。
优点：不限制项目环境，兼容性好。即使是无框架项目，如main方法直接启动的项目也可以提供支持，可以参考示例项目 “xxl-job-executor-sample-frameless”；缺点：
每个任务需要占用一个Java类，造成类的浪费；不支持自动扫描任务并注入到执行器容器，需要手动注入。 步骤一：执行器项目中，开发Job类：
1、开发一个继承自"com.xxl.job.core.handler.IJobHandler"的JobHandler类，实现其中任务方法。
2、手动通过如下方式注入到执行器容器。
```
XxlJobExecutor.registJobHandler("demoJobHandler", new DemoJobHandler());
```
步骤二：调度中心，新建调度任务
后续步骤和 “BEAN模式（方法形式）”一致，可以前往参考
2.BEAN模式（方法形式）
Bean 模式任务，支持基于方法的开发方式，每个任务对应一个方法，一般推荐这种方式。
优点：
每个任务只需要开发一个方法，并添加 ”@XxlJob” 注解即可，更加方便、快速。支持自动扫描任务并注入到执行器容器。
缺点：
要求 Spring 容器环境。
基于方法开发的任务，底层会生成 JobHandler 代理，和基于类的方式一样，任务也会以 JobHandler 的形式存在于执行器任务容器中。
步骤一：执行器项目中，开发Job方法：1、任务开发：在Spring Bean实例中，开发Job方法； 2、注解配置：为Job方法添加注解 "@XxlJob(value="自定义jobhandler名称", init = "JobHandler初始化方法", destroy = "JobHandler销毁方法")"，注解value值对应的是调度中心新建任务的JobHandler属性的值。 3、执行日志：需要通过 "XxlJobHelper.log" 打印执行日志； 4、任务结果：默认任务结果为 "成功" 状态，不需要主动设置；如有诉求，比如设置任务结果为失败，可以通过 "XxlJobHelper.handleFail/handleSuccess" 自主设置任务结果；
// 可参考Sample示例执行器中的 "com.xxl.job.executor.service.jobhandler.SampleXxlJob" ，如下：
@Component
public class MyJob {
@XxlJob("demoJobHandler")
public ReturnT demoJobHandler() throws Exception {
String param = XxlJobHelper.getJobParam();
XxlJobHelper.log("XXL-JOB, Hello World：{}",param);
return ReturnT.SUCCESS;
}
}
步骤二：调度中心，新建调度任务
接下来打开配置调度中心，找到执行器管理，点击新增，如下：
接下来找到任务管理，并点击新增：
以上我是通过cron表达式进行配置的,每5秒执行一下我刚刚写的Job
配置完成后，回到执行器管理，点击查看，可以查看刚刚注册的节点信息：
再次回到任务管理，选择启动，就可以开始定时任务的执行了：
开启之后，点击调度日志，就可以看到我们系统任务执行的详细信息了：
点击操作,可以查看执行日志:
3.GLUE模式(Java)
任务以源码方式维护在调度中心，支持通过Web IDE在线更新，实时编译和生效，因此不需要指定JobHandler。开发流程如下：
步骤一：调度中心，新建调度任务：对新建的任务进行参数配置，运行模式选中 “GLUE模式(Java)”
选中指定任务，点击该任务右侧“GLUE”按钮，将会前往GLUE任务的Web IDE界面，在该界面支持对任务代码进行开发（也可以在IDE中开发完成后，复制粘贴到编辑中）。
版本回溯功能（支持30个版本的版本回溯）：在GLUE任务的Web IDE界面，选择右上角下拉框“版本回溯”，会列出该GLUE的更新历史，选择相应版本即可显示该版本代码，保存后GLUE代码即回退到对应的历史版本；
源码下载地址:https://download.csdn.net/download/ca1993422/85032040 QQ交流群: 1135453115
