springcloud:快速上手定时任务框架xxl-job(十五)

这篇具有很好参考价值的文章主要介绍了springcloud:快速上手定时任务框架xxl-job(十五)。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

0. 引言

实际开发中,我们常常遇到需要定时执行的任务,我们可以利用定时线程池或schedule框架等来实现定时任务,但这些方式都有效率、性能上的缺陷,在微服务框架下,我们期望一种更加规整、轻量、可靠的定时任务框架来帮助我们实现定时任务,以及可视化的管理定时任务。

在这样的需求下,国产定时任务框架xxl-job应运而生。

1. xxl-job简介

xxl-job是分布式的任务调度平台,以作者名字命名,以其轻量、可视、易上手迅速在微服务框架下站稳脚跟。xxl-job分为服务端和客户端,客户端也就是我们的定时任务方法实现,也称为执行器,而服务端用来管理定时任务配置以及记录执行情况,也称为调度器

官方文档:https://www.xuxueli.com/xxl-job/

2. xxl-job安装

1、在xxl-job github仓库](https://github.com/xuxueli/xxl-job/releases),下载源码,我这里直接选择最新版下载

springcloud:快速上手定时任务框架xxl-job(十五)

2、在idea中以maven形式打开该项目,其中的xxl-job-admin就是我们要安装的服务端,可以看到该服务端其实就是一个springboot项目,xxl-job-core是公共依赖,xxl-job-executor-samples是客户端的示例代码

springcloud:快速上手定时任务框架xxl-job(十五)
3、在doc文件夹下找到tables_xxl_job.sql文件

springcloud:快速上手定时任务框架xxl-job(十五)

利用该文件创建数据库xxl-job
springcloud:快速上手定时任务框架xxl-job(十五)

4、在xxl-job-admin项目中的resource文件夹下的application.properties配置文件,修改其数据库地址、服务端口号、数据库连接池、预警发送邮箱等信息

### web 端口
server.port=8080
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?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=123456
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
spring.datasource.hikari.validation-timeout=1000

### xxl-job, email 预警发送邮箱
spring.mail.host=smtp.qq.com
spring.mail.port=25
spring.mail.username=xxx@qq.com
spring.mail.from=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=default_token

### 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

5、logback.xml是日志配置文件,如果要修改日志保存路径,可以在此配置,启动项目时如果没有配置的日志文件夹会报错,所以提前修改好日志路径

springcloud:快速上手定时任务框架xxl-job(十五)

6、本地启动服务端的话,只需要运行该xxl-job项目即可,如果要将服务端发布到服务器上,将其打包,然后放到服务器上运行即可

这里为了照顾部分初学者,详细讲解下打包发布流程,如果掌握的同学,可直接跳过

2.1 发布xxl-job-admin到服务器

1、修改配置文件数据库地址

springcloud:快速上手定时任务框架xxl-job(十五)

2、修改预警发送邮箱,如果不知道如何获取邮箱授权码的可以参考我这篇文章:https://wu55555.blog.csdn.net/article/details/127156042

不需要预警可不用配置

springcloud:快速上手定时任务框架xxl-job(十五)

3、修改日志路径

springcloud:快速上手定时任务框架xxl-job(十五)

4、打包xxl-job-admin

springcloud:快速上手定时任务框架xxl-job(十五)

5、将打包出来的jar包上传到目标服务器(因为是java项目,请提前在服务器上安装jdk)

springcloud:快速上手定时任务框架xxl-job(十五)

6、创建日志文件夹

mkdir -p /data/logs/xxl-job-2.4.0/log

7、因为我们配置的默认的8080端口,所以需要开启8080端口,如果没有开启防火墙则不用开启端口

firewall-cmd --add-port=8080/tcp --permanent
firewall-cmd --reload

8、启动xxl-job-admin

# 前台启动,关闭窗口或者ctrl+c会关闭项目
java -jar xxl-job-admin-2.4.0.jar
# 后台启动,关闭窗口或者ctrl+c不会关闭项目
nohup java -jar xxl-job-admin-2.4.0.jar & 

9、访问项目:服务器ip:8080/xxl-job-admin,默认登陆账号密码:admin/123456

springcloud:快速上手定时任务框架xxl-job(十五)

3. 客户端定时任务书写

1、这里我们创建一个springboot项目,用来书写定时任务

springcloud:快速上手定时任务框架xxl-job(十五)

2、引入依赖,版本与服务端版本保持一致

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

3、修改配置文件

# 服务端地址
xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin
### xxl-job, access token,与服务端配置的保持一致
xxl.job.accessToken=default_token
### xxl-job executor appname
xxl.job.executor.appname=job-server
# 执行器注册地址,默认使用address,否则使用ip:port,这是注册到服务端的地址
xxl.job.executor.address=
# 执行器ip
xxl.job.executor.ip=
# 执行器端口
xxl.job.executor.port=9998
### xxl-job executor log-path
xxl.job.executor.logpath=/data/logs/xxl-job/jobhandler
### xxl-job executor log-retention-days
xxl.job.executor.logretentiondays=30

4、创建配置类XxlJobConfig

@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();
     */


}

5、我们创建一个定时方法,可以看到只需要在需要定时执行的方法上加一个@XxlJob注解即可,其属性值是这个定时方法的名称,后续会在服务端配置,要保证唯一

同时注意定时任务类要声明为bean,即加上@Component

@Component
public class JobService {

    @XxlJob("testJob")
    public void testJob() throws Exception {
        String param = XxlJobHelper.getJobParam();
     
        System.out.println("执行定时任务,参数为:"+param);

    }
}

4. 服务端配置

xxl-job-admin服务端有如下几个菜单

运行报表:定时任务运行情况统计
任务管理:配置的定时任务
调度日志:每个定时任务的具体执行日志
用户管理:账号管理,可针对执行器配置权限
执行器管理:执行器就是客户端,也就是后台的定时任务方法

springcloud:快速上手定时任务框架xxl-job(十五)

1、首先我们需要新增一个执行器,这里选择自动注册,有时我们要进行联调,需要指定执行器为我们本地的执行器,这时可以用手动录入ip的注册形式,地址就是我们之前配置的xxl.job.executor.addressxxl.job.executor.ip+xxl.job.executor.port

注意:这里的appName要与客户端中配置的xxl.job.executor.appname保持一致

springcloud:快速上手定时任务框架xxl-job(十五)

手动录入形式:
springcloud:快速上手定时任务框架xxl-job(十五)

2、启动执行器项目,即上述创建的job-server项目

3、进入任务管理,执行器切换为我们刚新建的执行器,然后新建一个任务

springcloud:快速上手定时任务框架xxl-job(十五)

4、配置任务名,cron表达式(这里我配置的每秒执行一次),JobHandler就是我们之前在客户端书写的定时任务名称,即@XxlJob注解的值

其中各项配置说明如下:

  • 调度类型:

支持3种调度模式corn表达式
cron: 自由配置定时间隔;无:手动触发执行;固定:固定周期执行,比如30s执行一次

  • 运行模式

默认为BEAN,从执行器调度方法,还可以配置GLUE模式,配置后在列表页会出现一个GULE按钮,点击可以进入在线书写对应语言的代码,相当于一个在线书写的执行器方法,也就是客户端任务以源码的方式维护在调度中心,支持java,shell,python等语言

springcloud:快速上手定时任务框架xxl-job(十五)
springcloud:快速上手定时任务框架xxl-job(十五)

  • 任务参数

可以设置固定的任务参数,或者留空,也可以在手动执行的时候填写任务参数,比如一些按照日期执行的定时任务,想要回去执行历史日期的,就可以将参数定为日期,不填就默认为当天

  • 路由策略

当存在多个执行器时就需要配置路由策略,也就是负载均衡策略,比较常用的就是轮询

  • 子任务ID

如果需要在当前任务执行完成后,联动触发下一个任务,则可配置子任务,ID在列表中可查看到

  • 调度过期策略

支持两种策略,为什么会出现过期,我们将在后续单独讲解
忽略:调度过期后,忽略过期的任务,从当前时间开始重新计算下次触发时间;
立即执行一次:调度过期后,立即执行一次,并从当前时间开始重新计算下次触发时间;

  • 阻塞处理策略

对于任务太多太密集,导致执行器来不及执行时,所采取的策略,支持如下三种
单机串行(默认):进入等待队列,先进先出,等着执行;
丢弃后续调度:丢弃,不管了
覆盖之前调度:终止正在运行的调度任务,并清空等待队列,然后运行当前任务

  • 任务超时时间

任务运行超过超时时间就会直接中断

  • 失败重试次数

任务失败后进行重试的次数

springcloud:快速上手定时任务框架xxl-job(十五)

对于没有掌握cron表达式的同学,可以通过这个网站来帮我们书写cron表达式,通过勾选即可生成想要的cron表达式

https://cron.qqe2.com/

springcloud:快速上手定时任务框架xxl-job(十五)

5、创建好的任务默认是关闭的,还需要启动任务,如果任务只需要执行一次,可以选择不启动,手动点击执行一次即可

springcloud:快速上手定时任务框架xxl-job(十五)

6、启动好的项目状态为running

springcloud:快速上手定时任务框架xxl-job(十五)

7、我们查看job-server就能看到任务正在执行了

springcloud:快速上手定时任务框架xxl-job(十五)

8、可以看到这里参数为空,这是因为我们在服务端配置任务时没有配置参数,我们通过手动执行一次,执行参数给大家看下效果

springcloud:快速上手定时任务框架xxl-job(十五)

springcloud:快速上手定时任务框架xxl-job(十五)

总结

至此,咱们针对定时任务框架xxl-job的讲解就结束了,自己搭建起来试下吧

springcloud:快速上手定时任务框架xxl-job(十五)文章来源地址https://www.toymoban.com/news/detail-404814.html

到了这里,关于springcloud:快速上手定时任务框架xxl-job(十五)的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 分布式定时任务调度xxl-job

    Quartz中最重要的三个对象:Job(作业)、Trigger(触发器)、Scheduler(调度器)。 xxl-job的调度原理:调度线程在一个while循环中不断地获取一定数量的即将触发的Trigger,拿到绑定的Job,包装成工作线程执行。 当然,不管在任何调度系统中,底层都是线程模型。如果要自己写一个

    2024年03月10日
    浏览(56)
  • 分布式定时任务-XXL-JOB-教程+实战

    1.定时任务认识 1.1.什么是定时任务 定时任务是按照指定时间周期运行任务。使用场景为在某个固定时间点执行,或者周期性的去执行某个任务,比如:每天晚上24点做数据汇总,定时发送短信等。 1.2.常见定时任务方案 While + Sleep : 通过循环加休眠的方式定时执行 Timer和Time

    2024年02月16日
    浏览(48)
  • SpringBoot 集成 xxl-job 实现定时任务管理

    XXL-Job是一个功能强大的分布式任务调度框架,集成了Spring Boot后能够发挥更大的优势。它提供了分布式任务调度、任务执行报告、任务调度中心、良好的扩展性、分布式集群部署、监控与报警等多种优势。此外,XXL-Job是开源免费的,可以在GitHub上获取源代码和详细文档。详细

    2024年02月09日
    浏览(39)
  • springcloud:xxl-job的任务触发机制及调度过期策略

    我们都会用xxl-job,但很少有人能够说清楚xxl-job的任务触发机制,面临任务阻塞、服务重启如何处理任务,本期我们就来一起看看xxl-job的任务触发机制 我们在配置策略时可以看到有一个 调度过期策略 配置,也许你知道这是任务超期时的处理规则,但你有没有想过什么时候任

    2024年02月05日
    浏览(59)
  • 【手把手】分布式定时任务调度解析之xxl-job

    在之前我写的讲解Quartz中有介绍过,Quartz有差不多二十年的历史,调度模型已经非常成熟了,而且很容易集成到Spring中去,用来执行业务任务是一个很好的选择。但是越早的设计存在的问题也越明显,比如: 1、调度逻辑(Scheduler)和任务类耦合在同一个项目中,随着调度任

    2024年01月19日
    浏览(64)
  • 分布式定时任务系列8:XXL-job源码分析之远程调用

    分布式定时任务系列1:XXL-job安装 分布式定时任务系列2:XXL-job使用 分布式定时任务系列3:任务执行引擎设计 分布式定时任务系列4:任务执行引擎设计续 分布式定时任务系列5:XXL-job中blockingQueue的应用 分布式定时任务系列6:XXL-job触发日志过大引发的CPU告警 分布式定时任

    2024年01月21日
    浏览(51)
  • Spring@Scheduled定时任务接入XXL-JOB的一种方案(基于SC Gateway)

    目前在职的公司,维护着Spring Cloud分布式微服务项目有25+个。其中有10个左右微服务都写有定时任务逻辑,采用Spring @Scheduled这种方式。 Spring @Scheduled定时任务的缺点: 不支持集群:为避免重复执行,需引入分布式锁 死板不灵活:不支持手动执行,单次执行,补偿执行,修改

    2024年02月11日
    浏览(48)
  • xxl-job定时任务配置应用以及添加到自己已有的springboot项目中实现动态API调用

    XXL-JOB是一个分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线,开箱即用。 本篇文章主要是对xuxueli的xxl-job做一个简单的配置,以及将其添加到自己已有的项目中进行api调用。 一、xxl-job安装 1、首先

    2024年02月03日
    浏览(40)
  • Spring Boot 3 整合 xxl-job 实现分布式定时任务调度,结合 Docker 容器化部署(图文指南)

    xxl-job 是一个分布式任务调度平台,它提供了强大的任务调度和执行能力,可以帮助我们实现任务的自动化调度和执行。本文将介绍如何在 Docker 环境下部署 xxl-job,并将其与 Spring Boot 进行整合。 数据库脚本:tables_xxl_job-2.4.0.sql Docker 镜像地址: https://hub.docker.com/r/xuxueli/xxl-jo

    2024年02月06日
    浏览(74)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包