XXLJOB 快速入门指南

XXL-JOB 快速入门指南

https://blog.csdn.net/weixin_44798288/article/details/111772876

https://www.cnblogs.com/just-coder/p/10981618.html

https://blog.51cto.com/u_7117633/2920410

https://www.cnblogs.com/linjiqin/p/10785105.html

https://www.cnblogs.com/gcdd1993/p/12292411.html

首先是环境配置，提前安装好以下三个软件

• Maven3+
• Jdk1.8+
• Mysql5.7+

二、快速入门

2.1 初始化“调度数据库”

请下载项目源码并解压，获取 “调度数据库初始化SQL脚本” 并执行即可。

“调度数据库初始化SQL脚本” 位置为:

1. /xxl-job/doc/db/tables_xxl_job.sql

调度中心支持集群部署，集群情况下各节点务必连接同一个mysql实例;

如果mysql做主从,调度中心集群节点务必强制走主库;

2.2 编译源码

解压源码,按照maven格式将源码导入IDE, 使用maven进行编译即可，不要忘记jdk设置、mvn clean package即可生成xxl-job-admin-2.2.0.jar，源码结构如下：

1. xxl-job-admin：调度中心
2. xxl-job-core：公共依赖
3. xxl-job-executor-samples：执行器Sample示例（选择合适的版本执行器，可直接使用，也可以参考其并将现有项目改造成执行器）
4. ：xxl-job-executor-sample-springboot：Springboot版本，通过Springboot管理执行器，推荐这种方式；
5. ：xxl-job-executor-sample-frameless：无框架版本；

2.3 配置部署“调度中心”

1. 调度中心项目：xxl-job-admin
2. 作用：统一管理任务调度平台上调度任务，负责触发调度执行，并且提供任务管理平台。

步骤一：调度中心配置：

调度中心配置文件地址：

1. /xxl-job/xxl-job-admin/src/main/resources/application.properties

调度中心配置内容说明：

1. ### 调度中心JDBC链接：链接地址请保持和 2.1章节 所创建的调度数据库的地址一致
2. spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
3. spring.datasource.username=root
4. spring.datasource.password=root_pwd
5. spring.datasource.driver-class-name=com.mysql.jdbc.Driver
7. ### 报警邮箱
8. spring.mail.host=smtp.qq.com
9. spring.mail.port=25
10. spring.mail.username=xxx@qq.com
11. spring.mail.password=xxx
12. spring.mail.properties.mail.smtp.auth=true
13. spring.mail.properties.mail.smtp.starttls.enable=true
14. spring.mail.properties.mail.smtp.starttls.required=true
15. spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory
17. ### 调度中心通讯TOKEN [选填]：非空时启用；
18. xxl.job.accessToken=
20. ### 调度中心国际化配置 [必填]： 默认为 "zh_CN"/中文简体, 可选范围为 "zh_CN"/中文简体, "zh_TC"/中文繁体 and "en"/英文；
21. xxl.job.i18n=zh_CN
23. ## 调度线程池最大线程配置【必填】
24. xxl.job.triggerpool.fast.max=200
25. xxl.job.triggerpool.slow.max=100
27. ### 调度中心日志表数据保存天数 [必填]：过期日志自动清理；限制大于等于7时生效，否则, 如-1，关闭自动清理功能；
28. xxl.job.logretentiondays=30

步骤二：部署项目：

如果已经正确进行上述配置，可将项目编译打包部署。

调度中心访问地址：http://localhost:8080/xxl-job-admin (该地址执行器将会使用到，作为回调地址)

默认登录账号 “admin/123456”, 登录后运行界面如下图所示。

此默认账号密码可在/xxl-job/xxl-job-admin/src/main/resources/application.properties文件中填写

显式的加上登录调度中心的账号密码

 xxl.job.login.username=admin
xxl.job.login.password=123456

至此“调度中心”项目已经部署成功。

部署到服务器的话可以注册为服务，自启动

2.4 配置部署“执行器项目”

1. “执行器”项目：xxl-job-executor-sample-springboot (提供多种版本执行器供选择，现以 springboot 版本为例，可直接使用，也可以参考其并将现有项目改造成执行器)
2. 作用：负责接收“调度中心”的调度并执行；可直接部署执行器，也可以将执行器集成到现有业务项目中。

将此项目单独复制出来，idea启动打包，xxl-job-executor-sample-springboot，可能会 遇到的问题！！！

步骤一：maven依赖

确认pom文件中引入了 “xxl-job-core” 的maven依赖；版本号根据调度中心的版本号一致

<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.2.0</version>
</dependency>

步骤二：执行器配置

执行器配置，配置文件地址：

1. /xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/resources/application.properties

执行器配置，配置内容说明：

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

步骤三：执行器组件配置

执行器组件，配置文件地址：

1. /xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/java/com/xxl/job/executor/core/config/XxlJobConfig.java

执行器组件，配置内容说明：

1. @Bean
2. public XxlJobSpringExecutor xxlJobExecutor() {
3. logger.info(">>>>>>>>>>> xxl-job config init.");
4. XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
5. xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
6. xxlJobSpringExecutor.setAppname(appname);
7. xxlJobSpringExecutor.setIp(ip);
8. xxlJobSpringExecutor.setPort(port);
9. xxlJobSpringExecutor.setAccessToken(accessToken);
10. xxlJobSpringExecutor.setLogPath(logPath);
11. xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
13. return xxlJobSpringExecutor;
14. }

步骤四：部署执行器项目：

如果已经正确进行上述配置，可将执行器项目编译打部署，系统提供多种执行器Sample示例项目，选择其中一个即可，各自的部署方式如下。

1. xxl-job-executor-sample-springboot：项目编译打包成springboot类型的可执行JAR包，命令启动即可；
2. xxl-job-executor-sample-frameless：项目编译打包成JAR包，命令启动即可；

至此“执行器”项目已经部署结束。

java -jar xxl-job-executor-sample-springboot-2.2.0.jar

运行执行器jar包时，会根据/xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/resources/application.properties配置文件自动注册到调度数据库中的xxl_job_registry表

至此，调度中心、执行器都已启动，接下来就是新增具体要执行的任务了，在任务管理菜单中新增任务

java -jar xxl-job-executor-sample-springboot-2.2.0.jar --server.port=8082 --xxl.job.executor.port=8802

可以指定客户端（执行器）运行的tomcat端口号和执行器端口号，启动多客户端，执行上述命令后，执行器中会有显示

其他的慢慢摸索吧！！！！