一、xxl-job
1.1 下载xxl-job
下载地址:xxl-job
1.2 配置xxl-job
1.2.1 配置数据库:
打开xxl-job-admin下的resources文件夹下的application.properties
其他配置:
修改端口server.port
1.2.2 执行数据库脚本:
打开doc文件-->db-->table_xxl_job.sql。由于源码只有mysql版的脚本。故附上oracle版脚本:
--drop table XXL_JOB_GROUP;
create table XXL_JOB_GROUP
(
ID NUMBER not null,
APP_NAME VARCHAR2(150) not null,
TITLE VARCHAR2(50) not null,
ADDRESS_TYPE NUMBER not null,
ADDRESS_LIST CLOB,
UPDATE_TIME DATE
);
comment on table XXL_JOB_GROUP
is '执行器信息表';
comment on column XXL_JOB_GROUP.ID
is 'id';
comment on column XXL_JOB_GROUP.APP_NAME
is '执行器AppName';
comment on column XXL_JOB_GROUP.TITLE
is '执行器名称';
comment on column XXL_JOB_GROUP.ADDRESS_TYPE
is '执行器地址类型:0=自动注册、1=手动录入';
comment on column XXL_JOB_GROUP.ADDRESS_LIST
is '执行器地址列表,多地址逗号分隔';
comment on column XXL_JOB_GROUP.UPDATE_TIME
is '';
create index IDX_JOB_GROUP_APP_NAME on XXL_JOB_GROUP(APP_NAME) ;
alter table XXL_JOB_GROUP add constraint PK_XXL_JOB_GROUP primary key (ID) ;
--drop table XXL_JOB_INFO;
create table XXL_JOB_INFO
(
ID NUMBER not null,
JOB_GROUP NUMBER not null,
JOB_DESC VARCHAR2(500) not null,
ADD_TIME DATE,
UPDATE_TIME DATE,
AUTHOR VARCHAR2(500),
ALARM_EMAIL VARCHAR2(500),
SCHEDULE_TYPE VARCHAR2(50),
SCHEDULE_CONF VARCHAR2(128),
MISFIRE_STRATEGY VARCHAR2(50),
EXECUTOR_ROUTE_STRATEGY VARCHAR2(150),
EXECUTOR_HANDLER VARCHAR2(500),
EXECUTOR_PARAM VARCHAR2(1000),
EXECUTOR_BLOCK_STRATEGY VARCHAR2(150),
EXECUTOR_TIMEOUT NUMBER not null,
EXECUTOR_FAIL_RETRY_COUNT NUMBER not null,
GLUE_TYPE VARCHAR2(150) not null,
GLUE_SOURCE CLOB,
GLUE_REMARK VARCHAR2(128),
GLUE_UPDATETIME DATE,
CHILD_JOBID VARCHAR2(500),
TRIGGER_STATUS NUMBER not null,
TRIGGER_LAST_TIME NUMBER not null,
TRIGGER_NEXT_TIME NUMBER not null
) ;
comment on table XXL_JOB_INFO
is '调度信息表';
comment on column XXL_JOB_INFO.SCHEDULE_CONF
is '调度配置,值含义取决于调度类型';
comment on column XXL_JOB_INFO.EXECUTOR_HANDLER
is '执行器任务handler';
comment on column XXL_JOB_INFO.EXECUTOR_PARAM
is '执行器任务参数';
comment on column XXL_JOB_INFO.EXECUTOR_BLOCK_STRATEGY
is '阻塞处理策略';
comment on column XXL_JOB_INFO.EXECUTOR_TIMEOUT
is '任务执行超时时间,单位秒';
comment on column XXL_JOB_INFO.EXECUTOR_FAIL_RETRY_COUNT
is '失败重试次数';
comment on column XXL_JOB_INFO.GLUE_TYPE
is 'GLUE类型';
comment on column XXL_JOB_INFO.GLUE_SOURCE
is 'GLUE源代码';
comment on column XXL_JOB_INFO.GLUE_REMARK
is 'GLUE备注';
comment on column XXL_JOB_INFO.GLUE_UPDATETIME
is 'GLUE更新时间';
comment on column XXL_JOB_INFO.CHILD_JOBID
is '子任务ID,多个逗号分隔';
comment on column XXL_JOB_INFO.TRIGGER_STATUS
is '调度状态:0-停止,1-运行';
comment on column XXL_JOB_INFO.TRIGGER_LAST_TIME
is '上次调度时间';
comment on column XXL_JOB_INFO.TRIGGER_NEXT_TIME
is '下次调度时间';
comment on column XXL_JOB_INFO.MISFIRE_STRATEGY
is '调度过期策略';
comment on column XXL_JOB_INFO.SCHEDULE_TYPE
is '调度类型';
comment on column XXL_JOB_INFO.EXECUTOR_ROUTE_STRATEGY
is '执行器路由策略';
comment on column XXL_JOB_INFO.AUTHOR
is '作者';
comment on column XXL_JOB_INFO.ALARM_EMAIL
is '报警邮件';
comment on column XXL_JOB_INFO.ID
is '主键';
comment on column XXL_JOB_INFO.JOB_GROUP
is '执行器主键ID';
comment on column XXL_JOB_INFO.JOB_DESC
is '任务描述';
comment on column XXL_JOB_INFO.ADD_TIME
is '添加时间';
comment on column XXL_JOB_INFO.UPDATE_TIME
is '更新时间';
create index IDX_JOB_AUTHOR on XXL_JOB_INFO(AUTHOR) ;
create index IDX_JOB_EXECUTOR_HANDLER on XXL_JOB_INFO(EXECUTOR_HANDLER) ;
create index IDX_JOB_JOB_GROUP on XXL_JOB_INFO(JOB_GROUP) ;
create index IDX_JOB_TRIGGER_STATUS on XXL_JOB_INFO(TRIGGER_STATUS) ;
alter table XXL_JOB_INFO add constraint PK_XXL_JOB_INFO primary key (ID) ;
--drop table XXL_JOB_LOCK;
create table XXL_JOB_LOCK(
LOCK_NAME VARCHAR2(150) not null
) ;
comment on table XXL_JOB_LOCK
is '锁信息';
comment on column XXL_JOB_LOCK.LOCK_NAME
is '锁名称';
alter table XXL_JOB_LOCK add constraint PK_XXL_JOB_LOCK primary key (LOCK_NAME) ;
--drop table XXL_JOB_LOG;
create table XXL_JOB_LOG
(
ID NUMBER not null,
JOB_GROUP NUMBER not null,
JOB_ID NUMBER not null,
EXECUTOR_ADDRESS VARCHAR2(500),
EXECUTOR_HANDLER VARCHAR2(500),
EXECUTOR_PARAM VARCHAR2(1000),
EXECUTOR_SHARDING_PARAM VARCHAR2(50),
EXECUTOR_FAIL_RETRY_COUNT NUMBER not null,
TRIGGER_TIME DATE,
TRIGGER_CODE NUMBER not null,
TRIGGER_MSG CLOB,
HANDLE_TIME DATE,
HANDLE_CODE NUMBER not null,
HANDLE_MSG CLOB,
ALARM_STATUS NUMBER not null
) ;
comment on table XXL_JOB_LOG
is '任务日志信息';
comment on column XXL_JOB_LOG.JOB_ID
is '任务,主键ID';
comment on column XXL_JOB_LOG.EXECUTOR_ADDRESS
is '执行器地址,本次执行的地址';
comment on column XXL_JOB_LOG.EXECUTOR_HANDLER
is '执行器任务handler';
comment on column XXL_JOB_LOG.EXECUTOR_PARAM
is '执行器任务参数';
comment on column XXL_JOB_LOG.EXECUTOR_SHARDING_PARAM
is '执行器任务分片参数,格式如 1/2';
comment on column XXL_JOB_LOG.EXECUTOR_FAIL_RETRY_COUNT
is '失败重试次数';
comment on column XXL_JOB_LOG.TRIGGER_TIME
is '调度-时间';
comment on column XXL_JOB_LOG.TRIGGER_CODE
is '调度-结果';
comment on column XXL_JOB_LOG.TRIGGER_MSG
is '调度-日志';
comment on column XXL_JOB_LOG.HANDLE_TIME
is '执行-时间';
comment on column XXL_JOB_LOG.HANDLE_CODE
is '执行-状态';
comment on column XXL_JOB_LOG.HANDLE_MSG
is '执行-日志';
comment on column XXL_JOB_LOG.ALARM_STATUS
is '告警状态:0-默认、1-无需告警、2-告警成功、3-告警失败';
comment on column XXL_JOB_LOG.JOB_GROUP
is '执行器主键ID';
comment on column XXL_JOB_LOG.ID
is '主键ID';
create index IDX_JOB_LOG_TRIGGER_CODE on XXL_JOB_LOG(TRIGGER_CODE) ;
create index IDX_JOB_LOG_TRIGGER_TIME on XXL_JOB_LOG(TRIGGER_TIME) ;
alter table XXL_JOB_LOG add constraint PK_XXL_JOB_LOG primary key (ID) ;
create index IDX_JOB_LOG_HANDLE_CODE on XXL_JOB_LOG(HANDLE_CODE) ;
create index IDX_JOB_LOG_HANDLE_TIME on XXL_JOB_LOG(HANDLE_TIME) ;
create index IDX_JOB_LOG_JOB_GROUP on XXL_JOB_LOG(JOB_GROUP) ;
create index IDX_JOB_LOG_JOB_ID on XXL_JOB_LOG(JOB_ID) ;
ALTER TABLE XXL_JOB_LOG MODIFY EXECUTOR_FAIL_RETRY_COUNT DEFAULT 0 ;
ALTER TABLE XXL_JOB_LOG MODIFY ALARM_STATUS DEFAULT 0 ;
--drop table XXL_JOB_LOGGLUE;
create table XXL_JOB_LOGGLUE
(
ID NUMBER not null,
JOB_ID NUMBER not null,
GLUE_TYPE VARCHAR2(150),
GLUE_SOURCE CLOB,
GLUE_REMARK VARCHAR2(256) not null,
ADD_TIME DATE,
UPDATE_TIME DATE
) ;
comment on table XXL_JOB_LOGGLUE
is '任务GLUE日志';
comment on column XXL_JOB_LOGGLUE.GLUE_SOURCE
is 'GLUE源代码';
comment on column XXL_JOB_LOGGLUE.GLUE_REMARK
is 'GLUE备注';
comment on column XXL_JOB_LOGGLUE.ADD_TIME
is '添加时间';
comment on column XXL_JOB_LOGGLUE.UPDATE_TIME
is '更新时间';
comment on column XXL_JOB_LOGGLUE.ID
is '主键ID';
comment on column XXL_JOB_LOGGLUE.JOB_ID
is '任务,主键ID';
comment on column XXL_JOB_LOGGLUE.GLUE_TYPE
is 'GLUE类型';
create index IDX_JOB_LOGGLUE_JOB_ID on XXL_JOB_LOGGLUE(JOB_ID) ;
alter table XXL_JOB_LOGGLUE add constraint PK_XXL_JOB_LOGGLUE primary key (ID) ;
--drop table XXL_JOB_LOG_REPORT;
create table XXL_JOB_LOG_REPORT
(
ID NUMBER(11) not null,
TRIGGER_DAY DATE,
RUNNING_COUNT NUMBER(11) not null,
SUC_COUNT NUMBER(11) not null,
FAIL_COUNT NUMBER(11) not null,
UPDATE_TIME DATE
) ;
comment on table XXL_JOB_LOG_REPORT
is '日志报表';
comment on column XXL_JOB_LOG_REPORT.ID
is 'id';
comment on column XXL_JOB_LOG_REPORT.TRIGGER_DAY
is '调度-时间';
comment on column XXL_JOB_LOG_REPORT.RUNNING_COUNT
is '运行中-日志数量';
comment on column XXL_JOB_LOG_REPORT.SUC_COUNT
is '执行成功-日志数量';
comment on column XXL_JOB_LOG_REPORT.FAIL_COUNT
is '执行失败-日志数量';
comment on column XXL_JOB_LOG_REPORT.UPDATE_TIME
is '更新时间';
alter table XXL_JOB_LOG_REPORT add constraint PK_XXL_JOB_LOG_REPORT primary key (ID) ;
--drop table XXL_JOB_REGISTRY;
create table XXL_JOB_REGISTRY
(
ID NUMBER not null,
REGISTRY_GROUP VARCHAR2(500) not null,
REGISTRY_KEY VARCHAR2(500) not null,
REGISTRY_VALUE VARCHAR2(500) not null,
UPDATE_TIME DATE
) ;
comment on table XXL_JOB_REGISTRY
is '执行器注册表';
comment on column XXL_JOB_REGISTRY.ID
is '主键ID';
comment on column XXL_JOB_REGISTRY.REGISTRY_GROUP
is '注册组';
comment on column XXL_JOB_REGISTRY.REGISTRY_KEY
is '注册key';
comment on column XXL_JOB_REGISTRY.REGISTRY_VALUE
is '注册value';
comment on column XXL_JOB_REGISTRY.UPDATE_TIME
is '修改时间';
create index IDX_JOB_REGISTRY_GROUP on XXL_JOB_REGISTRY(REGISTRY_GROUP) ;
create index IDX_JOB_REGISTRY_UPDATE_TIME on XXL_JOB_REGISTRY(UPDATE_TIME) ;
alter table XXL_JOB_REGISTRY add constraint PK_XXL_JOB_REGISTRY primary key (ID) ;
--drop table XXL_JOB_USER;
create table XXL_JOB_USER
(
ID NUMBER not null,
USERNAME VARCHAR2(150) not null,
PASSWORD VARCHAR2(150) not null,
ROLE NUMBER not null,
PERMISSION VARCHAR2(500)
) ;
comment on table XXL_JOB_USER
is '登录用户信息';
comment on column XXL_JOB_USER.ID
is '主键ID';
comment on column XXL_JOB_USER.USERNAME
is '账号';
comment on column XXL_JOB_USER.PASSWORD
is '密码';
comment on column XXL_JOB_USER.ROLE
is '角色:0-普通用户、1-管理员';
comment on column XXL_JOB_USER.PERMISSION
is '权限:执行器ID列表,多个逗号分割';
alter table XXL_JOB_USER add constraint PK_XXL_JOB_USER primary key (ID) ;
-- Create sequence
create sequence XXL_JOB_GROUP_ID
minvalue 1
maxvalue 999999999999
start with 2
increment by 1
cache 20
cycle;
-- Create sequence
create sequence XXL_JOB_INFO_ID
minvalue 1
maxvalue 999999999999
start with 2
increment by 1
cache 20
cycle;
-- Create sequence
create sequence XXL_JOB_LOGGLUE_ID
minvalue 1
maxvalue 999999999999
start with 1
increment by 1
cache 20
cycle;
-- Create sequence
create sequence XXL_JOB_LOG_ID
minvalue 1
maxvalue 999999999999
start with 1
increment by 1
cache 20
cycle;
-- Create sequence
create sequence XXL_JOB_LOG_REPORT_ID
minvalue 1
maxvalue 999999999999
start with 2
increment by 1
cache 20
cycle;
-- Create sequence
create sequence XXL_JOB_REGISTRY_ID
minvalue 1
maxvalue 999999999999
start with 1
increment by 1
cache 20
cycle;
-- Create sequence
create sequence XXL_JOB_USER_ID
minvalue 1
maxvalue 999999999999
start with 2
increment by 1
cache 20
cycle;
INSERT INTO xxl_job_group(id, app_name, title, address_type, address_list) VALUES (1, 'xxl-job-executor-sample', '示例执行器', 0, NULL);
INSERT INTO xxl_job_user(id, username, password, role, permission) VALUES (1, 'admin', 'e10adc3949ba59abbe56e057f20f883e', 1, NULL);
INSERT INTO xxl_job_lock(lock_name) VALUES ( 'schedule_lock');
1.3 启动xxl-job
启动XxlJobAdminApplication类
访问:http://localhost:8090/xxl-job-admin/
默认用户名密码:admin/123456
1.4 xxl-job操作
1.4.1 新增执行器
进入“执行器管理”-->“新增”
1.4.2 新增任务
进入“任务管理”-->“新增”
配置详细说明:
基础配置:
- 执行器:任务的绑定的执行器,任务触发调度时将会自动发现注册成功的执行器, 实现任务自动发现功能; 另一方面也可以方便的进行任务分组。每个任务必须绑定一个执行器, 可在 "执行器管理" 进行设置;
- 任务描述:任务的描述信息,便于任务管理;
- 负责人:任务的负责人;
- 报警邮件:任务调度失败时邮件通知的邮箱地址,支持配置多邮箱地址,配置多个邮箱地址时用逗号分隔;
触发配置:
- 调度类型:
无:该类型不会主动触发调度;
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队列并以串行方式运行;
丢弃后续调度:调度请求进入单机执行器后,发现执行器存在运行的调度任务,本次请求将会被丢弃并标记为失败;
覆盖之前调度:调度请求进入单机执行器后,发现执行器存在运行的调度任务,将会终止运行中的调度任务并清空队列,然后运行本地调度任务;
- 任务超时时间:支持自定义任务超时时间,任务运行超时将会主动中断任务;
- 失败重试次数;支持自定义任务失败重试次数,当任务失败时将会按照预设的失败重试次数主动进行重试;
二、spring项目
本项目基于spring+springmvc搭建,不是纯注解版项目,与官网支持的版本有出入,如果是spring-boot版本或无框架版本,请直接参考官网教程:xxl-job/doc/XXL-JOB官方文档.md at master · xuxueli/xxl-job · GitHub
2.1 配置applicationContext.xml
2.1.1 添加bean
在applicationContext.xml文件中配置:
<bean id="xxlJobSpringExecutor" class="com.xxl.job.core.executor.impl.XxlJobSpringExecutor" >
<property name="adminAddresses" value="http://localhost:8090/xxl-job-admin"></property>
<property name="accessToken" value="defult-token"></property>
<property name="appname" value="leqi-job-executor"></property>
<property name="address" value=""></property>
<property name="ip" value=""></property>
<property name="port" value="9999"></property>
<property name="logPath" value="E:\\xxl-log"></property>
<property name="logRetentionDays" value="30"></property>
</bean>
2.1.2 添加扫描包
此包用于存放所有job任务执行类
<context:component-scan base-package="com.test.job" />
2.2 需要依赖的jar包
<!--xxl 定时任务-->
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
</dependency>
2.3 编写JobHandler类
package com.test.job;
import org.springframework.stereotype.Component;
import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.context.XxlJobHelper;
import com.xxl.job.core.handler.annotation.XxlJob;
@Component
public class TestJob {
public static final String LOG_MSG = "(测试定时任务)";
@XxlJob("testHandler")
public ReturnT<String> testHandler() {
long start = System.currentTimeMillis();
XxlJobHelper.log("{}开始执行", LOG_MSG);
boolean success = true;
System.out.println("-------------job执行中。。。。。。");;
long end = System.currentTimeMillis();
XxlJobHelper.log("{}执行完成,用时:{}ms", LOG_MSG, end - start);
if (success) {
return ReturnT.SUCCESS;
} else {
XxlJobHelper.handleFail();
return ReturnT.FAIL;
}
}
}
注意:@XxlJob("testHandler")这个要配置的跟xxl-job任务管理新增的任务的JobHandler名一致。
三、执行定时任务
3.1 执行
3.2 启动
测试完成后,可以启动该任务,后续定时执行。