- 前言
- 扩展几个定时任务创建
- SpringBoot实现定时任务
- quartz-job创建定时任务
- 关于Cron表达式
- 为什么会考虑xxljob
- xxljob服务端部署
- 1、下载xxljob源码
- 2、导入idea
- 3、初始化数据库
- 4、修改下载的xxljob源码配置文件
- 5、web访问
- xxl-job 客户端部署
- 1、web端新建执行器
- 2、配置测试服务
- 3、设置自定义的handler执行器
- 4、web端增加任务管理配置
- 5、启动xxl-job-executor-sample-springboot
- 注意事项
- 1、xxl-rpc remoting error(no protocol: 127.0.0.1:8083/run), for url :
在项目开发中,关于定时任务的创建等,存在很多方式,最常见的用法就是Springboot框架中已封装好的@EnableScheduling。
在单体应用中,Schedualed能够完美的实现定时任务的功能,但是随着系统的升级和流量的激增。项目的架构需要向分布式方向扩展和发展,此时如果继续使用schedualed实现定时任务操作,往往会导致某些任务重复执行等问题,存在很多的弊端。
xxl-job属于分布式的调度平台,能够完美的解决上述的问题。
扩展几个定时任务创建 SpringBoot实现定时任务在Springboot项目中,本身就自带有@Scheduled开启定时任务的操作。
只需要在启动类上标注@EnableScheduling,同时编写合适的Cron表达式就能实现。如下所示:
当程序运行后,控制台将会出现如下所示的日志信息:
依赖引入:
org.quartz-scheduler quartz 2.2.1 org.quartz-scheduler quartz-jobs 2.2.1
测试代码编写
package cn.xj;
import org.quartz.Job;
import org.quartz.JobExecutionContext;
import org.quartz.JobExecutionException;
public class QuartzDemo implements Job {
@Override
public void execute(JobExecutionContext jobExecutionContext) throws JobExecutionException {
System.out.println("6666666");
}
}
package cn.xj;
import org.quartz.*;
import org.quartz.impl.StdSchedulerFactory;
import java.util.Date;
public class Test {
public static void main(String[] args) throws SchedulerException {
// 1、创建 scheduled 工厂
StdSchedulerFactory stdSchedulerFactory = new StdSchedulerFactory();
// 2、从工厂中获得调度器的实例
Scheduler scheduler = stdSchedulerFactory.getScheduler();
// 3、创建 JobDetail
JobDetail job = JobBuilder.newJob(QuartzDemo.class)
.withDescription("xiangjiao test") // job描述
.withIdentity("xiangjiao", "bunana") // name 和 group
.build();
// 任务执行时间,触发器等
long startTimes = System.currentTimeMillis()+3*1000L;
Date startDate = new Date(startTimes);
// 4、创建 CronTrigger
CronTrigger cronTrigger = TriggerBuilder.newTrigger()
.withDescription("this is a cronTrigger")
.withIdentity("xiangjiao2", "test2")
.startAt(startDate)
// 使用 SimpleScheduleBuilder 或者 CronScheduleBuilder
//.withSchedule(SimpleScheduleBuilder.simpleSchedule())
.withSchedule(CronScheduleBuilder.cronSchedule("0/5 * * * * ?")) // 每5秒执行一次
.build();
// 5、注册任务和定时器
scheduler.scheduleJob(job,cronTrigger);
// 6、启动 定时调度器
scheduler.start();
// 7、关闭调度器
// scheduler.shutdown();
}
}
关于Cron表达式资料参考:Quartz任务调度(1)概念例析快速入门
Cron表达式从左到右每个符号分别代表的含义为:
秒、分、时、日、月、周、年
参考资料:
SpringBoot 定时任务cron
在线cron表达式生成
Springboot中就已经定义好了@Scheduled定时任务的功能,同时也能支持大部分的业务开发需求,但为什么依旧还会考虑使用xxl-job 技术?
其实在官方文档中,对其有一个很好的描述。
2、导入idea 3、初始化数据库git clone https://github.com/xuxueli/xxl-job.git
将其在自己的数据库中执行,本次使用的是MySQL。
完整SQL脚本如下所示:
# # XXL-JOB v2.3.1-SNAPSHOT # Copyright (c) 2015-present, xuxueli. CREATE database if NOT EXISTS `xxl_job` default character set utf8mb4 collate utf8mb4_unicode_ci; use `xxl_job`; SET NAMES utf8mb4; CREATE TABLE `xxl_job_info` ( `id` int(11) NOT NULL AUTO_INCREMENT, `job_group` int(11) NOT NULL COMMENT '执行器主键ID', `job_desc` varchar(255) NOT NULL, `add_time` datetime DEFAULT NULL, `update_time` datetime DEFAULT NULL, `author` varchar(64) DEFAULT NULL COMMENT '作者', `alarm_email` varchar(255) DEFAULT NULL COMMENT '报警邮件', `schedule_type` varchar(50) NOT NULL DEFAULT 'NONE' COMMENT '调度类型', `schedule_conf` varchar(128) DEFAULT NULL COMMENT '调度配置,值含义取决于调度类型', `misfire_strategy` varchar(50) NOT NULL DEFAULT 'DO_NOTHING' COMMENT '调度过期策略', `executor_route_strategy` varchar(50) DEFAULT NULL COMMENT '执行器路由策略', `executor_handler` varchar(255) DEFAULT NULL COMMENT '执行器任务handler', `executor_param` varchar(512) DEFAULT NULL COMMENT '执行器任务参数', `executor_block_strategy` varchar(50) DEFAULT NULL COMMENT '阻塞处理策略', `executor_timeout` int(11) NOT NULL DEFAULT '0' COMMENT '任务执行超时时间,单位秒', `executor_fail_retry_count` int(11) NOT NULL DEFAULT '0' COMMENT '失败重试次数', `glue_type` varchar(50) NOT NULL COMMENT 'GLUE类型', `glue_source` mediumtext COMMENT 'GLUE源代码', `glue_remark` varchar(128) DEFAULT NULL COMMENT 'GLUE备注', `glue_updatetime` datetime DEFAULT NULL COMMENT 'GLUE更新时间', `child_jobid` varchar(255) DEFAULT NULL COMMENT '子任务ID,多个逗号分隔', `trigger_status` tinyint(4) NOT NULL DEFAULT '0' COMMENT '调度状态:0-停止,1-运行', `trigger_last_time` bigint(13) NOT NULL DEFAULT '0' COMMENT '上次调度时间', `trigger_next_time` bigint(13) NOT NULL DEFAULT '0' COMMENT '下次调度时间', PRIMARY KEY (`id`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4; CREATE TABLE `xxl_job_log` ( `id` bigint(20) NOT NULL AUTO_INCREMENT, `job_group` int(11) NOT NULL COMMENT '执行器主键ID', `job_id` int(11) NOT NULL COMMENT '任务,主键ID', `executor_address` varchar(255) DEFAULT NULL COMMENT '执行器地址,本次执行的地址', `executor_handler` varchar(255) DEFAULT NULL COMMENT '执行器任务handler', `executor_param` varchar(512) DEFAULT NULL COMMENT '执行器任务参数', `executor_sharding_param` varchar(20) DEFAULT NULL COMMENT '执行器任务分片参数,格式如 1/2', `executor_fail_retry_count` int(11) NOT NULL DEFAULT '0' COMMENT '失败重试次数', `trigger_time` datetime DEFAULT NULL COMMENT '调度-时间', `trigger_code` int(11) NOT NULL COMMENT '调度-结果', `trigger_msg` text COMMENT '调度-日志', `handle_time` datetime DEFAULT NULL COMMENT '执行-时间', `handle_code` int(11) NOT NULL COMMENT '执行-状态', `handle_msg` text COMMENT '执行-日志', `alarm_status` tinyint(4) NOT NULL DEFAULT '0' COMMENT '告警状态:0-默认、1-无需告警、2-告警成功、3-告警失败', PRIMARY KEY (`id`), KEY `I_trigger_time` (`trigger_time`), KEY `I_handle_code` (`handle_code`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4; CREATE TABLE `xxl_job_log_report` ( `id` int(11) NOT NULL AUTO_INCREMENT, `trigger_day` datetime DEFAULT NULL COMMENT '调度-时间', `running_count` int(11) NOT NULL DEFAULT '0' COMMENT '运行中-日志数量', `suc_count` int(11) NOT NULL DEFAULT '0' COMMENT '执行成功-日志数量', `fail_count` int(11) NOT NULL DEFAULT '0' COMMENT '执行失败-日志数量', `update_time` datetime DEFAULT NULL, PRIMARY KEY (`id`), UNIQUE KEY `i_trigger_day` (`trigger_day`) USING BTREE ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4; CREATE TABLE `xxl_job_logglue` ( `id` int(11) NOT NULL AUTO_INCREMENT, `job_id` int(11) NOT NULL COMMENT '任务,主键ID', `glue_type` varchar(50) DEFAULT NULL COMMENT 'GLUE类型', `glue_source` mediumtext COMMENT 'GLUE源代码', `glue_remark` varchar(128) NOT NULL COMMENT 'GLUE备注', `add_time` datetime DEFAULT NULL, `update_time` datetime DEFAULT NULL, PRIMARY KEY (`id`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4; CREATE TABLE `xxl_job_registry` ( `id` int(11) NOT NULL AUTO_INCREMENT, `registry_group` varchar(50) NOT NULL, `registry_key` varchar(255) NOT NULL, `registry_value` varchar(255) NOT NULL, `update_time` datetime DEFAULT NULL, PRIMARY KEY (`id`), KEY `i_g_k_v` (`registry_group`,`registry_key`,`registry_value`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4; CREATE TABLE `xxl_job_group` ( `id` int(11) NOT NULL AUTO_INCREMENT, `app_name` varchar(64) NOT NULL COMMENT '执行器AppName', `title` varchar(12) NOT NULL COMMENT '执行器名称', `address_type` tinyint(4) NOT NULL DEFAULT '0' COMMENT '执行器地址类型:0=自动注册、1=手动录入', `address_list` text COMMENT '执行器地址列表,多地址逗号分隔', `update_time` datetime DEFAULT NULL, PRIMARY KEY (`id`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4; CREATE TABLE `xxl_job_user` ( `id` int(11) NOT NULL AUTO_INCREMENT, `username` varchar(50) NOT NULL COMMENT '账号', `password` varchar(50) NOT NULL COMMENT '密码', `role` tinyint(4) NOT NULL COMMENT '角色:0-普通用户、1-管理员', `permission` varchar(255) DEFAULT NULL COMMENT '权限:执行器ID列表,多个逗号分割', PRIMARY KEY (`id`), UNIQUE KEY `i_username` (`username`) USING BTREE ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4; CREATE TABLE `xxl_job_lock` ( `lock_name` varchar(50) NOT NULL COMMENT '锁名称', PRIMARY KEY (`lock_name`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4; INSERT INTO `xxl_job_group`(`id`, `app_name`, `title`, `address_type`, `address_list`, `update_time`) VALUES (1, 'xxl-job-executor-sample', '示例执行器', 0, NULL, '2018-11-03 22:21:31' ); INSERT INTO `xxl_job_info`(`id`, `job_group`, `job_desc`, `add_time`, `update_time`, `author`, `alarm_email`, `schedule_type`, `schedule_conf`, `misfire_strategy`, `executor_route_strategy`, `executor_handler`, `executor_param`, `executor_block_strategy`, `executor_timeout`, `executor_fail_retry_count`, `glue_type`, `glue_source`, `glue_remark`, `glue_updatetime`, `child_jobid`) VALUES (1, 1, '测试任务1', '2018-11-03 22:21:31', '2018-11-03 22:21:31', 'XXL', '', 'CRON', '0 0 0 * * ? *', 'DO_NOTHING', 'FIRST', 'demoJobHandler', '', 'SERIAL_EXECUTION', 0, 0, 'BEAN', '', 'GLUE代码初始化', '2018-11-03 22:21:31', ''); 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'); commit;4、修改下载的xxljob源码配置文件
比如:mysql连接配置:
spring.datasource.url=jdbc:mysql://106.55.137.66:3306/xxl_job?useSSL=false&useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=GMT%2B8 spring.datasource.username=root spring.datasource.password=root spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
之后直接启动xxl-job-admin这个springboot应用即可!
5、web访问http://localhost:8080/xxl-job-admin/
默认账户、密码为:
admin 123456xxl-job 客户端部署 1、web端新建执行器 2、配置测试服务
找到xxl-job-executor-sample-springboot服务,修改application.properties配置信息。
# 应用端口号 server.port=80 # no web #spring.main.web-environment=false # log config logging.config=classpath:logback.xml # xxl-job web 端地址 注意地址信息不要用 127.0.0.1 ### xxl-job admin address list, such as "http://address" or "http://address01,http://address02" xxl.job.admin.addresses=http://192.168.1.7:8080/xxl-job-admin ### xxl-job, access token xxl.job.accessToken= # xxl-job web中配置的信息,与其保持一致 ### xxl-job executor appname xxl.job.executor.appname=xj-job-test ### xxl-job executor registry-address: default use address to registry , otherwise use ip:port if address is null xxl.job.executor.address= ### xxl-job executor server-info xxl.job.executor.ip=192.168.1.7 xxl.job.executor.port=9998 ### xxl-job executor log-path xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler ### xxl-job executor log-retention-days xxl.job.executor.logretentiondays=303、设置自定义的handler执行器
package com.xxl.job.executor.service.jobhandler;
import com.xxl.job.core.handler.annotation.XxlJob;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
@Component
public class XJTestJobHandler {
private static Logger logger = LoggerFactory.getLogger(XJTestJobHandler.class);
// 注意这里的bean名称
@XxlJob("testXJTestJobHandler")
public void test(){
logger.info("666666");
}
}
4、web端增加任务管理配置
5、启动xxl-job-executor-sample-springboot
当配置了上面的参数时,xxl-job-executor-sample-springboot未启动,此时xxl-job-admin控制台会出现报错。
因为xxl-job-admin会尝试先执行一次,再分发给子服务执行!
启动xxl-job-executor-sample-springboot服务。
启动成功后,在xxl-job-executor-sample-springboot服务的控制台中可以看见下列日志信息:
注意配置文件中,本机测试不要使用127.0.0.1!



