xxl-job快速入门
一、xxl-job简介
XXL-JOB是一个分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用
文档地址
- 中文文档
- English Documentation
源码仓库地址
源码仓库地址 | Release Download |
---|---|
https://github.com/xuxueli/xxl-job | Download |
http://gitee.com/xuxueli0323/xxl-job | Download |
中央仓库地址
<!-- http://repo1.maven.org/maven2/com/xuxueli/xxl-job-core/ -->
<dependency><groupId>com.xuxueli</groupId><artifactId>xxl-job-core</artifactId><version>${最新稳定版本}</version>
</dependency>
二、运行 xxl-job
我们先把 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的文件夹用来存放日志
<property name="log.path" value="./applogs/xxl-job/xxl-job-admin.log"/>
找到com.xxl.job.admin.XxlJobAdminApplication
运行main方法即可启动“调度中心”项目
项目启动成功后,浏览器输入如下地址 http://localhost:8080/xxl-job-admin/toLogin
,就可以看到登录页面了:
登录账号:admin
登录密码:123456
登录后运行界面如下图所示:
至此“调度中心”项目已经部署成功
三、配置部署“执行器项目”
“执行器”项目:xxl-job-executor-sample-springboot (提供多种版本执行器供选择,现以 springboot 版本为例,可直接使用,也可以参考其并将现有项目改造成执行器)
作用:负责接收“调度中心”的调度并执行;可直接部署执行器,也可以将执行器集成到现有业务项目中。
我这里自动手动新建一个项目,教大家如何通过现有项目改造成执行器
首先创建一个 SpringBoot 项目,引入 Web 依赖,如下:
步骤一:maven依赖
<!-- 这里大家通过这个网址下载最新的依赖包吧http://repo1.maven.org/maven2/com/xuxueli/xxl-job-core/
-->
<dependency><groupId>com.xuxueli</groupId><artifactId>xxl-job-core</artifactId><version>2.3.0</version>
</dependency>
步骤二:执行器配置
然后在 resources 目录下新建 logback.xml,并添加如下内容:
<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false" scan="true" scanPeriod="1 seconds"><contextName>logback</contextName><property name="log.path" value="./applogs/xxl-job/xxl-job-executor-sample-springboot.log"/><appender name="console" class="ch.qos.logback.core.ConsoleAppender"><encoder><pattern>%d{HH:mm:ss.SSS} %contextName [%thread] %-5level %logger{36} - %msg%n</pattern></encoder></appender><appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender"><file>${log.path}</file><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><fileNamePattern>${log.path}.%d{yyyy-MM-dd}.zip</fileNamePattern></rollingPolicy><encoder><pattern>%date %level [%thread] %logger{36} [%file : %line] %msg%n</pattern></encoder></appender><root level="info"><appender-ref ref="console"/><appender-ref ref="file"/></root>
</configuration>
修改 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;@Beanpublic 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<String> demoJobHandler() throws Exception {String param = XxlJobHelper.getJobParam();XxlJobHelper.log("XXL-JOB, Hello World:{}",param);return ReturnT.SUCCESS;}
}
步骤二:调度中心,新建调度任务
接下来打开配置调度中心,找到执行器管理,点击新增,如下:
接下来找到任务管理,并点击新增:
以上我是通过cron表达式进行配置的,每5秒执行一下我刚刚写的Job
附赠:Cron表达式
配置完成后,回到执行器管理,点击查看,可以查看刚刚注册的节点信息:
再次回到任务管理,选择启动,就可以开始定时任务的执行了:
开启之后,点击调度日志,就可以看到我们系统任务执行的详细信息了:
点击操作,可以查看执行日志:
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
xxl-job快速入门相关推荐
- Shiro第一个程序:官方快速入门程序Qucickstart详解教程
目录 一.下载解压 二.第一个Shiro程序 1. 导入依赖 2. 配置shiro配置文件 3. Quickstart.java 4. 启动测试 三.shiro.ini分析 四.Quickstart. ...
- 计算机入门新人必学,异世修真人怎么玩?新手快速入门必备技巧
异世修真人怎么快速入门?最近新出来的一款文字修仙游戏,很多萌新不知道怎么玩?进小编给大家带来了游戏新手快速入门技巧攻略,希望可以帮到大家. 新手快速入门攻略 1.开局出来往下找婆婆,交互给点钱,旁边有 ...
- Spring Boot 2 快速教程:WebFlux 快速入门(二)
2019独角兽企业重金招聘Python工程师标准>>> 摘要: 原创出处 https://www.bysocket.com 「公众号:泥瓦匠BYSocket 」欢迎关注和转载,保留摘 ...
- Apache Hive 快速入门 (CentOS 7.3 + Hadoop-2.8 + Hive-2.1.1)
2019独角兽企业重金招聘Python工程师标准>>> 本文节选自<Netkiller Database 手札> 第 63 章 Apache Hive 目录 63.1. ...
- 《iOS9开发快速入门》——导读
本节书摘来自异步社区<iOS9开发快速入门>一书中的目录,作者 刘丽霞 , 邱晓华,更多章节内容可以访问云栖社区"异步社区"公众号查看 目 录 前 言 第1章 iOS ...
- BIML 101 - ETL数据清洗 系列 - BIML 快速入门教程 - 序
BIML 101 - BIML 快速入门教程 做大数据的项目,最花时间的就是数据清洗. 没有一个相对可靠的数据,数据分析就是无木之舟,无水之源. 如果你已经进了ETL这个坑,而且预算有限,并且有大量的 ...
- python scrapy菜鸟教程_scrapy学习笔记(一)快速入门
安装Scrapy Scrapy是一个高级的Python爬虫框架,它不仅包含了爬虫的特性,还可以方便的将爬虫数据保存到csv.json等文件中. 首先我们安装Scrapy. pip install sc ...
- OpenStack快速入门
OpenStack云计算快速入门(1) 该教程基于Ubuntu12.04版,它将帮助读者建立起一份OpenStack最小化安装.我是五岳之巅,翻译中多采用意译法,所以个别词与原版有出入,请大家谅解.我 ...
- Expression Blend实例中文教程(2) - 界面快速入门
上一篇主要介绍Expression系列产品,另外概述了Blend的强大功能,本篇将用Blend 3创建一个新Silverlight项目,通过创建的过程,对Blend进行快速入门学习. 在开始使用Ble ...
- 图文并茂!60页PPT《快速入门python数据分析路线》(附链接)
一个月不走弯路快速入门学python和python数据分析路线,呕心沥血加班加点做了2天,一共63页,该课件讲的都是路线中的核心知识,今天把该PPT分享给大家,能根据该课件提到的知识有针对性的学,做到 ...
最新文章
- HMM:Hidden Markov Model 代码讲解
- 泛在电力物联网分析—架构形式
- [设计模式]合成复用原则
- 易语言 字段重复_使对易失性字段的操作原子化
- 简单入门Javascript正则表达式
- 餐饮创业想赚钱,这5个思维方式少不了
- 信息系统项目管理案例
- word论文公式编号排版
- 【DirectX 9.0c入门教程】之一 开发环境搭建:安装vs2008 sp1和DirectX SDK
- 数据库数据模型理解 概念数据模型 逻辑数据模型 物理数据模型区别和联系
- 5财务分析的基本方法-盈利能力分析
- Python爬虫获取电影链接(续)
- 视频编解码学习之四:视频处理及编码标准
- smbd - 向客户提供SMB/CIFS服务的服务器
- 用python和adb将一加便签内容迁移到小米或其他品牌便签软件
- android 开发之蓝牙开发
- Tomcat和Springboot自启动脚本
- Kb/s,KB/s 究竟如何换算
- Summary:Fater Rcnn
- ZGC是如何工作的?
热门文章
- Cherno C++系列笔记20——P60~P61 为什么不使用using namespace std、命名空间
- Oracle EBS AP付款(退款)无法产生损失(LOSS)会计分录
- Android密码明文显示和星号显示切换
- 计算机突然蓝屏重启,最近电脑经常蓝屏重启。
- 情感计算机具体应用领域,人工智能-情感计算
- kernel更改开机画面
- Outlook邮件目录中存在部分英文和中文,修改为中文的方法
- 使用ffmpeg将视频转成HLS(m3u8)格式
- 深入剖析Windows补丁
- 大白话讲调度:非支配遗传算法与柔性作业车间调度