动态添加xxljob任务-xxljob源码改造

news2025/2/5 14:49:47

在实际开发中，很多时候需要在代码中动态添加和执行xxljob的任务，那么原来的xxljob任务调度平台不能完成这项需求，就需要对源码进行改造。

1. 分析源码

1.1 请求路径

在任务调度平台新建一个任务，保存，查看发送的请求，请求路径为/jobinfo/add
在这里插入图片描述在idea的xxl-job-admin工程中，ctrl+shift+a搜索/jobinfo/add。

发现在JobInfoController中，有关于对任务的操作。
在这里插入图片描述

1.2 权限校验

在xxljob的请求中，权限校验是保存在Cookie中的
在这里插入图片描述

寻找权限校验拦截器，发现是在loginService.ifLogin( )方法中实现了权限校验
在这里插入图片描述

权限校验流程为，从Cookie中获取"XXL_JOB_LOGIN_IDENTITY"的值作为token，然后解析token，再检查密码是否匹配
在这里插入图片描述

2. 修改校验流程

2.1 XxlJobRemotingUtil.postBody( )

在xxl-job-core模块里有关于远程发送请求的工具类方法postBody( )
在这里插入图片描述
这个方法的大概内容就是：发送一个HTTP POST请求，将token设置在Header里，key为"XXL-JOB-ACCESS-TOKEN"，将请求参数设置在RequestBody里面。与在调度平台中发送的请求的区别为：1. 调度平台将token设置在Cookie里，key为"XXL_JOB_LOGIN_IDENTITY"；2. 调度平台将请求参数放在了url上，没有放在RequestBody。

2.2 修改校验流程并测试

在后续改动中，我们会使用XxlJobRemotingUtil.postBody( )方法去发送请求添加任务，这个方法不需要Cookie，将token从Cookie转到了"XXL-JOB-ACCESS-TOKEN"中，因此对权限校验流程作以下修改：
在这里插入图片描述
这样，远程请求将token保存在"XXL-JOB-ACCESS-TOKEN"中，而调度平台发送的请求保存在Cookie中，权限校验对两个类型的请求都生效。
在postman中测试：

3. 远程添加

3.1 添加一个远程add任务的方法

在这里插入图片描述

3.2 测试

仿照add请求中的参数
在这里插入图片描述

使用postman
在这里插入图片描述

使用XxlJobRemotingUtil.postBody( )
这里需要改一下才不会报错，其中content是任务id

ReturnT returnT = GsonTool.fromJson(resultJson, ReturnT.class, returnTargClassOfT);
//改为
ReturnT returnT = GsonTool.fromJson(resultJson, ReturnT.class);

在这里插入图片描述

4. 封装XxlJobRemoteApi

XxlJobRemotingUtil.postBody( )不好用，只能支持post请求，因此自己封装一套远程调用xxljob的api

@Component
public class XxlJobRemoteApi {

    @Autowired
    private RestTemplate restTemplate;
    

    /****
     * 添加任务
     */
    public void addJob(String cron,Integer id,String taskName){
        //1)将数据封装成Map   Map->XxlJobInfo
        Map<String,Object> dataMap = new HashMap<String,Object>();
        dataMap.put("jobGroup",1);
        dataMap.put("jobDesc","动态定时任务作业");
        dataMap.put("author","张三");
        dataMap.put("scheduleType","CRON");
        //执行时间
        dataMap.put("scheduleConf",cron);  //动态的
        dataMap.put("cronGen_display",cron);  //动态的
        dataMap.put("glueType","BEAN");
        //哪个任务
        dataMap.put("executorHandler",taskName); //动态的
        dataMap.put("executorParam",id);  //订单ID
        dataMap.put("executorRouteStrategy","FIRST");
        dataMap.put("misfireStrategy","DO_NOTHING");
        dataMap.put("executorBlockStrategy","SERIAL_EXECUTION");
        dataMap.put("executorTimeout",0);
        dataMap.put("executorFailRetryCount",0);
        dataMap.put("glueRemark","GLUE代码初始化");


        //2）XxlJobRemotingUtil实现远程调用
        // url  、参数 、accessToken
        String url = "http://localhost:8080/xxl-job-admin/jobinfo/json/add";
        String token ="7b226964223a312c22757365726e616d65223a2261646d696e222c2270617373776f7264223a226531306164633339343962613539616262653536653035376632306638383365222c22726f6c65223a312c227065726d697373696f6e223a6e756c6c7d";
        ReturnT returnT = XxlJobRemotingUtil.postBody(
                url,    //请求地址
                token,  //令牌信息
                10,
                dataMap,
                ReturnT.class);//返回数据转换对象
        System.out.println(returnT);
    }


    /***
     * 删除任务
     *  http://localhost:8080/xxl-job-admin/jobinfo/delete/{id}
     *
     * @param id:xxl-job中的任务id
     */
    public void removeJob(Integer id){
        //restTemplate.delete("http://localhost:8080/xxl-job-admin/jobinfo/delete/"+id);
        Map<String,Object> dataMap = new HashMap<String,Object>();
        String url ="http://localhost:8080/xxl-job-admin/jobinfo/delete/"+id;
        Map<String,Object> headers = new HashMap<String,Object>();
        headers.put("XXL-JOB-ACCESS-TOKEN","7b226964223a312c22757365726e616d65223a2261646d696e222c2270617373776f7264223a226531306164633339343962613539616262653536653035376632306638383365222c22726f6c65223a312c227065726d697373696f6e223a6e756c6c7d");
        remote(url,headers,dataMap,HttpMethod.DELETE);
    }


    /***
     * 抽取远程调用
     * @param url 远程请求地址
     * @param headers 请求头数据
     * @param dataMap 请求参数
     */
    public void remote(String url, Map<String,Object> headers,Map<String, Object> dataMap,HttpMethod method){
        // 请求头参数
        HttpHeaders requestHeaders = new HttpHeaders();
        for (Map.Entry<String, Object> entry : headers.entrySet()) {
            requestHeaders.set(entry.getKey(),entry.getValue().toString());
        }

        // 请求体封装
        HttpEntity<Object> requestEntity = new HttpEntity<>(requestHeaders);

        // 请求回调
        RequestCallback requestCallback = restTemplate.httpEntityCallback(requestEntity);

        // 第三方返回结果提取
        ResponseExtractor<ResponseEntity<String>> responseExtractor = restTemplate.responseEntityExtractor(String.class);

        // 执行
        ResponseEntity<String> response = restTemplate.execute(url, method, requestCallback, responseExtractor, dataMap);

        //响应的数据
        String body = response.getBody();
    }


}