部署xxl-job-admin

初始化

1. 数据库

下载项目：https://github.com/xuxueli/xxl-job
初始化数据库到本地数据库
请下载项目源码并解压，获取 “调度数据库初始化SQL脚本” 并执行即可。
“调度数据库初始化SQL脚本” 位置为:

  1. /xxl-job/doc/db/tables_xxl_job.sql
  1. #
  2. # XXL-JOB v2.3.1
  3. # Copyright (c) 2015-present, xuxueli.
  5. CREATE database if NOT EXISTS `xxl_job` default character set utf8mb4 collate utf8mb4_unicode_ci;
  6. use `xxl_job`;
  8. SET NAMES utf8mb4;
  10. CREATE TABLE `xxl_job_info` (
  11.   `id` int(11) NOT NULL AUTO_INCREMENT,
  12.   `job_group` int(11) NOT NULL COMMENT '执行器主键ID',
  13.   `job_desc` varchar(255) NOT NULL,
  14.   `add_time` datetime DEFAULT NULL,
  15.   `update_time` datetime DEFAULT NULL,
  16.   `author` varchar(64) DEFAULT NULL COMMENT '作者',
  17.   `alarm_email` varchar(255) DEFAULT NULL COMMENT '报警邮件',
  18.   `schedule_type` varchar(50) NOT NULL DEFAULT 'NONE' COMMENT '调度类型',
  19.   `schedule_conf` varchar(128) DEFAULT NULL COMMENT '调度配置，值含义取决于调度类型',
  20.   `misfire_strategy` varchar(50) NOT NULL DEFAULT 'DO_NOTHING' COMMENT '调度过期策略',
  21.   `executor_route_strategy` varchar(50) DEFAULT NULL COMMENT '执行器路由策略',
  22.   `executor_handler` varchar(255) DEFAULT NULL COMMENT '执行器任务handler',
  23.   `executor_param` varchar(512) DEFAULT NULL COMMENT '执行器任务参数',
  24.   `executor_block_strategy` varchar(50) DEFAULT NULL COMMENT '阻塞处理策略',
  25.   `executor_timeout` int(11) NOT NULL DEFAULT '0' COMMENT '任务执行超时时间，单位秒',
  26.   `executor_fail_retry_count` int(11) NOT NULL DEFAULT '0' COMMENT '失败重试次数',
  27.   `glue_type` varchar(50) NOT NULL COMMENT 'GLUE类型',
  28.   `glue_source` mediumtext COMMENT 'GLUE源代码',
  29.   `glue_remark` varchar(128) DEFAULT NULL COMMENT 'GLUE备注',
  30.   `glue_updatetime` datetime DEFAULT NULL COMMENT 'GLUE更新时间',
  31.   `child_jobid` varchar(255) DEFAULT NULL COMMENT '子任务ID，多个逗号分隔',
  32.   `trigger_status` tinyint(4) NOT NULL DEFAULT '0' COMMENT '调度状态：0-停止，1-运行',
  33.   `trigger_last_time` bigint(13) NOT NULL DEFAULT '0' COMMENT '上次调度时间',
  34.   `trigger_next_time` bigint(13) NOT NULL DEFAULT '0' COMMENT '下次调度时间',
  35.   PRIMARY KEY (`id`)
  36. ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
  38. CREATE TABLE `xxl_job_log` (
  39.   `id` bigint(20) NOT NULL AUTO_INCREMENT,
  40.   `job_group` int(11) NOT NULL COMMENT '执行器主键ID',
  41.   `job_id` int(11) NOT NULL COMMENT '任务，主键ID',
  42.   `executor_address` varchar(255) DEFAULT NULL COMMENT '执行器地址，本次执行的地址',
  43.   `executor_handler` varchar(255) DEFAULT NULL COMMENT '执行器任务handler',
  44.   `executor_param` varchar(512) DEFAULT NULL COMMENT '执行器任务参数',
  45.   `executor_sharding_param` varchar(20) DEFAULT NULL COMMENT '执行器任务分片参数，格式如 1/2',
  46.   `executor_fail_retry_count` int(11) NOT NULL DEFAULT '0' COMMENT '失败重试次数',
  47.   `trigger_time` datetime DEFAULT NULL COMMENT '调度-时间',
  48.   `trigger_code` int(11) NOT NULL COMMENT '调度-结果',
  49.   `trigger_msg` text COMMENT '调度-日志',
  50.   `handle_time` datetime DEFAULT NULL COMMENT '执行-时间',
  51.   `handle_code` int(11) NOT NULL COMMENT '执行-状态',
  52.   `handle_msg` text COMMENT '执行-日志',
  53.   `alarm_status` tinyint(4) NOT NULL DEFAULT '0' COMMENT '告警状态：0-默认、1-无需告警、2-告警成功、3-告警失败',
  54.   PRIMARY KEY (`id`),
  55.   KEY `I_trigger_time` (`trigger_time`),
  56.   KEY `I_handle_code` (`handle_code`)
  57. ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
  59. CREATE TABLE `xxl_job_log_report` (
  60.   `id` int(11) NOT NULL AUTO_INCREMENT,
  61.   `trigger_day` datetime DEFAULT NULL COMMENT '调度-时间',
  62.   `running_count` int(11) NOT NULL DEFAULT '0' COMMENT '运行中-日志数量',
  63.   `suc_count` int(11) NOT NULL DEFAULT '0' COMMENT '执行成功-日志数量',
  64.   `fail_count` int(11) NOT NULL DEFAULT '0' COMMENT '执行失败-日志数量',
  65.   `update_time` datetime DEFAULT NULL,
  66.   PRIMARY KEY (`id`),
  67.   UNIQUE KEY `i_trigger_day` (`trigger_day`) USING BTREE
  68. ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
  70. CREATE TABLE `xxl_job_logglue` (
  71.   `id` int(11) NOT NULL AUTO_INCREMENT,
  72.   `job_id` int(11) NOT NULL COMMENT '任务，主键ID',
  73.   `glue_type` varchar(50) DEFAULT NULL COMMENT 'GLUE类型',
  74.   `glue_source` mediumtext COMMENT 'GLUE源代码',
  75.   `glue_remark` varchar(128) NOT NULL COMMENT 'GLUE备注',
  76.   `add_time` datetime DEFAULT NULL,
  77.   `update_time` datetime DEFAULT NULL,
  78.   PRIMARY KEY (`id`)
  79. ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
  81. CREATE TABLE `xxl_job_registry` (
  82.   `id` int(11) NOT NULL AUTO_INCREMENT,
  83.   `registry_group` varchar(50) NOT NULL,
  84.   `registry_key` varchar(255) NOT NULL,
  85.   `registry_value` varchar(255) NOT NULL,
  86.   `update_time` datetime DEFAULT NULL,
  87.   PRIMARY KEY (`id`),
  88.   KEY `i_g_k_v` (`registry_group`,`registry_key`,`registry_value`)
  89. ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
  91. CREATE TABLE `xxl_job_group` (
  92.   `id` int(11) NOT NULL AUTO_INCREMENT,
  93.   `app_name` varchar(64) NOT NULL COMMENT '执行器AppName',
  94.   `title` varchar(12) NOT NULL COMMENT '执行器名称',
  95.   `address_type` tinyint(4) NOT NULL DEFAULT '0' COMMENT '执行器地址类型：0=自动注册、1=手动录入',
  96.   `address_list` text COMMENT '执行器地址列表，多地址逗号分隔',
  97.   `update_time` datetime DEFAULT NULL,
  98.   PRIMARY KEY (`id`)
  99. ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
  101. CREATE TABLE `xxl_job_user` (
  102.   `id` int(11) NOT NULL AUTO_INCREMENT,
  103.   `username` varchar(50) NOT NULL COMMENT '账号',
  104.   `password` varchar(50) NOT NULL COMMENT '密码',
  105.   `role` tinyint(4) NOT NULL COMMENT '角色：0-普通用户、1-管理员',
  106.   `permission` varchar(255) DEFAULT NULL COMMENT '权限：执行器ID列表，多个逗号分割',
  107.   PRIMARY KEY (`id`),
  108.   UNIQUE KEY `i_username` (`username`) USING BTREE
  109. ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
  111. CREATE TABLE `xxl_job_lock` (
  112.   `lock_name` varchar(50) NOT NULL COMMENT '锁名称',
  113.   PRIMARY KEY (`lock_name`)
  114. ) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;
  116. 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' );
  117. 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', '');
  118. INSERT INTO `xxl_job_user`(`id`, `username`, `password`, `role`, `permission`) VALUES (1, 'admin', 'e10adc3949ba59abbe56e057f20f883e', 1, NULL);
  119. INSERT INTO `xxl_job_lock` ( `lock_name`) VALUES ( 'schedule_lock');
  121. commit;

数据表结构
image.png
调度中心支持集群部署，集群情况下各节点务必连接同一个mysql实例;
如果mysql做主从,调度中心集群节点务必强制走主库;

启动项目

修改admin项目中的配置文件
image.png
启动项目
image.png
可以通过地址进行访问
调度中心访问地址：http://localhost:18080/xxl-job-admin (该地址执行器将会使用到，作为回调地址)
默认登录账号 “admin/123456”, 登录后运行界面如下图所示。
image.png

整合SpringBoot项目

引入依赖

20220708

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

注意：此处版本要与 xxl-job-admin 中版本保持一致。

添加配置类

在项目中添加一个配置类，配置xxl-job相关的配置项

/**
 * <p>
 * xxl-job 配置类
 * </p>
 *
 * @author xupu
 * @since 2022/7/8 15:05:10
 */
@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;
    }

    /**
     * 针对多网卡、容器内部署等情况，可借助 "spring-cloud-commons" 提供的 "InetUtils" 组件灵活定制注册IP；
     *
     *      1、引入依赖：
     *          <dependency>
     *             <groupId>org.springframework.cloud</groupId>
     *             <artifactId>spring-cloud-commons</artifactId>
     *             <version>${version}</version>
     *         </dependency>
     *
     *      2、配置文件，或者容器启动变量
     *          spring.cloud.inetutils.preferred-networks: 'xxx.xxx.xxx.'
     *
     *      3、获取IP
     *          String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress();
     */

}

配置文件

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

实现定时任务

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


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

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

启动当前项目
进入xxl-job-admin进行配置

  1. 任务调度中心，执行器管理
  2. 新增执行器

image.png

  1. 任务调度中心，任务管理
  2. 新增任务

image.png

  1. 测试并启动定时任务

image.png

简单集成成功