xxl-job使用

xxl-job使用

背景说明

项目目前的定时任务没有一个管控平台，定时任务没有管理抓手，调研决定采用目前被广泛使用的分布式定时任务调度平台xxl-job，xxl-job开发迅速、学习简单、轻量级、易扩展。现已开放源代码并接入多家公司线上产品线，开箱即用。

xxl-job使用说明
参考：https://www.xuxueli.com/xxl-job/

功能扩展

xxl-job目前没有开放接口动态来创建、删除、停止定时任务，只能在调度中心后台手动创建定时任务，项目目前的业务场景需要通过接口动态创建定时任务，所以需要进行功能扩展，提供动态管控定时任务的能力。

功能扩展的原则

• 尽量不去修改xxl-job的核心代码，避免升级需要同步维护代码。

• 扩展功能利用现有已经存在的接口，进行开发，对外提供API单独启用新类，避免升级，代码冲突合并问题。

• 新增的Dao接口、Mapper文件单独启用新文件，避免升级，代码冲突合并问题。

• 接口调用鉴权：因为新增的接口直接暴露出新增、删除、修改等核心API，需要进行接口调用的合法性校验。

• 尽量简化调用，封装易用API。

• 单独升级版本，维护特定版本。

调度中心(xxl-job-admin)新增接口

xxl-job.zip 修改代码

对外接口：com.xxl.job.admin.controller.ApiController

   /**
     * 新增job
     */
    private static final String ADD_URL = "/external/api/addJob";
    /**
     * 更新job
     */
    private static final String UPDATE_URL = "/external/api/updateJob";
    /**
     * 删除job
     */
    private static final String REMOVE_URL = "/external/api/removeJob";
    /**
     * 终止job
     */
    private static final String PAUSE_URL = "/external/api/pauseJob";
    /**
     * 启动job
     */
    private static final String START_URL = "/external/api/startJob";
    /**
     * 新增并启动job
     */
    private static final String ADD_START_URL = "/external/api/addAndStart";

接口鉴权

通过接口调用参数md5加密校验

com.xxl.job.core.util.Md5AuthenticateUtil#md5Hex

具体接入

部署调度中心

单独部署调度中心(xxl-job-admin) 目前一个实例，可以集群化部署。

• 初始化数据库脚本 /xxl-job/doc/db/tables_xxl_job.sql
• 修改application.properties配置文件

xxl.job.accessToken：增加安全性

spring.datasource：替换成自己的mysql地址

部署执行器

执行器和具体要接入定时任务的微服务绑定，增加配置即可，执行器可集群化。

如：liang-ota-server

增加执行器配置文件

#xxl-job执行器配置
xxl:
  job:
    accessToken: xxxxx
    admin:
      addresses: http://127.0.0.1:8080/xxl-job-admin
    executor:
      address: ''
      appname: xxl-job-executor-liang
      ip: ''
      logpath: /data/applogs/xxl-job/liang
      logretentiondays: 30
      port: 9089

执行器需要先在调度中心配置

微服务接入

        <!-- 接入 xxl-job -->
        <dependency>
            <groupId>com.xuxueli</groupId>
            <artifactId>xxl-job-core</artifactId>
            <version>2.3.1-liang-SNAPSHOT</version>
        </dependency>

增加xxl-job配置

@Configuration
public class XxlJobConfig {
    private static final 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();
     */


}

以Bean模式编写具体的定时任务处理类

@Component
public class LiangXxlJobDemo {

	@XxlJob("LiangXxlJobHandler")
	public void liangXxlJobHandler() throws Exception {
		XxlJobHelper.log("Liang-job:LIANG-JOB, Hello World.");

		for (int i = 0; i < 5; i++) {
			XxlJobHelper.log("Liang-job:beat at:" + i);
			TimeUnit.SECONDS.sleep(2);
		}
	}
}

调用API:对外接口已经全部封装，直接引用 ExternalXxlJobRemotingUtil 该类即可

demo

public class XxlJobTests {

	@Test
    public void testAddAndStart() {
        ExternalXxlJobInfo jobInfo = getExternalXxlJobInfo();
        String result = ExternalXxlJobRemotingUtil.addAndStart(jobInfo);
        System.out.println("-----------------------------:"+result);
    }

    private ExternalXxlJobInfo getExternalXxlJobInfo() {
        ExternalXxlJobInfo jobInfo = new ExternalXxlJobInfo();
        jobInfo.setJobDesc("LiangXxlJobHandler-测试！！");
        jobInfo.setAddTime(new Date());
        jobInfo.setUpdateTime(new Date());
        jobInfo.setAuthor("liang");
        jobInfo.setAlarmEmail("liang@xxx.com");
        jobInfo.setScheduleType(ScheduleTypeEnum.CRON.name());
        jobInfo.setScheduleConf("0 0/2 * * * ?");
        jobInfo.setMisfireStrategy(MisfireStrategyEnum.DO_NOTHING.name());
        jobInfo.setExecutorRouteStrategy(ExecutorRouteStrategyEnum.FIRST.name());
        jobInfo.setExecutorHandler("LiangXxlJobHandler");
        jobInfo.setExecutorBlockStrategy(ExecutorBlockStrategyEnum.SERIAL_EXECUTION.name());
        jobInfo.setExecutorTimeout(0);
        jobInfo.setExecutorFailRetryCount(0);
        jobInfo.setGlueType(GlueTypeEnum.BEAN.name());
        jobInfo.setAppname("xxl-job-executor-liang");
        return jobInfo;
    }
}

注意：appname就是在调用中心配置的执行器名称 executorHandler 就是@XxlJob(“LiangXxlJobHandler”) 中的value

可在调度中心刚到刚刚创建并启动的定时任务