XXL-JOB简易入门

XXL-JOB

总体概览

架构

组成

调度中心 + 执行器

调度中心

• 负责管理调度信息，按照调度配置发出调度请求
• 调度系统与任务解耦
• 支持可视化、简单且动态的管理调度信息，(任务新建，更新，删除， GLUE 开发和任务报警)\
• 支持监控调度结果以及执行日志，支持执行器 Failover 。

执行器

• 负责接收调度请求并执行任务逻辑
• 接收“调度中心”的执行请求、终止请求和日志请求等
• 一般执行器可以内嵌到应用服务

使用

调度中心

1、XXL-JOB 暂未提供直接直接启动的 jar 包，需编译源码

2、下载地址：https://github.com/xuxueli/xxl-job/releases

• xxl-job-core ：XXL-JOB 核心。
  • 执行器使用
• xxl-job-admin：调度中心
• xxl-job-executor-samples：提供了在 Spring、Spring Boot、JFinal、Nutz 等框架下的使用示例。

3、执行代码内脚本 (/doc/db/tables_xxl_job.sql),用于保存相关信息(连接)

4、修改 admin - application.properties

1、server-port - 调度中心地址

** 2、spring.datasource - 数据源**

3、spring.mail - 报警邮箱

4、xxl.job.accessToken - 令牌

5、编译启动

`mvn clean package -pl xxl-job-admin

-am -DskipTests`

6、启动

执行器

依赖

<dependencies>
        <!-- 实现对 Spring MVC 的自动化配置 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- XXL-JOB 相关依赖 -->
        <dependency>
            <groupId>com.xuxueli</groupId>
            <artifactId>xxl-job-core</artifactId>
            <version>2.1.1</version>
        </dependency>
    </dependencies>

配置

server:
  port: 9090 #指定一个端口，避免和 XXL-JOB 调度中心的端口冲突。仅仅测试之用

# xxl-job
xxl:
  job:
    admin:
      addresses: http://127.0.0.1:8080/xxl-job-admin # 调度中心部署跟地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
    executor:
      appname: executor # 执行器 AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
      ip: # 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；
      port: 6666 # ### 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
      logpath: /Users/yunai/logs/xxl-job/lab-28-executor # 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
      logretentiondays: 30 # 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；
    accessToken: yudaoyuanma # 执行器通讯TOKEN [选填]：非空时启用；#### 代码### 任务配置

代码

//配置类
@Configuration
public class XxlJobConfiguration {

    @Value("${xxl.job.admin.addresses}")
    private String adminAddresses;
    @Value("${xxl.job.executor.appname}")
    private String appName;
    @Value("${xxl.job.executor.ip}")
    private String ip;
    @Value("${xxl.job.executor.port}")
    private int port;
    @Value("${xxl.job.accessToken}")
    private String accessToken;
    @Value("${xxl.job.executor.logpath}")
    private String logPath;
    @Value("${xxl.job.executor.logretentiondays}")
    private int logRetentionDays;

    @Bean
    public XxlJobSpringExecutor xxlJobExecutor() {
        // 创建 XxlJobSpringExecutor 执行器
        XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
        xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
        xxlJobSpringExecutor.setAppName(appName);
        xxlJobSpringExecutor.setIp(ip);
        xxlJobSpringExecutor.setPort(port);
        xxlJobSpringExecutor.setAccessToken(accessToken);
        xxlJobSpringExecutor.setLogPath(logPath);
        xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
        // 返回
        return xxlJobSpringExecutor;
    }

}

//实现定时任务

@Component
@JobHandler("demoJob")
public class DemoJob extends IJobHandler {

    private Logger logger = LoggerFactory.getLogger(getClass());

    private final AtomicInteger counts = new AtomicInteger();

    @Override
    //ReturnT.code == ReturnT.SUCCESS 任务成功
    public ReturnT<String> execute(String param) throws Exception {
        // 打印日志
        logger.info("[execute][定时第 ({}) 次执行]", counts.incrementAndGet());
        // 返回执行成功
        return ReturnT.SUCCESS;
    }

}

admin 配置任务

执行器新增

配置执行器任务并启动