分布式任务调度框架xxl-job入门(Cron表达式环境搭建整合SpringBoot广播任务与动态分片)

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了分布式任务调度框架xxl-job入门(Cron表达式环境搭建整合SpringBoot广播任务与动态分片)相关的知识,希望对你有一定的参考价值。

(目录)


xxl-Job分布式任务调度

1.概述

1.1 什么是任务调度

我们可以先思考一下业务场景的解决方案:

以上业务场景的解决方案就是任务调度

任务调度是指系统为了自动完成特定任务,在约定的特定时刻去执行任务的过程。有了任务调度即可解放更多的人力,而是由系统自动去执行任务。


如何实现任务调度?


SpringTask 入门

入门

spring框架中默认就支持了一个任务调度springtask

每隔5s触发 一个方法 : eat() 每隔5s 开始吃饭 我要变成一个胖子

pom文件

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
</dependencies>
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.scheduling.annotation.EnableScheduling;

@SpringBootApplication
@EnableScheduling
public class TaskApplication 
    public static void main(String[] args) 
        SpringApplication.run(TaskApplication.class,args);
    

import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;

import java.util.Date;

@Component
public class HelloJob 
    @Scheduled(cron = "0/5 * * * * ?")
    public void eat()
        System.out.println("5秒中吃一次饭,我想成为一个胖子"+new Date());
    

测试:启动项目,每隔5秒中会执行一次eat方法

  • 集群状态下各个服务都会执行当前任务

1.2 cron表达式

cron表达式是一个字符串, 用来设置定时规则, 由七部分组成, 每部分中间用空格隔开, 每部分的含义如下表所示:

组成部分 含义 取值范围
第一部分 Seconds (秒) 0-59
第二部分 Minutes(分) 0-59
第三部分 Hours(时) 0-23
第四部分 Day-of-Month(天) 1-31
第五部分 Month(月) 0-11或JAN-DEC
第六部分 Day-of-Week(星期) 1-7(1表示星期日)或SUN-SAT
第七部分 Year(年) 可选 1970-2099

另外, cron表达式还可以包含一些特殊符号来设置更加灵活的定时规则, 如下表所示:

符号 含义
? 表示不确定的值。当两个子表达式其中一个被指定了值以后,为了避免冲突,需要将另外一个的值设为“?”。例如:想在每月20日触发调度,不管20号是星期几,只能用如下写法:0 0 0 20 * ?,其中最后以为只能用“?”
* 代表所有可能的值
, 设置多个值,例如”26,29,33”表示在26分,29分和33分各自运行一次任务
- 设置取值范围,例如”5-20”,表示从5分到20分钟每分钟运行一次任务
/ 设置频率或间隔,如"1/15"表示从1分开始,每隔15分钟运行一次任务
L 用于每月,或每周,表示每月的最后一天,或每个月的最后星期几,例如"6L"表示"每月的最后一个星期五"
W 表示离给定日期最近的工作日,例如"15W"放在每月(day-of-month)上表示"离本月15日最近的工作日"
# 表示该月第几个周X。例如”6#3”表示该月第3个周五

cron表达式举例

为了让大家更熟悉cron表达式的用法, 接下来我们列举了一些例子, 如下表所示:

cron表达式 含义
*/5 * * * * ? 每隔5秒运行一次任务
0 0 23 * * ? 每天23点运行一次任务
0 0 1 1 * ? 每月1号凌晨1点运行一次任务
0 0 23 L * ? 每月最后一天23点运行一次任务
0 26,29,33 * * * ? 在26分、29分、33分运行一次任务
0 0/30 9-17 * * ? 朝九晚五工作时间内每半小时运行一次任务
0 15 10 ? * 6#3 每月的第三个星期五上午10:15运行一次任务

1.3 什么是分布式任务调度

当前软件的架构已经开始向分布式架构转变,将单体结构拆分为若干服务,服务之间通过网络交互来完成业务处理。

将任务调度程序分布式构建,这样就可以具有分布式系统的特点,并且提高任务的调度处理能力:

1.4 分布式任务调度面临的问题:

任务调度以集群方式部署,同一个任务调度可能会执行多次

例如:电商系统定期发放优惠券,就可能重复发放优惠券,对公司造成损失,信用卡还款提醒就会重复执行多次,给用户造成烦恼,所以我们需要控制相同的任务在多个运行实例上只执行一次。常见解决方案:


1.5 xxl-Job简介

针对分布式任务调度的需求,市场上出现了很多的产品


XXL-JOB是一个分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。


特性


2.XXL-Job

在分布式架构下,通过XXL-Job实现定时任务

调度中心会发出调度请求,任务执行器接收到请求之后会去执行任务,任务则专注于任务业务的处理。


2.1 环境搭建

2.1.1 调度中心环境要求

2.1.2 源码仓库地址

源码仓库地址 Release Download
https://github.com/xuxueli/xxl-job Download
http://gitee.com/xuxueli0323/xxl-job Download

2.1.3 初始化“调度数据库”

“调度数据库初始化SQL脚本” 执行即可, 共8张表

#
# XXL-JOB v2.2.0-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_cron` varchar(128) NOT NULL COMMENT 任务执行CRON,
  `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 报警邮件,
  `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 执行失败-日志数量,
  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 执行器名称,
  `order` int(11) NOT NULL DEFAULT 0 COMMENT 排序,
  `address_type` tinyint(4) NOT NULL DEFAULT 0 COMMENT 执行器地址类型:0=自动注册、1=手动录入,
  `address_list` varchar(512) DEFAULT NULL COMMENT 执行器地址列表,多地址逗号分隔,
  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`, `order`, `address_type`, `address_list`) VALUES (1, xxl-job-executor-sample, 示例执行器, 1, 0, NULL);
INSERT INTO `xxl_job_info`(`id`, `job_group`, `job_cron`, `job_desc`, `add_time`, `update_time`, `author`, `alarm_email`, `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, 0 0 0 * * ? *, 测试任务1, 2018-11-03 22:21:31, 2018-11-03 22:21:31, XXL, , 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;

注意:


2.1.4 配置部署“调度中心”

调度中心项目:xxl-job-admin

作用:统一管理任务调度平台上调度任务,负责触发调度执行,并且提供任务管理平台。

步骤一:调度中心配置

调度中心配置文件地址:/xxl-job/xxl-job-admin/src/main/resources/application.properties

数据库的连接信息修改为自己的数据库

### web
server.port=8888
server.servlet.context-path=/xxl-job-admin

### actuator
management.server.servlet.context-path=/actuator
management.health.mail.enabled=false

### resources
spring.mvc.servlet.load-on-startup=0
spring.mvc.static-path-pattern=/static/**
spring.resources.static-locations=classpath:/static/

### freemarker
spring.freemarker.templateLoaderPath=classpath:/templates/
spring.freemarker.suffix=.ftl
spring.freemarker.charset=UTF-8
spring.freemarker.request-context-attribute=request
spring.freemarker.settings.number_format=0.##########

### mybatis
mybatis.mapper-locations=classpath:/mybatis-mapper/*Mapper.xml
#mybatis.type-aliases-package=com.xxl.job.admin.core.model

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

### datasource-pool
spring.datasource.type=com.zaxxer.hikari.HikariDataSource
spring.datasource.hikari.minimum-idle=10
spring.datasource.hikari.maximum-pool-size=30
spring.datasource.hikari.auto-commit=true
spring.datasource.hikari.idle-timeout=30000
spring.datasource.hikari.pool-name=HikariCP
spring.datasource.hikari.max-lifetime=900000
spring.datasource.hikari.connection-timeout=10000
spring.datasource.hikari.connection-test-query=SELECT 1

### xxl-job, email
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=xxx@qq.com
spring.mail.password=xxx
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.starttls.enable=true
spring.mail.properties.mail.smtp.starttls.required=true
spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory

### xxl-job, access token
xxl.job.accessToken=

### xxl-job, i18n (default is zh_CN, and you can choose "zh_CN", "zh_TC" and "en")
xxl.job.i18n=zh_CN

## xxl-job, triggerpool max size
xxl.job.triggerpool.fast.max=200
xxl.job.triggerpool.slow.max=100

### xxl-job, log retention days
xxl.job.logretentiondays=30

步骤二:部署项目

如果已经正确进行上述配置,可将项目编译打包部署。

启动方式一:这是一个springboot项目,可以在idea中直接启动,不推荐使用

启动方式二:

  • 执行maven打包命令:package
  • 打完包以后,从项目的target目录中找到jar包拷贝到不带空格和中文的目录下
  • 执行以下命令,启动项目
java -jar xxl-job-admin-2.2.0-SNAPSHOT.jar

调度中心访问地址:http://localhost:8888/xxl-job-admin (该地址执行器将会使用到,作为回调地址)

启动方式三:docker部署微服务

  • 初始化数据库

    位置:/xxl-job/doc/db/tables_xxl_job.sql 共8张表

  • 创建容器

    docker run -e PARAMS="--spring.datasource.url=jdbc:mysql://192.168.200.130:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai --spring.datasource.username=root --spring.datasource.password=root"  -p 8888:8080 -v /tmp:/data/applogs --name xxljob --privileged=true  -id xuxueli/xxl-job-admin:2.2.0
    

默认登录账号 “admin / 123456”, 登录后运行界面如下图所示。

至此“调度中心”项目已经部署成功。


2.2 入门案例编写

2.2.1 配置执行器

在任务调度中心,点击进入"执行器管理"界面, 如下图:

以下是执行器的属性说明:

属性名称 说明
AppName 是每个执行器集群的唯一标示AppName, 执行器会周期性以AppName为对象进行自动注册。可通过该配置自动发现注册成功的执行器, 供任务调度时使用;
名称 执行器的名称, 因为AppName限制字母数字等组成,可读性不强, 名称为了提高执行器的可读性;
排序 执行器的排序, 系统中需要执行器的地方,如任务新增, 将会按照该排序读取可用的执行器列表;
注册方式 调度中心获取执行器地址的方式;
机器地址 注册方式为"手动录入"时有效,支持人工维护执行器的地址信息;

具体操作:

(1)新增执行器:

(2)自动注册和手动注册的区别和配置


2.2.2 在调度中心新建任务

在任务管理->新建,填写以下内容

  1. 执行器:任务的绑定的执行器,任务触发调度时将会自动发现注册成功的执行器, 实现任务自动发现功能; 另一方面也可以方便的进行任务分组。每个任务必须绑定一个执行器, 可在 "执行器管理" 进行设置

  2. 任务描述:任务的描述信息,便于任务管理

路由策略:当执行器集群部署时,提供丰富的路由策略,包括

  1. Cron:触发任务执行的Cron表达式;

  2. 运行模式:

  1. JobHandler:运行模式为 "BEAN模式" 时生效,对应执行器中新开发的JobHandler类“@JobHandler”注解自定义的value值;

  2. 阻塞处理策略:调度过于密集执行器来不及处理时的处理策略;

  1. 子任务:每个任务都拥有一个唯一的任务ID(任务ID可以从任务列表获取),当本任务执行结束并且执行成功时,将会触发子任务ID所对应的任务的一次主动调度。

  2. 任务超时时间:支持自定义任务超时时间,任务运行超时将会主动中断任务;

  3. 失败重试次数;支持自定义任务失败重试次数,当任务失败时将会按照预设的失败重试次数主动进行重试;

  4. 报警邮件:任务调度失败时邮件通知的邮箱地址,支持配置多邮箱地址,配置多个邮箱地址时用逗号分隔;

  5. 负责人:任务的负责人;

  6. 执行参数:任务执行所需的参数;


2.2.3 搭建springboot项目

新建项目:xxljob-test

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <!-- xxl-job -->
    <dependency>
        <groupId>com.xuxueli</groupId>
        <artifactId>xxl-job-core</artifactId>
        <version>2.2.0</version>
    </dependency>
</dependencies>

注意:


application.properties

# web port
server.port=$port:8801
# no web
#spring.main.web-environment=false
### xxl-job admin address list, such as "http://address" or "http://address01,http://address02" 调度中心地址
xxl.job.admin.addresses=http://localhost:8888/xxl-job-admin
### xxl-job, access token
xxl.job.accessToken=
### xxl-job executor appname 执行器名称
xxl.job.executor.appname=xxl-job-executor-sample
### 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=
xxl.job.executor.port=$executor.port:9999
### xxl-job executor log-path 创建文件路径 D:/logs
xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler
### xxl-job executor log-retention-days
xxl.job.executor.logretentiondays=30

(2)引导类:

package com.itheima.xxljob;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class XxlJobApplication 

    public static void main(String[] args) 
        SpringApplication.run(XxlJobApplication.class,args);
    


2.2.4 添加xxl-job配置

添加配置类:

这个类主要是创建了任务执行器,参考官方案例编写,无须改动

package com.heima.test.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;
@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;
    


2.2.5 创建任务

package com.itheima.xxljob.job;

import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.annotation.XxlJob;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

import java.time.LocalDateTime;


@Component
public class HelloJob 

    @Value("$server.port")
    private String appPort;

    @XxlJob("helloJob")
    public ReturnT<String> hello(String param) throws Exception 
        System.out.println("helloJob:"+ LocalDateTime.now()+",端口号"+appPort);
        return ReturnT.SUCCESS;
    


@XxlJob("helloJob")这个一定要与调度中心新建任务的JobHandler的值保持一致,如下图:


2.2.6 测试

(1)首先启动调度中心

(2)启动xxljob-test项目,为了展示更好的效果,可以同时启动三个项目,用同一个JobHandler,查看处理方式。

在启动多个项目的时候,端口需要切换,连接xxl-job的执行器端口不同相同

idea配置如下:

  • 编辑配置,Edit Configurations...

  • 选中XxlJobApplication,点击复制

  • 修改参数

  • 启动:选中8802启动项目

服务三:项目端口:8803,执行器端口:9997

(3)测试效果

三个项目启动后,可以查看到是轮询的方式分别去执行当前调度任务。


2.3 广播任务和动态分片

2.3.1 什么是作业分片

作业分片是指任务的分布式执行,需要将一个任务拆分为多个独立的任务项,然后由分布式的应用实例 分别执行某一个或几个分片项。

2.3.2 XXL-JOB分片

执行器集群部署时,任务路由策略选择”分片广播”情况下,一次任务调度将会广播触发对应集群中所有执行器执行一次任务,同时系统自动传递分片参数;可根据分片参数开发分片任务;

“分片广播” 以执行器为维度进行分片,支持动态扩容执行器集群从而动态增加分片数量,协同进行业务处理;在进行大数据量业务操作时可显著提升任务处理能力和速度。

“分片广播” 和普通任务开发流程一致,不同之处在于可以获取分片参数,获取分片参数进行分片业务处理。

2.3.3 XXL-JOB支持分片的好处

  • 分片项与业务处理解耦 XXL-JOB并不直接提供数据处理的功能,框架只会将分片项分配至各个运行中的作业服务器,开发者需 要自行处理分片项与真实数据的对应关系。
  • 最大限度利用资源 基于业务需求配置合理数量的执行器服务,合理设置分片,作业将会最大限度合理的利用分布式资源。

2.3.4 适用场景

  • 分片任务场景:10个执行器的集群来处理10w条数据,每台机器只需要处理1w条数据,耗时降低10倍;
  • 广播任务场景:广播执行器机器运行shell脚本、广播集群节点进行缓存更新等

2.3.5 分片广播案例演示

目标:实现XXL-JOB作业分片的演示

方案分析:规划一个任务,两个分片,对应两个执行器,每个分片处理一部分任务。

实现步骤:

  • 创建分片执行器

  • 创建任务

    指定刚才创建的分片执行器,在路由策略这一栏选择分片广播

  • 分片广播代码

    分片参数属性说明:

    • index:当前分片序号(从0开始),执行器集群列表中当前执行器的序号;

    • total:总分片数,执行器集群的总机器数量;

    目前有一万条数据,使用两个分片同时执行

    /**
         * 2、分片广播任务
         */
    @XxlJob("shardingJobHandler")
    public ReturnT<String> shardingJobHandler(String param) throws Exception 
    
        // 分片参数
        ShardingUtil.ShardingVO shardingVO = ShardingUtil.getShardingVo();
        XxlJobLogger.log("分片参数:当前分片序号 = , 总分片数 = ", shardingVO.getIndex(), shardingVO.getTotal());
    
        List<Integer> list = getList();
        for (Integer integer : list) 
            if(integer % shardingVO.getTotal() == shardingVO.getIndex())
                System.out.println("第"+shardingVO.getIndex()+"分片执行,执行数据为:"+integer);
            
        
    
        return ReturnT.SUCCESS;
    
    
    public static List<Integer> getList()
        List<Integer> list = new ArrayList<>();
        for (int i = 0; i < 10000 ; i++) 
            list.add(i);
        
        return list;
    
    

结论:


内网穿透

注册 及 配置

https://natapp.cn/

购买隧道

点击免费购买

购买完成,在我的隧道中配置


启动内网穿透

windows用户

修改资料中的 start.bat文件

#                      将秘钥改成自己的
start natapp -authtoken=59bb54a64f86b4a6

双击start.bat

可以将外网地址  注册到调度中心中

当云服务器中的调度任务触发时


通知  ====> 外网地址 ====> 转发本地ip+port 

linux用户及mac用户

mac用户根据实际情况下载客户端 https://natapp.cn/#download

linux用户直接将linux文件夹中的natapp拷贝

在Linux/Mac 下 需要先给执行权限

      chmod a+x natapp
 然后再运行
     ./natapp
linux ,同样给予可执行权限之后,运行
./natapp -authtoken=59bb54a64f86b4a6

将上面 密钥改成自己的


xxljob配置参考

引入xxljob依赖

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

准备xxljob配置

@Data
@ConfigurationProperties(prefix = "xxljob")
public class XxJobConfigProperties 
    // 调度中心地址 
    private String adminAddress = "http://localhost:8888/xxl-job-admin";
    // 注册 执行器名称
    private String executorName = "default";
    // 当前执行器端口
    private int executorPort;
    // 日志文件输出路径
    private String logPath;
    // 注册到调度中心的  执行器地址
    private String executorAddress;

配置执行器

@Slf4j
@Configuration
@EnableConfigurationProperties(XxJobConfigProperties.class)
public class XxlJobConfig 
	@Autowired
    XxJobConfigProperties xxJobConfigProperties;
    @Bean
    public XxlJobSpringExecutor xxlJobExecutor() 
        log.info(">>>>>>>>>>> xxl-job config init.");
        XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
        xxlJobSpringExecutor.setAdminAddresses(xxJobConfigProperties.getAdminAddress());
        xxlJobSpringExecutor.setAppname(xxJobConfigProperties.getExecutorName());
        xxlJobSpringExecutor.setPort(xxJobConfigProperties.getExecutorPort());
        xxlJobSpringExecutor.setLogRetentionDays(30);
        xxlJobSpringExecutor.setLogPath(xxJobConfigProperties.getLogPath());
        xxlJobSpringExecutor.setAddress(xxJobConfigProperties.getExecutorAddress());
        return xxlJobSpringExecutor;
    

application.yml中配置

如果用的虚拟机:

xxljob:
  admin-address: http://192.168.200.130:8888/xxl-job-admin
  executor-name: leadnews-article-executor
  executor-port: 9999
  log-path: C:/xxljob/logs

如果用的云服务器:

xxljob:
  admin-address: http://外网地址:8888/xxl-job-admin
  executor-name: leadnews-article-executor
  executor-port: 9999
  log-path: C:/xxljob/logs
  executor-address: http://uubyp8.natappfree.cc  # 内网穿透地址  

以上是关于分布式任务调度框架xxl-job入门(Cron表达式环境搭建整合SpringBoot广播任务与动态分片)的主要内容,如果未能解决你的问题,请参考以下文章

你只会用 xxl-job?一款更强大新一代分布式任务调度框架来了,太强大了!

只会用 xxl-job?更强大的新一代分布式任务调度框架来了!

只会用 xxl-job?更强大的新一代分布式任务调度框架来了!

只会用 xxl-job?更强大的新一代分布式任务调度框架来了!

你只会用 xxl-job?一款更强大新一代分布式任务调度框架来了,太强大了!

XXL-Job分布式任务调度框架-- 介绍和服务搭建1