xxl-job任务调度（一）定时任务执行器注册和任务类

前言

本文不介绍关于如何搭建，请去官方文档查看。

（1）配置文件

在yml/yaml中添加如下配置

xxl:
 job:
   admin:
     ### xxl-job admin address list：调度中心部署跟地址：如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行"执行器心跳注册"和"任务结果回调"。
     addresses: http://这里是IP:这里是端口/xxl-job-admin
   ### xxl-job executor address：执行器"AppName"和地址信息配置：AppName执行器心跳注册分组依据；地址信息用于"调度中心请求并触发任务"和"执行器注册"。执行器默认端口为9999，执行器IP默认为空表示自动获取IP，多网卡时可手动设置指定IP，该IP不会绑定Host仅作为通讯实用。单机部署多个执行器时，注意要配置不同执行器端口；
   executor:
     appname: ${spring.application.name}
     ip:
     port: 8311
     ### xxl-job log path：执行器运行日志文件存储的磁盘位置，需要对该路径拥有读写权限
     logpath: d:/zhzy/logs
     ### xxl-job log retention days：执行器Log文件定期清理功能，指定日志保存天数，日志文件过期自动删除。限制至少保持3天，否则功能不生效；
     logretentiondays: 60
   ### xxl-job, access token：执行器通讯TOKEN，非空时启用
   accessToken:

在properties为

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

在pom中添加依赖

       <dependency>
           <groupId>com.xuxueli</groupId>
           <artifactId>xxl-job-core</artifactId>
           <version>2.1.0</version>
           <scope>compile</scope>
       </dependency>

Java中的配置类

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;

/**
 * @author qiaozhen
 * @time 2019/6/25 15:09
 * Copyright (C), 2019, ------司
 */
@Configuration
public class XxlJobConfig {

    @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 Integer port;
    @Value("${xxl.job.accessToken}")
    private String accessToken;
    @Value("${xxl.job.executor.logpath}")
    private String logPath;
    @Value("${xxl.job.executor.logretentiondays}")
    private Integer logRetentionDays;

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

    @Bean(initMethod = "start", destroyMethod = "destroy")
    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;
    }
}

在添加完这几项后，启动本地服务，在服务器端添加对应的执行器

其中AppName是在配置文件中的填写的同名配置项，只要此项和ip端口与配置文件中的一致，就可以进行自动注入。名称将在任务注册时被展示。当同一AppName下有多个服务器，在自动注册时会显示多个ip，即定时任务执行器的分布式部署。
如果在列表中看到了本地服务的ip和在yml中配置的端口，则证明执行器注册成功了。

（2）任务代码

import com.xxl.job.core.biz.model.ReturnT;
import com.xxl.job.core.handler.IJobHandler;
import com.xxl.job.core.handler.annotation.JobHandler;
import com.xxl.job.core.log.XxlJobLogger;
import org.mybatis.spring.MyBatisSystemException;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

import java.util.Date;
import java.util.List;

import static com.knowway.smartedu.stuworker.focus.web.vo.base.BaseCommonUtil.getUUID;

/**
 * @author qiaozhen
 * @time 2019/6/25 16:11
 * Copyright (C), 2019, -有限公司
 */
@JobHandler(value="XXXHandler")
@Component
public class StatisticsHandler extends IJobHandler {

	//在添加了自动扫描后
    @Autowired
    private IService service;
    
    @Override
    public ReturnT<String> execute(String s) throws Exception {
        XxlJobLogger.log(service.now()+"时执行了一次统计");
        //在这里添加要任务逻辑逻辑
    }
}

在这里，需要记住的是@JobHandler注解中添加的value值的名称，之后在服务器端进行添加对应的任务。

另外几项如下，

• 执行器：上一步注册到服务器端的执行器
• 任务描述
• 路由策略：当执行器作为集群存在时，任务的调用规则
  • 第一个
  • 最后一个
  • 轮询：每次换一个
  • 随机
  • 哈希一致性
  • 最不经常使用
  • 最近最久未被使用
  • 故障转移
  • 忙碌转移
  • 分片广播
• Cron：启动后的执行规则（多长时间执行一次，何时执行）
• 运行模式
  • BEAN：表明执行逻辑写在Bean类中，本文即为此类，在扫描后可以将服务中的Service注入进去。
  • GLUE：一种将代码保存在注册中心中的方式。暂未尝试
• JobHandler：只有在运行模式为BEAN时，这一项才会被使用，将本地服务中@JobHandler注解上的value值填入即可
• 阻塞处理策略
  • 单机串行
  • 覆盖之前进度
  • 丢弃之前进度
• 子任务ID
• 任务超时时间
• 失败次数
• 负责人
• 报警邮件
• 任务参数

在添加完成后，在任务管理中即可看到对应的任务。点击执行会执行一次，启动则会按照Corn的规则进行执行调用。每一次执行会生成一个日志，展示调度时间、结果和执行的时间、结果。

其中，调度的结果是调用的结果，失败原因最多的是本地服务的关闭，导致调度中心无法连接到本地服务。而执行结果则是本地程序本身执行的结果，如果失败，则很大程度上是因为本地程序本身存在问题。