火影 发表于 2024-6-14 23:14:18

Xxl-Job分布式定时任务

一、简介

XXL-JOB是一个分布式任务调度平台,是一个分布式定时任务的解决方案,作者的名字叫许雪里。
解决问题:在分布式情况下,传统的定时任务,如SpringTask、Timer等,存在定时任务重复执行,无法追踪任务执行结果等,使用Xxl-job可以有效制止在分布式情况下,定时任务出现的各类问题,同时还支持任务结果日志,数据统计,预警邮件等功能。
开源地址:
xxl-job: 一个分布式任务调度平台,其核心计划目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产物线,开箱即用。
GitHub - xuxueli/xxl-job: A distributed task scheduling framework.(分布式任务调度平台XXL-JOB)
源码介绍:
项目源码分为了xxl-job的核心、调度器以及执行器三个部分,在源码中也都有相应的实例,后文也将分别介绍。

https://img-blog.csdnimg.cn/img_convert/6b40e6da102c1a6a340e6481f395e9d8.png
二、快速入门

(一) 初始化数据库

需要注意的是,在项目源码中有一个数据库初始化的脚本,在使用之前需要执行此脚本,创建底子的表布局:

https://img-blog.csdnimg.cn/img_convert/48cfae5726516c1fb6335b69ef187f25.png
- xxl_job_lock:任务调度锁表;
- xxl_job_group:执行器信息表,维护任务执行器信息;
- xxl_job_info:调度扩展信息表: 用于保存XXL-JOB调度任务的扩展信息,如任务分组、任务名、机器地址、执行器、执行入参和报警邮件等等;
- xxl_job_log:调度日志表: 用于保存XXL-JOB任务调度的历史信息,如调度结果、执行结果、调度入参、调度机器和执行器等等;
- xxl_job_logglue:任务GLUE日志:用于保存GLUE更新历史,用于支持GLUE的版本回溯功能;
- xxl_job_registry:执行器注册表,维护在线的执行器和调度中心机器地址信息;
- xxl_job_user:系统用户表; (二) 调度器

调度器,是用于统一管理任务调度平台上调度任务,负责触发调度执行,并且提供任务管理平台。在项目源码中对应为xxl-job-admin,因此我们需要修改xxl-job-admin的配置,以启动调度中心。
### 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 将调度中心的数据库配置修改为我们自己的数据库配置,然后启动调度中心项目,并访问:http://IP:port/xxl-job-admin
初始账号暗码:admin/123456 , 登录背景之后看到的页面信息如下:

https://img-blog.csdnimg.cn/img_convert/b4118e2b83b9b15b60a9b101859ebcb0.png
至此,以本地项目标方式启动调度中心就完成了,固然也可以通过docker容器的方式来创建调度中心,这里提供docker下令,以供参考:
version: '3'
services:
xxl-job:
    image: xuxueli/xxl-job-admin:2.3.0
    container_name: xxl-job
    environment:
      PARAMS: "--spring.datasource.url=jdbc:mysql://ip:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai--spring.datasource.username=root--spring.datasource.password=root"
    ports:
      - 8888:8080
    volumes:
      - /data/docker/xxl-job/logs/:/data/applogs/xxl-job/ (三) 配置任务

创建完成调度中心之后,先在页面创建一个任务,方便我们后续的测试。在调度中心,任务管理菜单中,可以新建一个任务:

https://img-blog.csdnimg.cn/img_convert/4e8e00eaf9fdb0e5cfee6c197f8b8ff9.png
注意:这里新建的任务采用的是默认的示例执行器,假如想要使用自己定义的执行器,需要先在执行器管理中创建执行器,然后为任务分配执行器。
关于表单参数的解释:
任务表单参数

[*]底子配置


[*]执行器:每个任务必须绑定一个执行器, 方便给任务举行分组
[*]任务描述:任务的描述信息,便于任务管理;
[*]负责人:任务的负责人;
[*]报警邮件:任务调度失败时邮件关照的邮箱地址,支持配置多邮箱地址,配置多个邮箱地址时用逗号分隔

[*]调度类型:


[*]无:该类型不会主动触发调度;
[*]CRON:该类型将会通过CRON,触发任务调度;
[*]固定速度:该类型将会以固定速度,触发任务调度;按照固定的隔断时间,周期性触发;

[*]任务配置


[*]运行模式:


[*]

[*]BEAN模式:任务以JobHandler方式维护在执行器端;需要结合 "JobHandler" 属性匹配执行器中任务;
[*]JobHandler:运行模式为 "BEAN模式" 时生效,对应执行器中新开发的JobHandler类“@JobHandler”注解自定义的value值;



[*]任务参数:任务执行所需的参数;

[*]壅闭处理处罚策略
壅闭处理处罚策略:调度过于麋集执行器来不及处理处罚时的处理处罚策略;


[*]

[*]单机串行(默认):调度请求进入单机执行器后,调度请求进入FIFO(First Input First Output)队列并以串行方式运行;
[*]丢弃后续调度:调度请求进入单机执行器后,发现执行器存在运行的调度任务,本次请求将会被丢弃并标记为失败;
[*]覆盖之前调度:调度请求进入单机执行器后,发现执行器存在运行的调度任务,将会终止运行中的调度任务并清空队列,然后运行本地调度任务;


[*]路由策略
当执行器集群摆设时,提供丰富的路由策略,包括;


[*]FIRST(第一个):固定选择第一个呆板;
[*]LAST(最后一个):固定选择最后一个呆板;
[*]ROUND(轮询)
[*]RANDOM(随机):随机选择在线的呆板;
[*]CONSISTENT_HASH(一致性HASH):每个任务按照Hash算法固定选择某一台呆板,且所有任务均匀散列在不同呆板上。
[*]LEAST_FREQUENTLY_USED(最不经常使用):使用频率最低的呆板优先被选举;
[*]LEAST_RECENTLY_USED(最近最久未使用):最久未使用的呆板优先被选举;
[*]FAILOVER(故障转移):按照次序依次举行心跳检测,第一个心跳检测乐成的呆板选定为目标执行器并发起调度;
[*]BUSYOVER(繁忙转移):按照次序依次举行空闲检测,第一个空闲检测乐成的呆板选定为目标执行器并发起调度;
[*]SHARDING_BROADCAST(分片广播):广播触发对应集群中所有呆板执行一次任务,同时体系自动传递分片参数;可根据分片参数开发分片任务;
(四) 执行器

执行器,顾名思义是用来执行任务的,在项目中使用执行器,来指定配置的定时任务。以上述配置的示例执行器任务为例,使用如下:

[*]项目中引入依靠
<!--xxl-job-->
<dependency>
<groupId>com.xuxueli</groupId>
<artifactId>xxl-job-core</artifactId>
<version>2.3.0</version>
</dependency>
[*]配置调度中心地址信息
# xxl-job配置
xxl:
job:
    admin:
      addresses: http://127.0.0.1:8090/xxl-job-admin
    accessToken: default_token
    executor:
      appname: xxl-job-executor-sample
      address:
      ip:
      port: 9999
      logpath: ./logs/xxl-job/executor/
      logretentiondays: 30
logging:
config: classpath:logback.xml
[*]添加配置类
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.setAccessToken(accessToken);
      xxlJobSpringExecutor.setPort(port);
      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();
   */

}
[*]创建执行器
因为在调度中心中创建任务的时候,指定了任务运行模式为BEAN,并且指定了JobHandler,因此在编写执行器的时候也需要和上述的JobHandler对应。

https://img-blog.csdnimg.cn/img_convert/27053d9c43e17bf40f1f78dbb9426492.png
@Slf4j
@Component
public class HelloJob {
    @XxlJob("demoHandler")
    public void helloJob() {
      log.info("简单任务执行了。。。。");
    }
} 创建完成后重启项目,然后进入调度中心查看:

[*]执行器管理

https://img-blog.csdnimg.cn/img_convert/f75e2350f5b5b79e8bd39ae9635ee776.png
在执行器管理中,自己项目应用已经注册进来了,并且可以或许查看到相应的信息。

https://img-blog.csdnimg.cn/img_convert/75ec4e3d7982d7b16380a3b59ccef4fd.png
以下是执行器的属性阐明:
属性名称
阐明
AppName
是每个执行器集群的唯一标示AppName, 执行器会周期性以AppName为对象举行自动注册。可通过该配置自动发现注册乐成的执行器, 供任务调度时使用;
名称
执行器的名称, 因为AppName限定字母数字等组成,可读性不强, 名称为了提高执行器的可读性;
排序
执行器的排序, 体系中需要执行器的地方,如任务新增, 将会按照该排序读取可用的执行器列表;
注册方式
调度中心获取执行器地址的方式;
呆板地址
注册方式为"手动录入"时有效,支持人工维护执行器的地址信息;
自动注册和手动注册的区别和配置

https://img-blog.csdnimg.cn/img_convert/0697de7eb34bf1fe30a990fb233c7b66.png

[*]启动任务
在任务管理中,找到刚刚创建的任务,然后点击启动:

https://img-blog.csdnimg.cn/img_convert/8bd9502e280fb5d84deb8470d7be1d53.png
等候状态变为running,这个时候,会到自己的项目查看日志,发现,定时任务开始执行了:

https://img-blog.csdnimg.cn/img_convert/ee70e8faec76f873bc6b48d8bda63d7c.png
同时,可以在调度日志中看到调度的情况:

https://img-blog.csdnimg.cn/img_convert/a3d1ebd37ff52e9680b1d5905c5e95da.png
至此,关于xxl-job的底子核心功能使用就完成了。
三、任务配置

配置属性详细阐明

[*]底子配置:
[*]-执行器:任务的绑定的执行器,任务触发调度时将会自动发现注册乐成的执行器,实现任务自动发现功能;另一方面也可以方便的举行任务分组。每个任务必须绑定一个执行器,可在"执行器管理"举行设置;
[*]-任务描述:任务的描述信息,便于任务管理;
[*]-负责人:任务的负责人;
[*]-报警邮件:任务调度失败时邮件关照的邮箱地址,支持配置多邮箱地址,配置多个邮箱地址时用逗号分隔;
[*]触发配置:
[*]-调度类型:
[*]无:该类型不会主动触发调度;
[*]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队列并以串行方式运行;
[*]丢弃后续调度:调度请求进入单机执行器后,发现执行器存在运行的调度任务,本次请求将会被丢弃并标记为失败;
[*]覆盖之前调度:调度请求进入单机执行器后,发现执行器存在运行的调度任务,将会终止运行中的调度任务并清空队列,然后运行本地调度任务;
[*]-任务超时时间:支持自定义任务超时时间,任务运行超时将会主动停止任务;
[*]-失败重试次数;支持自定义任务失败重试次数,当任务失败时将会按照预设的失败重试次数主动举行重试
新增任务表单中,任务配置模块主要是运行模式、JobHandler以及任务参数。

https://img-blog.csdnimg.cn/img_convert/2a3352c903c82b955b8cf11a8b91d5c6.png
(一) 运行模式

这里以Java示例,主要是BEAN和GLUE两种模式
1. BEAN

BEAN模式包罗类情势和方法情势。
一、类情势

Bean模式任务,支持基于类的开发方式,每个任务对应一个Java类。
长处:不限定项目情况,兼容性好。即使是无框架项目,如main方法直接启动的项目也可以提供支持,可以参考示例项目 “xxl-job-executor-sample-frameless”;
缺点:每个任务需要占用一个Java类,造成类的浪费;不支持自动扫描任务并注入到执行器容器,需要手动注入。
示例:

[*]创建BEAN模式的任务

https://img-blog.csdnimg.cn/img_convert/ec9400b25b99cae6d96d056d6f726943.png

[*]自定义类
自己创建执行类的实现,继续自"com.xxl.job.core.handler.IJobHandler"的JobHandler类,实现此中任务方法。
@Slf4j
public class BeanClassJob extends IJobHandler {

    @Override
    public void execute() throws Exception {
      log.info("BEAN类形式任务执行了,{}", LocalDateTime.now());
    }


}
[*]注册
手动注册执行器的实现类
XxlJobExecutor.registJobHandler("beanClassJob", new BeanClassJob()); 二、方法情势

Bean模式任务,支持基于方法的开发方式,每个任务对应一个方法。
长处:每个任务只需要开发一个方法,并添加”@XxlJob”注解即可,更加方便、快速。支持自动扫描任务并注入到执行器容器。
缺点:略。
基于方法开发的任务,底层会生成JobHandler代理,和基于类的方式一样,任务也会以JobHandler的情势存在于执行器任务容器中。
@Slf4j
@Component
public class HelloJob {
    @XxlJob("demoHandler")
    public void helloJob() {
      log.info("简单任务执行了。。。。");
    }
} 这种情势也是寻常我们使用最多的一种情势。
2. GLUE

任务以源码方式维护在调度中心,支持通过Web IDE在线更新,实时编译和生效,因此不需要指定JobHandler。开发流程如下:

[*]新增调度任务
运行模式选中 “GLUE模式(Java)”;

https://img-blog.csdnimg.cn/img_convert/18a42d3ae0e1c100ee8023730414ac7c.png

[*]开发任务代码
选中指定任务,点击该任务右侧“GLUE”按钮,将会前往GLUE任务的Web IDE界面,在该界面支持对任务代码举行开发(也可以在IDE中开发完成后,复制粘贴到编辑中)。

https://img-blog.csdnimg.cn/img_convert/38699df0657912244bea92441b4a9d8a.png

https://img-blog.csdnimg.cn/img_convert/2075b69900e9fe8bf2719dcb5f4b713e.png
版本回溯功能(支持30个版本的版本回溯):在GLUE任务的Web IDE界面,选择右上角下拉框“版本回溯”,会列出该GLUE的更新汗青,选择相应版本即可表现该版本代码,保存后GLUE代码即回退到对应的汗青版本;

https://img-blog.csdnimg.cn/img_convert/7560203c5c2557ad997a99e38be242f8.png
编辑完成后,可以直接点击启动,查看日志:

https://img-blog.csdnimg.cn/img_convert/6bd3823421c3c4dafb751de1c092d577.png
同时查看控制台打印:

https://img-blog.csdnimg.cn/img_convert/fe9d02706c258cfc6e76943d40808b4e.png
(二) 高级配置

在任务配置的高级配置模块,可以设置路由策略、子任务等等,这块的配置主要是针对分布式的定时任务集群举行配置的,配置后,采用指定的方式选取服务节点执行一次定时任务。在此处的配置中,比较常用的就是路由策略和壅闭处理处罚策略。

https://img-blog.csdnimg.cn/img_convert/0e94f2e2c52a01721728683f5ddeae39.png
1. 路由策略

可以发现路由策略其实是有许多,包括:
● FIRST(第一个):固定选择第一个呆板;
● LAST(最后一个):固定选择最后一个呆板;
● ROUND(轮询)
● RANDOM(随机):随机选择在线的呆板;
● CONSISTENT_HASH(一致性HASH):每个任务按照Hash算法固定选择某一台呆板,且所有任务均匀散列在不同呆板上。
● LEAST_FREQUENTLY_USED(最不经常使用):使用频率最低的呆板优先被选举;
● LEAST_RECENTLY_USED(最近最久未使用):最久未使用的呆板优先被选举;
● FAILOVER(故障转移):按照次序依次举行心跳检测,第一个心跳检测乐成的呆板选定为目标执行器并发起调度;
● BUSYOVER(繁忙转移):按照次序依次举行空闲检测,第一个空闲检测乐成的呆板选定为目标执行器并发起调度;
● SHARDING_BROADCAST(分片广播):广播触发对应集群中所有呆板执行一次任务,同时体系自动传递分片参数;可根据分片参数开发分片任务;

https://img-blog.csdnimg.cn/img_convert/9d962a1bf3085257f4d0f1d58329389a.png
2. 壅闭处理处罚策略

壅闭处理处罚策略:调度过于麋集执行器来不及处理处罚时的处理处罚策略;
● 单机串行(默认):调度请求进入单机执行器后,调度请求进入FIFO(First Input First Output)队列并以串行方式运行;
● 丢弃后续调度:调度请求进入单机执行器后,发现执行器存在运行的调度任务,本次请求将会被丢弃并标记为失败;
● 覆盖之前调度:调度请求进入单机执行器后,发现执行器存在运行的调度任务,将会终止运行中的调度任务并清空队列,然后运行本地调度任务;

https://img-blog.csdnimg.cn/img_convert/11cd0a13aa23321e0bcc8886ddbb370b.png
四、操纵指南

关于xxl-job还有许多其他的操纵,在这里介绍一下大概用到的操纵。
(一) 用户管理

进入 “用户管理” 界面,可查看和管理用户信息;如今用户分为两种角色:
管理员:拥有全量权限,支持在线管理用户信息,为用户分配权限,权限分配粒度为执行器;
寻常用户:仅拥有被分配权限的执行器,及相干任务的操纵权限;

https://img-blog.csdnimg.cn/img_convert/446512f4c693958c8946fabac4f7ba10.png
可以通过新增用户,并为其分配执行器的权限:

https://img-blog.csdnimg.cn/img_convert/ba7e3c2551875a13eaeda5af836dbe69.png
使用新用户账号登录

https://img-blog.csdnimg.cn/img_convert/4b61975e0f85ef7085f3e5f9e227fdf7.png
新增用户之后,在新增任务的时候,可以将任务的责任人修改为对应的用户。
(二) 告警邮件

假如定时任务执行失败堕落等,xxl-job可以实现邮件关照的情势来提醒负责人。

[*]配置调度中心
在使用告警邮件之前,需要配置调度中心的邮件发送账号信息,也就是这个邮件用什么账号举行发送,这里需要发送邮件账号开通smtp服务,并获取到授权码,关于这部分可以查看本人之前的邮件发送一问,这里不做赘述。
### xxl-job, email
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=
spring.mail.from=
spring.mail.password=
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-admin调度中心项目中,找到如上配置,修改username、from和password为自己的邮件发送地址。

[*]配置任务
在配置任务的时候,可以执行报警邮件,这里的邮件地址就是接受报警邮件的地址。

https://img-blog.csdnimg.cn/img_convert/3496fa95de6b9207a641af74270a7f91.png

[*]测试
配置完成之后,停掉执行器,将调度器重启,然后开启任务,等候调度日志出现失败记载,同时查看接收的邮件信息。

https://img-blog.csdnimg.cn/img_convert/a6f5629e2dd5adfa9aaa5a78c82eabd9.png
(三) 任务结果

许多时候,定时任务执行,需要手动处理处罚异常和执行结果,比喻代码出现异常,返回执行失败给调度中心,而不是执行乐成。自v1.6.2之后,任务执行结果通过 “IJobHandler” 的返回值 “ReturnT” 举行判断;当返回值符合 “ReturnT.code == ReturnT.SUCCESS_CODE” 时表示任务执行乐成,否则表示任务执行失败,而且可以通过 “ReturnT.msg” 回调错误信息给调度中心;从而,在任务逻辑中可以方便的控制任务执行结果;

/**
   * 任务的执行结果
   */
@XxlJob(value = "taskRunResult", init = "init", destroy = "destroy")
public void taskRunResultExecutor() {
    // 假设在执行这一步的时候出现报错
    if (true) {
      log.error("任务执行报错了!, 异常信息:");
      XxlJobHelper.handleFail("任务执行报错了!");
      return;
    }
    log.info("任务执行成功!");
    XxlJobHelper.handleSuccess("任务执行成功!");
}

public void init() {
    log.info("初始化 定时任务 =====> 准备开始执行定时任务!");
}

public void destroy() {
    log.info("定时任务 执行完成=====> 准备销毁!");
}
(四) 访问令牌

为提升体系安全性,调度中心和执行器举行安全性校验,双方AccessToken匹配才允许通讯;调度中心和执行器,可通过配置项 “xxl.job.accessToken” 举行AccessToken的设置。调度中心和执行器,假如需要正常通讯,只有两种设置;
设置一:调度中心和执行器,均不设置AccessToken;关闭安全性校验;
设置二:调度中心和执行器,设置了相同的AccessToken;
一样寻常在生成情况,都需要配置AccessToken,并保证调度中心和执行器使用的是一个AccessToken:
### xxl-job, access token
xxl.job.accessToken=bf94fac7-de97-4f8d-a3e6-fe8562c480c7 # xxl-job配置
xxl:
job:
    admin:
      addresses: http://127.0.0.1:8090/xxl-job-admin
    accessToken: bf94fac7-de97-4f8d-a3e6-fe8562c480c7
    executor:
      appname: masteryi-xxl-job-executor
      address:
      ip:
      port: 9999
      logpath: ./logs/xxl-job/executor/
      logretentiondays: 30
logging:
config: classpath:logback.xml 五、参考

关于xxl-job的更多用法,可以参考官方开源社区:
分布式任务调度平台XXL-JOB

如有不足,欢迎指正,本文持续更新中。。。

免责声明:如果侵犯了您的权益,请联系站长,我们会及时删除侵权内容,谢谢合作!更多信息从访问主页:qidao123.com:ToB企服之家,中国第一个企服评测及商务社交产业平台。
页: [1]
查看完整版本: Xxl-Job分布式定时任务