xxl-job实现分布式任务调度

who_am_i__

已于 2023-11-03 17:38:56 修改

阅读量267

点赞数

文章标签：分布式

于 2023-11-03 17:38:34 首次发布

本文链接：https://blog.csdn.net/u012961612/article/details/134205025

版权

什么是xxl-job

XXL-Job 是一个基于分布式任务调度框架的开源平台，它基于分布式架构，通过协调任务调度和任务执行器的方式来实现任务调度和执行。架构如图:

1. 原理：

- 调度中心：XXL-Job 调度中心是任务的管理与调度核心，负责任务的创建、修改、删除和调度等操作。

- 执行器：执行器是任务的执行容器，可以独立运行在不同的节点上。执行器负责接收任务调度中心分配的任务，并进行执行。执行器将任务执行结果返回给调度中心，并进行状态上报和心跳维持。

2. 作用：

- 任务调度：XXL-Job 提供了任务调度功能，可以按照预定的时间或条件执行任务，如定时执行、Cron 表达式调度、固定频率调度等。通过调度中心的管理和调度，可以灵活地控制任务的执行。

- 任务管理：XXL-Job 提供了任务的创建、修改、删除等管理功能，可以方便地对任务进行管理和配置。通过 Web 控制台可以轻松地对任务进行操作。

- 任务执行监控：XXL-Job 提供了任务执行监控功能，可以查看任务的执行状态、执行日志和结果。它还支持统一的任务查看、日志查询和定时报警功能，便于排查任务执行失败并进行及时处理。

- 分布式任务调度：XXL-Job 支持在分布式环境中进行任务调度，并提供了注册中心作为任务执行器的管理和协调中心。可以实现任务的分布调度和负载均衡。

总的来说，XXL-Job 的原理是通过调度中心、执行器和注册中心的协作来实现任务的调度和执行。它的作用是提供灵活的任务调度功能、便捷的任务管理和执行监控，并支持分布式环境下的任务调度和协调。

实现分布式任务调度

从githu拉取xxl-job:

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

启动xxl-job-admin(调度中心)

使用idea打开xxl-job:

从项目中找到tables_xxl_job.sql,并执行其中的sql,执行后会在MySQL中创建xxl_job库以及相关配置表:

修改xxl-job-admin配置文件application.properties:

主要修改数据库连接username和passwrod,以及端口(可以自定义也可以使用默认端口):

找到XxlJobAdminApplication.java 运行xxl-job-admin:

新建执行器(xxl-job-executor)

pom文件:

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.2.4.RELEASE</version>
        <relativePath/> <!-- 如果你的父项目是本地文件系统中的一个标准 Maven 项目，则可以使用相对路径 -->
    </parent>

    <groupId>org.example</groupId>
    <artifactId>xxl-job-executor</artifactId>
    <version>1.0-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>xxl-job-executor</name>
    <url>http://maven.apache.org</url>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>com.xuxueli</groupId>
            <artifactId>xxl-job-core</artifactId>
            <version>2.4.0</version>
        </dependency>
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
    </dependencies>
</project>

JobExecutorApplication.java

package org.example;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * Hello xxl-job!
 */
@SpringBootApplication
public class JobExecutorApplication {
    public static void main(String[] args) {
        SpringApplication.run(JobExecutorApplication.class, args);
    }
}

添加xxl-job相关配置XxlJobConfig.java:

package org.example.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 static final Logger log = 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() {
        log.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;
    }

}

添加调度任务HelloJobHandler

package org.example.handler;

import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.annotation.XxlJob;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;

@Component
public class HelloJobHandler {
    private final static Logger log = LoggerFactory.getLogger(HelloJobHandler.class);

    @XxlJob("helloJob")
    public ReturnT<Object> helloJob(String param) {
        // job 处理逻辑
        log.info("hello xxl-job,current-time:" + System.nanoTime());
        // 返回值
        return new ReturnT<>(200);
    }

}

项目文件配置

server:
  port: 8081

xxl:
  job:
    admin:
      enable: true
      username: admin
      password: 123456 # xxl-job-admin 默认密码
      addresses: http://172.24.192.1:8079/xxl-job-admin # 调度中心地址
    executor:
      appname: xxl-job-admin
      address: http://172.24.192.1:9999/
      ip:
      port: 9999 # 用来与调度中新通信的端口号
      logretentiondays: 10
    accessToken: default_token

运行xxl-job-executor