SpringBoot 集成 xxl-job

１．描述 

springboot 配置 xxl-job 定时任务 

2 . 方法

2.1 下载xxl-job 并本地运行

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

2.2 引入jar包 

<dependency>
    <groupId>com.xuxueli</groupId>
    <artifactId>xxl-job-core</artifactId>
    <version>2.4.0</version> <!-- 使用最新版本 -->
</dependency>

2.3spring项目配置文件中添加 xxl-job的配置

xxljob:
  initenable: false   # 是否初始化执行器
  executor:
    address: http://127.0.0.1:9999  # 手动指定执行器地址（空值表示自动注册）
    appname: xxl-job-executor-dome  # 在调度中心注册的执行器名称
    ip: 127.0.0.1                   # 强制绑定IP地址（空值表示自动获取）
    port: 9999                      # 执行器端口号
    logretentiondays: 30            # 日志文件保留天数
    logpath: /data/applogs/xxl-job/jobhandler  # 任务日志存储路径(注意有写入权限)
  accessToken: default_token        # 调度中心通信令牌
  admin:
    addresses: http://127.0.0.1:3360/xxl-job-admin   # 调度中心地址
  user:
    username: admin                # 调度中心登录账号
    password: 12345678             # 调度中心登录密码

2.4 项目中 添加 xxl-job 控制类

@Configuration
public class XxlJobConfig {

    private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);

    @Value("${xxljob.admin.addresses}")
    private String adminAddresses;

    @Value("${xxljob.accessToken}")
    private String accessToken;

    @Value("${xxljob.executor.appname}")
    private String appname;

    @Value("${xxljob.executor.address}")
    private String address;

    @Value("${xxljob.executor.ip}")
    private String ip;

    @Value("${xxljob.executor.port}")
    private int port;

    @Value("${xxljob.executor.logpath}")
    private String logPath;

    @Value("${xxljob.executor.logretentiondays}")
    private int logRetentionDays;

    @Value("${xxljob.initenable}")
    private boolean initEnable;

    @Bean
    public XxlJobSpringExecutor xxlJobExecutor() {
        XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
        if(initEnable){
            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();
     */


}

2.5 在业务类上添加注解

    @XxlJob("demoJobHandler")
    public String gedemoJobHandler() { 
        // 获取任务参数（String类型）  获取job 任务中配置的参数
        String jobParam = XxlJobHelper.getJobParam();
        // JSON参数解析示例
        if (StringUtils.isNotBlank(jobParam)) {
            JSONObject params = JSON.parseObject(jobParam);
            String orgcode = params.getString("orgcode");  //获取任务参数中的值
            String orgname = params.getString("orgname"); //获取任务参数中的值
			//执行业务代码
         
        }
        return "执行成功";
    }

2.6 登录 本地 xxl-job 并配置任务调度

2.6.1 创建 执行器管理

2.6.2  创建调度任务

可以选择任务 执行一次 测试是否正常