xxl-job使用restful api的方式管理任务动

BUG弄潮儿

发布于 2026-03-25 11:13:33

690

前言

项目中有时需要动态创建job；虽然xxl-job目前没有进行openapi开放，但是xxl-job的管理后台已经有这样的接口，只要进行一定的封装开放出来，就可以在应用服务通过restful api的方式调用创建job、更新job、删除job、启动job、停止job了。

https://gitee.com/xuxueli0323/xxl-job

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

如何修改

从官方文档中可以知道

https://www.xuxueli.com/xxl-job/#六、调度中心/执行器%20OpenApi

当前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());
    }

}

本文参与腾讯云自媒体同步曝光计划，分享自微信公众号。

原始发表：2025-03-28，如有侵权请联系 cloudcommunity@tencent.com 删除

api