xxl-job的简单使用

news2024/11/26 22:40:12

xxl-job是一个分布式任务调度框架，在Spring中，提供有任务调度的注解功能，在之前的项目中，非分布式任务都可以直接使用Spring框架提供的@Scheduled注解和@EnableScheduling注解来实现定时任务。

@EnableScheduling注解加载项目启动类上面
@Scheduled注解加在需要进行定时执行的方法上面，且需要使用cron表达式设置执行时机

而之所以使用xxl-job来进行任务调度，主要有下面几个原因：

1、高可用：单机版的定式任务调度只能在一台机器上运行，如果程序或者系统出现异常就会导致功能不可用。
------
2、防止重复执行: 在单机模式下，定时任务是没什么问题的。但当我们部署了多台服务，同时又每台服务又有定时任务时，若不进行合理的控制在同一时间，只有一个定时任务启动执行，这时，定时执行的结果就可能存在混乱和错误了
------
3、单机处理极限：原本1分钟内需要处理1万个订单，但是现在需要1分钟内处理10万个订单；原来一个统计需要1小时，现在业务方需要10分钟就统计出来。你也许会说，你也可以多线程、单机多进程处理。的确，多线程并行处理可以提高单位时间的处理效率，但是单机能力毕竟有限（主要是CPU、内存和磁盘），始终会有单机处理不过来的情况。
----

xxl-job的源码下载地址：

https://github.com/xuxueli/xxl-job

https://gitee.com/xuxueli0323/xxl-job
在这里插入图片描述
将xxl-job的源码下载完成后，需要在电脑上进行启动

1、需要先创建xxl-job的数据库，在 doc/db 文件夹下存在一个tables_xxl_job.sql文件，执行该文件即可创建xxl-job执行所需的数据库表。
在这里插入图片描述

2、使用maven项目打开xxl-job-master项目

3、修改xxl-job-admin模块中的properties配置文件中的数据库连接信息为自己的。配置文件中的红色波浪线不用去管，没有影响。

在这里插入图片描述
4、通过XxlJobAdminApplication启动类将xxl-job项目启动，项目的端口号可以在properties配置文件中进行修改，默认是8080，访问http://localhost:8080/xxl-job-admin任务调度中心

5、启动xxl-job项目后要想使用它，还需要在项目中引入xxl-job的相关依赖，以及需要配置相关信息。

<!-- 添加xxl-job依赖 -->
<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.3.1</version>
</dependency>

6、在yml文件中添加xxl-job所需要的相关配置信息

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

7、添加xxl-job配置类

@Configuration
public class XxlJobConfig {
    @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() {
        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;
    }
}