快速上手xxl-job

XXL-JOB入门案例

第一步

下载XXL-JOB示例代码，解压，使用idea打开

**项目组成：

admin：调度中心
core：公共依赖
sample
- sample-frameless：不带框架的
- sample-springboot：带springboot框架的

第二步

创建XXL-JOB使用数据库和相关表

在示例代码文件里面doc文件夹下的db里面有相关的sql语句，直接拉到数据库即可

代码如下

#  
# XXL-JOB v2.3.0  
# 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;

第三步

部署调度中心

修改xxl-job-admin项目里面配置文件

主要修改数据库

### xxl-job, datasource
spring.datasource.url=jdbc:mysql://localhost:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

启动调度中心
通过路径访问：http://localhost:8080/xxl-job-admin
默认用户名和密码： admin/123456

第四步

部署执行器项目

导入依赖
修改配置文件，把执行器项目放在调度中心进行注册
创建配置类，获取任务调用过程中需要使用的参数

package com.xxl.job.executor.core.config;

import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * xxl-job config
 *
 * @author xuxueli 2017-04-28
 */
@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;
    }


}

启动执行器项目
注册到调度中心里面

第五步

开发执行器项目job方法

@Component
public class SampleXxlJob {
    private static Logger logger = LoggerFactory.getLogger(SampleXxlJob.class);


    /**
     * 1、简单任务示例（Bean模式）
     */
    @XxlJob("demoJobHandler")
    public void demoJobHandler() throws Exception {
        XxlJobHelper.log("XXL-JOB, Hello World.");

        for (int i = 0; i < 5; i++) {
            XxlJobHelper.log("beat at:" + i);
            TimeUnit.SECONDS.sleep(2);
            System.out.println(Thread.currentThread().getName()+"atguigu....");
        }
        // default success
    }
}

第六步

创建任务并启动任务

通过图形化界面进行操作新增任务 ![[Pasted image 20250531154302.png]]

Posted on:: May 31, 2025

Length:: 4 minute read, 813 words

Tags:: project

See Also:: CompletableFuture异步编排; MongoDB; 分布式事物锁