Springboot整合x(chóng)xljob,自定義添加、修改、刪除、停止、啟動(dòng)任務(wù)方式
更新時(shí)間：2025年04月29日 11:10:08 作者：藍(lán)眸少年CY
這篇文章主要介紹了Springboot整合x(chóng)xljob,自定義添加、修改、刪除、停止、啟動(dòng)任務(wù)方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教
本次自定義方式分為兩種：一種是模擬登錄，另一種是使用注解的方式
一、模擬登錄方式
修改xxl-job-admin工程，在controller里面添加一個(gè)MyApiController，在里面添加自定義的增刪等方法
@RestController
@RequestMapping("/api/myjobinfo")
public class MyApiController {
private static Logger logger = LoggerFactory.getLogger(MyDynamicApiController.class);
@Autowired
private XxlJobService xxlJobService;
@Autowired
private LoginService loginService;
@RequestMapping(value = "/pageList",method = RequestMethod.POST)
public Map<String, Object> pageList(@RequestBody XxlJobQuery xxlJobQuery) {
return xxlJobService.pageList(
xxlJobQuery.getStart(),
xxlJobQuery.getLength(),
xxlJobQuery.getJobGroup(),
xxlJobQuery.getTriggerStatus(),
xxlJobQuery.getJobDesc(),
xxlJobQuery.getExecutorHandler(),
xxlJobQuery.getAuthor());
}
@PostMapping("/save")
public ReturnT<String> add(@RequestBody(required = true)XxlJobInfo jobInfo) {
long nextTriggerTime = 0;
try {
Date nextValidTime = new CronExpression(jobInfo.getJobCron()).getNextValidTimeAfter(new Date(System.currentTimeMillis() + JobScheduleHelper.PRE_READ_MS));
if (nextValidTime == null) {
return new ReturnT<String>(ReturnT.FAIL_CODE, I18nUtil.getString("jobinfo_field_cron_never_fire"));
}
nextTriggerTime = nextValidTime.getTime();
} catch (ParseException e) {
logger.error(e.getMessage(), e);
return new ReturnT<String>(ReturnT.FAIL_CODE, I18nUtil.getString("jobinfo_field_cron_unvalid")+" | "+ e.getMessage());
}
jobInfo.setTriggerStatus(1);
jobInfo.setTriggerLastTime(0);
jobInfo.setTriggerNextTime(nextTriggerTime);
jobInfo.setUpdateTime(new Date());
if(jobInfo.getId()==0){
return xxlJobService.add(jobInfo);
}else{
return xxlJobService.update(jobInfo);
}
}
@RequestMapping(value = "/delete",method = RequestMethod.GET)
public ReturnT<String> delete(int id) {
return xxlJobService.remove(id);
}
@RequestMapping(value = "/start",method = RequestMethod.GET)
public ReturnT<String> start(int id) {
return xxlJobService.start(id);
}
@RequestMapping(value = "/stop",method = RequestMethod.GET)
public ReturnT<String> stop(int id) {
return xxlJobService.stop(id);
}
@RequestMapping(value="login", method=RequestMethod.GET)
@PermissionLimit(limit=false)
public ReturnT<String> loginDo(HttpServletRequest request, HttpServletResponse response, String userName, String password, String ifRemember){
boolean ifRem = (ifRemember!=null && ifRemember.trim().length()>0 && "on".equals(ifRemember))?true:false;
ReturnT<String> result= loginService.login(request, response, userName, password, ifRem);
return result;
}
}- 此方式優(yōu)點(diǎn)：除了登錄接口為，其他接口都需要校驗(yàn)
- 缺點(diǎn)：調(diào)用接口前需要登錄，比較繁瑣
二、注解方式
在項(xiàng)目中，有一個(gè)JobInfoController類,，這個(gè)類就是處理各種新增任務(wù)，修改任務(wù)，觸發(fā)任務(wù)；但這些接口都是后臺(tái)管理頁(yè)面使用的，要想調(diào)用就必須要先登錄，也就是方式一，然而xxl-job已經(jīng)為我們提供了一個(gè)注解，通過(guò)這個(gè)注解的配置可以跳過(guò)登錄進(jìn)行訪問(wèn)，這個(gè)注解就是 @PermissionLimit(limit = false) ,將limit設(shè)置為false即可，默認(rèn)是true,也就是需要做登錄驗(yàn)證。我們可以在自己定義的Controller上使用這個(gè)注解。
@RestController
@RequestMapping("/api/myjobinfo")
public class MyApiController {
@RequestMapping("/add")
@ResponseBody
@PermissionLimit(limit = false)
public ReturnT<String> addJobInfo(@RequestBody XxlJobInfo jobInfo) {
return xxlJobService.add(jobInfo);
}
@RequestMapping("/update")
@ResponseBody
@PermissionLimit(limit = false)
public ReturnT<String> updateJobCron(@RequestBody XxlJobInfo jobInfo) {
return xxlJobService.updateCron(jobInfo);
}
@RequestMapping("/remove")
@ResponseBody
@PermissionLimit(limit = false)
public ReturnT<String> removeJob(@RequestBody XxlJobInfo jobInfo) {
return xxlJobService.remove(jobInfo.getId());
}
@RequestMapping("/pauseJob")
@ResponseBody
@PermissionLimit(limit = false)
public ReturnT<String> pauseJob(@RequestBody XxlJobInfo jobInfo) {
return xxlJobService.stop(jobInfo.getId());
}
@RequestMapping("/start")
@ResponseBody
@PermissionLimit(limit = false)
public ReturnT<String> startJob(@RequestBody XxlJobInfo jobInfo) {
return xxlJobService.start(jobInfo.getId());
}
@RequestMapping("/stop")
@ResponseBody
public ReturnT<String> pause(int id) {
return xxlJobService.stop(id);
}
@RequestMapping("/addAndStart")
@ResponseBody
@PermissionLimit(limit = false)
public ReturnT<String> addAndStart(@RequestBody XxlJobInfo jobInfo) {
ReturnT<String> result = xxlJobService.add(jobInfo);
int id = Integer.valueOf(result.getContent());
xxlJobService.start(id);
return result;
}
}- 該方式的優(yōu)點(diǎn)：無(wú)需登錄可以直接調(diào)用接口
- 缺點(diǎn)：接口全部暴露有一定的風(fēng)險(xiǎn)
將admin項(xiàng)目編譯打包后放入服務(wù)器，客戶端就可以開(kāi)始調(diào)用了....
三、訪問(wèn)者調(diào)用
1、創(chuàng)建實(shí)體
@Data
public class XxlJobInfo {
private int id; // 主鍵ID
private int jobGroup; // 執(zhí)行器主鍵ID
private String jobDesc; // 備注
private String jobCron;
private Date addTime;
private Date updateTime;
private String author; // 負(fù)責(zé)人
private String alarmEmail; // 報(bào)警郵件
private String scheduleType; // 調(diào)度類型
private String scheduleConf; // 調(diào)度配置，值含義取決于調(diào)度類型
private String misfireStrategy; // 調(diào)度過(guò)期策略
private String executorRouteStrategy; // 執(zhí)行器路由策略
private String executorHandler; // 執(zhí)行器，任務(wù)Handler名稱
private String executorParam; // 執(zhí)行器，任務(wù)參數(shù)
private String executorBlockStrategy; // 阻塞處理策略
private int executorTimeout; // 任務(wù)執(zhí)行超時(shí)時(shí)間，單位秒
private int executorFailRetryCount; // 失敗重試次數(shù)
private String glueType; // GLUE類型 #com.xxl.job.core.glue.GlueTypeEnum
private String glueSource; // GLUE源代碼
private String glueRemark; // GLUE備注
private Date glueUpdatetime; // GLUE更新時(shí)間
private String childJobId; // 子任務(wù)ID，多個(gè)逗號(hào)分隔
private int triggerStatus; // 調(diào)度狀態(tài)：0-停止，1-運(yùn)行
private long triggerLastTime; // 上次調(diào)度時(shí)間
private long triggerNextTime; // 下次調(diào)度時(shí)間
}2、創(chuàng)建一個(gè)工具類
也可以不創(chuàng)建直接調(diào)用
public class XxlJobUtil {
private static String cookie="";
/**
* 查詢現(xiàn)有的任務(wù)
* @param url
* @param requestInfo
* @return
* @throws HttpException
* @throws IOException
*/
public static JSONObject pageList(String url,JSONObject requestInfo) throws HttpException, IOException {
String path = "/api/jobinfo/pageList";
String targetUrl = url + path;
HttpClient httpClient = new HttpClient();
PostMethod post = new PostMethod(targetUrl);
post.setRequestHeader("cookie", cookie);
RequestEntity requestEntity = new StringRequestEntity(requestInfo.toString(), "application/json", "utf-8");
post.setRequestEntity(requestEntity);
httpClient.executeMethod(post);
JSONObject result = new JSONObject();
result = getJsonObject(post, result);
System.out.println(result.toJSONString());
return result;
}
/**
* 新增/編輯任務(wù)
* @param url
* @param requestInfo
* @return
* @throws HttpException
* @throws IOException
*/
public static JSONObject addJob(String url,JSONObject requestInfo) throws HttpException, IOException {
String path = "/api/jobinfo/save";
String targetUrl = url + path;
HttpClient httpClient = new HttpClient();
PostMethod post = new PostMethod(targetUrl);
post.setRequestHeader("cookie", cookie);
RequestEntity requestEntity = new StringRequestEntity(requestInfo.toString(), "application/json", "utf-8");
post.setRequestEntity(requestEntity);
httpClient.executeMethod(post);
JSONObject result = new JSONObject();
result = getJsonObject(post, result);
System.out.println(result.toJSONString());
return result;
}
/**
* 刪除任務(wù)
* @param url
* @param id
* @return
* @throws HttpException
* @throws IOException
*/
public static JSONObject deleteJob(String url,int id) throws HttpException, IOException {
String path = "/api/jobinfo/delete?id="+id;
return doGet(url,path);
}
/**
* 開(kāi)始任務(wù)
* @param url
* @param id
* @return
* @throws HttpException
* @throws IOException
*/
public static JSONObject startJob(String url,int id) throws HttpException, IOException {
String path = "/api/jobinfo/start?id="+id;
return doGet(url,path);
}
/**
* 停止任務(wù)
* @param url
* @param id
* @return
* @throws HttpException
* @throws IOException
*/
public static JSONObject stopJob(String url,int id) throws HttpException, IOException {
String path = "/api/jobinfo/stop?id="+id;
return doGet(url,path);
}
public static JSONObject doGet(String url,String path) throws HttpException, IOException {
String targetUrl = url + path;
HttpClient httpClient = new HttpClient();
HttpMethod get = new GetMethod(targetUrl);
get.setRequestHeader("cookie", cookie);
httpClient.executeMethod(get);
JSONObject result = new JSONObject();
result = getJsonObject(get, result);
return result;
}
private static JSONObject getJsonObject(HttpMethod postMethod, JSONObject result) throws IOException {
if (postMethod.getStatusCode() == HttpStatus.SC_OK) {
InputStream inputStream = postMethod.getResponseBodyAsStream();
BufferedReader br = new BufferedReader(new InputStreamReader(inputStream));
StringBuffer stringBuffer = new StringBuffer();
String str;
while((str = br.readLine()) != null){
stringBuffer.append(str);
}
String response = new String(stringBuffer);
br.close();
return (JSONObject) JSONObject.parse(response);
} else {
return null;
}
}
/**
* 登錄
* @param url
* @param userName
* @param password
* @return
* @throws HttpException
* @throws IOException
*/
public static String login(String url, String userName, String password) throws HttpException, IOException {
String path = "/api/jobinfo/login?userName="+userName+"&password="+password;
String targetUrl = url + path;
HttpClient httpClient = new HttpClient();
HttpMethod get = new GetMethod((targetUrl));
httpClient.executeMethod(get);
if (get.getStatusCode() == 200) {
Cookie[] cookies = httpClient.getState().getCookies();
StringBuffer tmpcookies = new StringBuffer();
for (Cookie c : cookies) {
tmpcookies.append(c.toString() + ";");
}
cookie = tmpcookies.toString();
} else {
try {
cookie = "";
} catch (Exception e) {
cookie="";
}
}
return cookie;
}
}如果是方式二可以直接調(diào)用，無(wú)需登錄
四、測(cè)試
如果是方式二，無(wú)需登錄，也就不用再請(qǐng)求頭里面設(shè)置cookie
@RestController
public class TestController {
@Value("${xxl.job.admin.addresses:''}")
private String adminAddresses;
@Value("${xxl.job.admin.login-username:admin}")
private String loginUsername;
@Value("${xxl.job.admin.login-pwd:123456}")
private String loginPwd;
//登陸
private void xxljob_login()
{
try {
XxlJobUtil.login(adminAddresses,loginUsername,loginPwd);
} catch (IOException e) {
throw new RuntimeException(e);
}
}
@RequestMapping(value = "/pageList",method = RequestMethod.GET)
public Object pageList() throws IOException {
// int jobGroup, int triggerStatus, String jobDesc, String executorHandler, String author
JSONObject test=new JSONObject();
test.put("length",10);
xxljob_login();
JSONObject response = XxlJobUtil.pageList(adminAddresses, test);
return response.get("data");
}
@RequestMapping(value = "/add",method = RequestMethod.GET)
public Object add() throws IOException {
XxlJobInfo xxlJobInfo=new XxlJobInfo();
xxlJobInfo.setJobCron("0/1 * * * * ?");
xxlJobInfo.setJobGroup(3);
xxlJobInfo.setJobDesc("Test XXl-job");
xxlJobInfo.setAddTime(new Date());
xxlJobInfo.setUpdateTime(new Date());
xxlJobInfo.setAuthor("Test");
xxlJobInfo.setAlarmEmail("1234567@com");
xxlJobInfo.setScheduleType("CRON");
xxlJobInfo.setScheduleConf("0/1 * * * * ?");
xxlJobInfo.setMisfireStrategy("DO_NOTHING");
xxlJobInfo.setExecutorRouteStrategy("FIRST");
xxlJobInfo.setExecutorHandler("clockInJobHandler_1");
xxlJobInfo.setExecutorParam("att");
xxlJobInfo.setExecutorBlockStrategy("SERIAL_EXECUTION");
xxlJobInfo.setExecutorTimeout(0);
xxlJobInfo.setExecutorFailRetryCount(1);
xxlJobInfo.setGlueType("BEAN");
xxlJobInfo.setGlueSource("");
xxlJobInfo.setGlueRemark("初始化");
xxlJobInfo.setGlueUpdatetime(new Date());
JSONObject test = (JSONObject) JSONObject.toJSON(xxlJobInfo);
xxljob_login();
JSONObject response = XxlJobUtil.addJob(adminAddresses, test);
if (response.containsKey("code") && 200 == (Integer) response.get("code")) {
String jobId = response.getString("content");
System.out.println("新增成功,jobId:" + jobId);
} else {
System.out.println("新增失敗");
}
return response;
}
@RequestMapping(value = "/stop/{jobId}",method = RequestMethod.GET)
public void stop(@PathVariable("jobId") Integer jobId) throws IOException {
xxljob_login();
JSONObject response = XxlJobUtil.stopJob(adminAddresses, jobId);
if (response.containsKey("code") && 200 == (Integer) response.get("code")) {
System.out.println("任務(wù)停止成功");
} else {
System.out.println("任務(wù)停止失敗");
}
}
@RequestMapping(value = "/delete/{jobId}",method = RequestMethod.GET)
public void delete(@PathVariable("jobId") Integer jobId) throws IOException {
xxljob_login();
JSONObject response = XxlJobUtil.deleteJob(adminAddresses, jobId);
if (response.containsKey("code") && 200 == (Integer) response.get("code")) {
System.out.println("任務(wù)移除成功");
} else {
System.out.println("任務(wù)移除失敗");
}
}
@RequestMapping(value = "/start/{jobId}",method = RequestMethod.GET)
public void start(@PathVariable("jobId") Integer jobId) throws IOException {
xxljob_login();
JSONObject response = XxlJobUtil.startJob(adminAddresses, jobId);
if (response.containsKey("code") && 200 == (Integer) response.get("code")) {
System.out.println("任務(wù)啟動(dòng)成功");
} else {
System.out.println("任務(wù)啟動(dòng)失敗");
}
}
}總結(jié)
以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。
相關(guān)文章
這篇文章主要介紹了jdk在centos中安裝配置圖文教程,文中給出大家jdk下載地址，需要的朋友可以參考下2018-04-04
基于自定義校驗(yàn)注解(controller、method、(groups)分組的使用)
這篇文章主要介紹了基于自定義校驗(yàn)注解(controller、method、(groups)分組的使用)，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-10-10
這篇文章主要介紹了淺談hibernate中懶加載禁用操作，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2020-10-10
SpringBoot實(shí)現(xiàn)文件上傳下載功能小結(jié)
最近做的一個(gè)項(xiàng)目涉及到文件上傳與下載功能。SpringBoot后臺(tái)如何實(shí)現(xiàn)文件上傳下載呢？下面有單文件上傳和多文件上傳功能，感興趣的朋友一起看看吧2017-08-08
排查Java進(jìn)程內(nèi)存占比過(guò)高的方法
某天下午運(yùn)維反應(yīng)集成環(huán)境的一個(gè)Java服務(wù)內(nèi)存飆高,內(nèi)存耗的太高了,會(huì)疑似內(nèi)存泄漏,所以本文記一次排查Java進(jìn)程內(nèi)存占比過(guò)高的解決方法,需要的朋友可以參考下2023-10-10
SpringBoot異步Async使用Future與CompletableFuture區(qū)別小結(jié)
本文主要介紹了SpringBoot異步Async使用Future與CompletableFuture區(qū)別小結(jié)，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2023-06-06
本篇文章給大家?guī)?lái)的內(nèi)容是關(guān)于Java中Map集合的常用方法詳解，有一定的參考價(jià)值，有需要的朋友可以參考一下，希望對(duì)你有所幫助。下面我們就來(lái)學(xué)習(xí)一下吧2021-11-11
基于JAVA代碼 獲取手機(jī)基本信息（本機(jī)號(hào)碼，SDK版本，系統(tǒng)版本，手機(jī)型號(hào)）
本文給大家介紹基于java代碼獲取手機(jī)基本信息，包括獲取電話管理對(duì)象、獲取手機(jī)號(hào)碼、獲取手機(jī)型號(hào)、獲取SDK版本、獲取系統(tǒng)版本等相關(guān)信息，對(duì)本文感興趣的朋友一起學(xué)習(xí)吧2015-12-12
今天繼續(xù)Java的課題,兩天沒(méi)有做任何事情,過(guò)了個(gè)自在的周末,但是不知道為什么總是有點(diǎn)淡淡的憂桑.之前游戲服務(wù)器的數(shù)據(jù)源使用的是阿里巴巴的Druid,今天就大概說(shuō)說(shuō)數(shù)據(jù)源,給個(gè)實(shí)例,需要的朋友可以參考下2021-06-06
Spring響應(yīng)式編程之Reactor操作符詳解
文章介紹了Reactor庫(kù)中常用的響應(yīng)式流操作符,分為創(chuàng)建、轉(zhuǎn)換、組合、條件和錯(cuò)誤處理五類,詳細(xì)列舉了每類操作符的功能和用途,這些操作符旨在提高響應(yīng)式流的可讀性和開(kāi)發(fā)效率,幫助開(kāi)發(fā)者更高效地處理數(shù)據(jù)流2025-09-09