任务调度中心 xxl-job springBoot

原创已于 2022-07-28 11:33:24 修改 · 206 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#spring boot #java #spring

于 2022-07-28 11:30:50 首次发布

中间键专栏收录该内容

4 篇文章

订阅专栏

本文档展示了如何配置XXL-JOB执行器，并提供了示例代码来创建一个定时任务。配置包括调度中心地址、执行器服务名、IP、端口等参数，而定时任务代码中定义了一个名为'xxxxPromptHandler'的作业处理类，实现了IJobHandler接口，任务执行返回状态为SUCCESS。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

依赖

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

一、配置类

package com.xxxx.framework.config;

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;

import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;

/**
 * xxl-job config
 *
 * @author chen.wang
 */
@Configuration
@Slf4j
public class XxlJobConfig {

    /** 调度中心后台地址 */
    @Value("${xxl.job.admin.addresses}")
    private String adminAddresses;
    /** 注册注册到调度中心的服务名 */
    @Value("${xxl.job.executor.appname}")
    private String appName;
    /** 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务" */
    @Value("${xxl.job.executor.ip}")
    private String ip;
    /** 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口 */
    @Value("${xxl.job.executor.port}")
    private int port;
    /** 执行器通讯TOKEN [选填]：非空时启用 */
    @Value("${xxl.job.accessToken}")
    private String accessToken;
    /** 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径 */
    @Value("${xxl.job.executor.logpath}")
    private String logPath;
    /** 执行器日志保存天数 [选填] ：值大于3时生效，启用执行器Log文件定期清理功能，否则不生效 */
    @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.setIp(ip);
        xxlJobSpringExecutor.setPort(port);
        xxlJobSpringExecutor.setAccessToken(accessToken);
        xxlJobSpringExecutor.setLogPath(logPath);
        xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
        return xxlJobSpringExecutor;
    }
}

二、定时任务代码

package com.xxxx.project.tsr.task;

import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.IJobHandler;
import com.xxl.job.core.handler.annotation.JobHandler;
import org.springframework.stereotype.Component;

/**
 * @author chen.wang
 */
@JobHandler(value = "xxxxPromptHandler")
@Component
public class XxxxtPromptJobHandler extends IJobHandler {


    @Override
    public ReturnT<String> execute(String s) throws Exception {
        // 任务代码
        return ReturnT.SUCCESS;
    }

}