spring boot集成xxl-job调度器

xxl-job调度器

参考地址：https://www.jianshu.com/p/fa7186bea84b

此处省略创建xxl-job调度中心，主要是示范项目中使用

1.引入maven包

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

2.配置文件

xxl:
  job:
    accessToken: 123456 #调度中心通讯TOKEN [选填]：非空时启用，必须保持一致；
    admin:
      addresses: http://127.0.0.1:8080/xxl-job-admin # 调度中心部署跟地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
      #addresses: http://127.0.0.1:15052/xxl-job-admin # 调度中心部署跟地址 [选填]：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"；为空则关闭自动注册；
    executor:
      appname: test-trade #执行器AppName [选填]：执行器心跳注册分组依据；为空则关闭自动注册
      address:    #执行器注册 [选填]：优先使用该配置作为注册地址，为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
      ip:         # 执行器IP [选填]：默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用；地址信息用于 "执行器注册" 和 "调度中心请求并触发任务"；
      port: 0     # 执行器端口号 [选填]：小于等于0则自动获取；默认端口为9999，单机部署多个执行器时，注意要配置不同执行器端口；
      logpath: /data/applogs/xxl-job/jobhandler # 执行器运行日志文件存储磁盘路径 [选填] ：需要对该路径拥有读写权限；为空则使用默认路径；
      logretentiondays: 30 # 执行器日志文件保存天数 [选填] ： 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能；

3.创建 XxlJobConfig

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

 

}

4.创建使用一个调度器

/**
   定时取消： 待支付订单超时取消任务 
 * @Description: XxlJob-Bean模式
 * @author: WGQ
 *开发步骤：
 *   1、在Spring Bean实例中，开发Job方法，方式格式要求为 "public ReturnT<String> execute(String param)"
 *   2、为Job方法添加注解 "@XxlJob(value="自定义jobhandler名称", init = "JobHandler初始化方法", destroy = "JobHandler销毁方法")"，注解value值对应的是调度中心新建任务的JobHandler属性的值。
 *   3、执行日志：需要通过 "XxlJobLogger.log" 打印执行日志；
 */
@Slf4j
@Component
public class OrderExpireJob {

    @Autowired
    private PayOrderService payOrderService;

    @Autowired
    private StringRedisTemplate stringRedisTemplate;

    @XxlJob(value = "sea_order_expire")//注意这里的名称和xx-job中名称一致
    public ReturnT<String> execute(String param)  {
        String d = stringRedisTemplate.opsForValue().get(RedisKeyConstant.PayOrderRedisKey.ORDER_EXPIRE_SIZE);
        int size = 100;
        if (!StringUtils.isEmpty(d)){
            size = Integer.valueOf(d);
        }
        XxlJobLogger.log("sea_order_expire task start param:{}",param);

        try {
            payOrderService.payOrderExpirationCancelTask(size);
        } catch (Exception e){
            log.info("sea_order_expire task error",e);
            XxlJobLogger.log("sea_order_expire task error",e);
        }

        return ReturnT.SUCCESS;
    }
}