XXL-Job:提升任务调度效率的开源利器

一. 前言

XXL-Job是由知名技术公司XXL-Tech团队开发和维护的,经过多年的发展和应用实践,已在众多企业和项目中获得广泛认可。它的特性和功能旨在简化任务调度的管理和执行,提高开发效率。

在本文中,我们将探讨XXL-Job的关键特点,包括其分布式任务调度能力、任务监控和管理功能以及灵活的调度策略。我们将深入了解如何利用XXL-Job解放开发人员的任务调度烦恼,提高项目的整体效率和稳定性。

二. 下载与安装

今天会手把手地教你安装XXL-Job,步骤很详细哦。

2.1 安装环境

在安装XXL-Job之前,请大家提前配置好以下环境:

  • Maven3+

  • JDK1.8+

  • MySQL5.7+

2.2 下载

https://github.com/xuxueli/xxl-job/tags 选择2.4.1版本

2.3 解压

解压源码,按照maven格式将源码导入IDE, 使用maven进行编译即可,源码结构如下:

图片

xxl-job-admin这是调度管理中心,也是XXL-Job的核心管理组件,负责任务的调度和管理。它给我们提供了一个可视化的管理界面,通过Web界面和API接口,开发者可以方便地创建、编辑和监控任务。调度中心负责将任务分发给执行器节点,并接收执行器的执行结果和日志。

xxl-job-executor(xxl-job-executor-sample):这是官方给的执行器案例,我们可以参考案例将执行器移植到应用中。执行器是XXL-Job的任务执行节点,负责接收调度中心分发的任务,并按照设定的调度策略执行任务。每个执行器都可以独立运行,它通过与调度中心进行通信,获取待执行的任务,并将执行结果和日志返回给调度中心。执行器可以动态扩容和缩容,实现任务的高并发和负载均衡。

2.4 初始化调度数据库

请下载项目源码并解压,获取 “调度数据库初始化SQL脚本” 并执行即可。其中,调度数据库的初始化SQL脚本位置为: 

/xxl-job/doc/db/tables_xxl_job.sql

三. 配置并启动调度中心

调度中心全局管理执行器、job、job-handler、以及job运行状态,我们可以配置并启动调度中心,主要有以下几个步骤。

1.step1:修改配置文件

配置文件地址如下:

/xxl-job/xxl-job-admin/src/main/resources/application.properties
调度中心JDBC链接:链接地址请保持和 2.1章节 所创建的调度数据库的地址一致
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=root_pwd
spring.datasource.driver-class-name=com.mysql.jdbc.Driver

报警邮箱

spring.mail.host=smtp.qq.com
spring.mail.port=25
[email protected]
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

调度中心通讯TOKEN [选填]:非空时启用;

xxl.job.accessToken=

调度中心国际化配置 [必填]:

默认为 "zh_CN"/中文简体, 可选范围为 "zh_CN"/中文简体, "zh_TC"/中文繁体 and "en"/英文;

xxl.job.i18n=zh_CN

调度线程池最大线程配置【必填】

xxl.job.triggerpool.fast.max=200
xxl.job.triggerpool.slow.max=100

调度中心日志表数据保存天数 [必填]:

过期日志自动清理;限制大于等于7时生效,否则, 如-1,关闭自动清理功能;

xxl.job.logretentiondays=30

2.step2:启动

如果已经正确进行上述配置,可将项目编译打包部署。调度中心访问地址:http://localhost:8080/xxl-job-admin

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

图片

四. 配置并启动执行器

1.step1:pom依赖

确认pom文件中引入了 “xxl-job-core” 的maven依赖;

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

2.step2:执行器配置

配置文件位置:

/xxl-job/xxl-job-executor-samples/xxl-job-executor-sample-springboot/src/main/resources/application.properties

调度中心部署根地址 [选填]:

如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调";为空则关闭自动注册;

xxl.job.admin.addresses=http://127.0.0.1:8080/xxl-job-admin

执行器通讯TOKEN [选填]:非空时启用;

xxl.job.accessToken=

执行器AppName [选填]:

执行器心跳注册分组依据;为空则关闭自动注册

xxl.job.executor.appname=zhuximing

执行器注册 [选填]:

优先使用该配置作为注册地址,为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。

xxl.job.executor.address=

执行器IP [选填]:

默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册" 和 "调度中心请求并触发任务";

xxl.job.executor.ip=

执行器端口号 [选填]:

小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口;

xxl.job.executor.port=9999

执行器运行日志文件存储磁盘路径 [选填] :

需要对该路径拥有读写权限;为空则使用默认路径;

xxl.job.executor.logpath=/data/applogs/xxl-job/jobhandler

执行器日志文件保存天数 [选填] :

过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能;

xxl.job.executor.logretentiondays=30

3.step3:实例化执行器

package com.qf.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;
    }
}

4.step4:启动执行器并注册执行器

备注:如果你不能自动注册,可以选择手动注册,注册成功后在执行器管理中可以看到执行器信息。

图片

五. 开发job

1.step1:编写任务job-handler

在执行器项目中编写handler,如下代码:

@XxlJob("hello-job")
public void hello(){
    XxlJobHelper.log("hello  xxl");
}

2.step2:创建任务

在调度中心中创建job,如下图:

图片

3.step3:运行任务

图片

4.step4:查看任务日志

图片

六. 总结

XXL-Job 是一个功能强大且易于使用的分布式任务调度框架,为我们的企业和开发团队提供了许多价值。本文通过一个详细的案例带大家走进了xxl-job,如果你想知道xxl-job的更多高级用法,请大家持续关注小千。

猜你喜欢

转载自blog.csdn.net/GUDUzhongliang/article/details/132159327