xxl-job学习记录

news2024/10/1 17:30:47

1、应用场景

例：某收银系统需要在每天凌晨统计前一天的财务分析、汇总

某银行系统需要在信用卡还款日前三天发短信提醒等

2、为什么需要使用任务调度

spring中提供了注解@Scheduled的注解，这个注解也可以实现定时任务的执行

我们只需要在方法上使用这个注解，例如：@Scheduled（cron="cron表达式"）

然后再启动类上加上注解@EnableScheduling 表示启用定时任务即可

虽然这个注解能完成任务调度，但是存在一下等问题：

（1）如果我们想让这个定时任务马上执行一次，可能就需要再额外写一个接口或者单独的job执行

（2）没有管理界面，不方便查看任务的执行情况

（3）当需要执行大量任务时，单机版下执行时间过长

（4）如果多个机器，需要重复写大量的任务并且后期修改需要工作太多

3、xxl-job简介

官网：XXL开源社区 | 首页 (xuxueli.com)

系统架构图

4、使用xxl-job

1.运行调度中心

在gitee上拉取xxl-job

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

拉取项目后配置数据库

在doc下的db文件中，导入数据库中

将拉下来的项目在用idea运行

修改xxl-job-admin中的配置文件，这个时可视化界面

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

如果配置了这个，调度中心就会和执行器进行校验，只有一致时才能连接

这里我们默认不做修改

运行项目

运行成功后即可打开可视化界面

localhost:8080/xxl-job-admin 用户名admin 密码123456即可进入可视化界面

2.运行执行器

项目自带执行器可以测试

在这里我选择在新项目上配置

1.新建springboot项目

2.添加依赖

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

添加配置文件

xxl:
  job:
    admin:
      # 调度中心部署根地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。
      #执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
      addresses: http://127.0.0.1:8080/xxl-job-admin
      ### 执行器通讯TOKEN [选填]：非空时启用；
    accessToken: default_token
    executor:
      ### 执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
      appname: xxl-job-executor-exper
      ### 执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”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
spring:
  #数据库连接配置
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    #本地数据库
    url: jdbc:mysql://localhost:3306/exper_system?characterEncoding=utf-8&useSSL=false&serverTimezone=UTC
    username: root
    password: 123456

添加执行器配置

package exper.admin.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;

/**
 * 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.setPort(port);
        xxlJobSpringExecutor.setAccessToken(accessToken);
        xxlJobSpringExecutor.setLogPath(logPath);
        xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);

        return xxlJobSpringExecutor;
    }

}

这时候我们启动项目过大概三十秒（执行器在注册）或重启调度中心查看可视化界面

这个名称可以手动修改

可以看到执行器中已经有我们刚才配置的AppName和地址端口了

3.添加任务处理

添加任务

package exper.admin.job;

import com.xxl.job.core.handler.annotation.XxlJob;
import org.springframework.stereotype.Component;

import java.util.Date;

@Component
public class experXxlJob {

    @XxlJob("demoHandler")
    public void Test(){
        System.out.println("执行定时任务，时间："+new Date());
    }
}