【xxl-job】使用restful api的方式管理任务(动态创建/编辑/删除/启停任务)

前言

首先,当前最新版本2.4.1-SNAPSHOT(20230530)还不支持此操作,只支持简单的restful api。所以需要我们自己在源码基础上改造。但好在后台管理已经实现了相关任务的增删改查。所以我们可以直接复用此部分代码。

直接使用

如果不想关注怎么修改的可以直接使用我修改好的版本:
https://gitee.com/yuanheqiuye/xxl-job,Maven Java工程下载下来打包即可。

xxl-job-admin/src/test/java/com/xxl/job/adminbiz/AdminBizTest.java下有相应的测试用例可以参考使用。

如何修改

从官方文档中可以知道,当前xxl-job提供的restful api com.xxl.job.core.biz.client.AdminBizClient下,那么我们只要在这个类中将所需接口实现,同时实现对应的后台的接口逻辑类com.xxl.job.admin.service.impl.AdminBizImpl。这两个类的父类都是:com.xxl.job.core.biz.AdminBiz,所以我们需要先在其中定义接口:

  • AdminBiz接口定义
	//这里的XxlJobInfo就是后台管理使用的接口参数,所以后台可以实现什么样的添加,接口就可以实现什么样的添加行为,具体怎么传参,不会的话可以在后台添加一个,通过F12看下参数,照葫芦画瓢即可
	public ReturnT<String> addJob(XxlJobInfo jobInfo);

	//更新类似新增
    public ReturnT<String> updateJob(XxlJobInfo jobInfo);

	//删除任务,因为这里要穿json,所以对id参数进行了一层封装
    public ReturnT<String> removeJob(JobIdReq jobIdReq);

	//启动任务,同上
    public ReturnT<String> startJob(JobIdReq jobIdReq);

	//停止任务,同上
    public ReturnT<String> stopJob(JobIdReq jobIdReq);
  • AdminBizClient 客户端实现。太简单了,就不具体说了
  @Override
    public ReturnT<String> addJob(XxlJobInfo jobInfo) {
        return XxlJobRemotingUtil.postBody(addressUrl + "api/addJob", accessToken, timeout, jobInfo, String.class);
    }

    @Override
    public ReturnT<String> updateJob(XxlJobInfo jobInfo) {
        return XxlJobRemotingUtil.postBody(addressUrl + "api/updateJob", accessToken, timeout, jobInfo, String.class);
    }

    @Override
    public ReturnT<String> removeJob(JobIdReq jobIdReq) {
        return XxlJobRemotingUtil.postBody(addressUrl + "api/removeJob", accessToken, timeout, jobIdReq, String.class);
    }

    @Override
    public ReturnT<String> startJob(JobIdReq jobIdReq) {
        return XxlJobRemotingUtil.postBody(addressUrl + "api/startJob", accessToken, timeout, jobIdReq, String.class);
    }

    @Override
    public ReturnT<String> stopJob(JobIdReq jobIdReq) {
        return XxlJobRemotingUtil.postBody(addressUrl + "api/stopJob", accessToken, timeout, jobIdReq, String.class);
    }
  • 后台接口逻辑实现,XxlJobService是后台管理页面用的service,直接注入进来使用即可
@Service
public class AdminBizImpl implements AdminBiz {

    @Resource
    private XxlJobService xxlJobService;
		
	//之前有的代码这里为了简介就删掉了

    @Override
    public ReturnT<String> addJob(XxlJobInfo jobInfo) {
        return xxlJobService.add(jobInfo);
    }

    @Override
    public ReturnT<String> updateJob(XxlJobInfo jobInfo) {
        return xxlJobService.update(jobInfo);
    }

    @Override
    public ReturnT<String> removeJob(JobIdReq jobIdReq) {
        return xxlJobService.remove(jobIdReq.getJobId());
    }

    @Override
    public ReturnT<String> startJob(JobIdReq jobIdReq) {
        return xxlJobService.start(jobIdReq.getJobId());
    }

    @Override
    public ReturnT<String> stopJob(JobIdReq jobIdReq) {
        return xxlJobService.stop(jobIdReq.getJobId());
    }

}

OK,搞定!!

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值