Xxl-job分布式任务调度使用

蚊子 2023年05月19日 332次浏览

前言

2022.06.27—重新修正文章错误
这个文章写过一次,搬站时数据丢失了,也就没精力重写了,现在只是粗略写下

系统自带的定时任务:对于分布式的项目,可能会存在重复定时执行问题
所以:使用xxl-job解决,单体项目也可以用xxl-job,微服务需要准备注册中心,boot无需

准备

1.依赖

    <dependency>
            <groupId>com.xuxueli</groupId>
            <artifactId>xxl-job-core</artifactId>
            <version>2.2.0</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.54</version>
        </dependency>

2.Yml

  1. spring同级
  2. addresses:xxl-job地址
  3. appname:后台执行器AppName的名字,这里可以随便写
  4. port:xxl-job与你程序通讯端口,不可与项目端口一样
xxl:
  job:
    accessToken: default_token
    admin:
      addresses: http://127.0.0.1:8080/xxl-job-admin
    executor:
      address:
      appname: myserver
      ip:
      logpath: /data/applogs/xxl-job/jobhandler
      logretentiondays: 30
      port: 9998

3.工具类

package com.zb.job;

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;
    }

    /**
     * 针对多网卡、容器内部署等情况,可借助 "spring-cloud-commons" 提供的 "InetUtils" 组件灵活定制注册IP;
     *
     *      1、引入依赖:
     *          <dependency>
     *             <groupId>org.springframework.cloud</groupId>
     *             <artifactId>spring-cloud-commons</artifactId>
     *             <version>${version}</version>
     *         </dependency>
     *
     *      2、配置文件,或者容器启动变量
     *          spring.cloud.inetutils.preferred-networks: 'xxx.xxx.xxx.'
     *
     *      3、获取IP
     *          String ip_ = inetUtils.findFirstNonLoopbackHostInfo().getIpAddress();
     */


}

代码

对于这里看不明白的,或者上面一些参数看不明白的,可以先看后台设置部分

1.基础演示

test1是后台写JobHandler填的名字
ReturnT和(String param)不可以修改和去掉,否则启动报错

@XxlJob("test1")
public ReturnT<String> testHandler(String param) throws Exception {
    System.out.println("定时执行");
    return ReturnT.SUCCESS;
}

2.参数处理演示

将传过来的数据封装集合或者实体类进行处理

@XxlJob("test2")
public ReturnT<String> tsetyurl(String param){
    //传来多个的数据转成集合,这里使用了阿里巴巴json
    List<No2> no1 = JSONArray.parseArray(param,No2.class);
    no1.forEach(System.out::println);

//  传来的单个数据转一个实体,这里使用了阿里巴巴json
//    No2 no1 = JSONObject.parseObject(param, No2.class);
//    System.out.println(no1.toString());

    return null;
}

后台设置

1.新建执行器

AppName:填Yml里面配置的appname值
注意:自动注册需要等待xxl-job自动查找,大概10-20秒,才会显示OnLine 机器地址

image-1684475936489
image-1684476101334


2.新建任务

image-1684476316738
image-1684476302496
image-1684476425027


测试任务

image-1684476694409
image-1684476714186

如果要查看执行日志,比如遇到报错什么的,详细信息
image-1684476767044
image-1684476774249