Skip to content

快速集成XXL-JOB,通过java代码控制xxl-job管理平台,动态添加任务,修改任务,删除任务,开始任务,暂停任务,查询任务,执行任务等等

Notifications You must be signed in to change notification settings

aitxiaogang/xxl-job-boot-starter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

60 Commits
 
 
 
 
 
 
 
 

Repository files navigation

关于文档

  1. 此项目比较简单,所有的功能都在XxlJobService接口类里面,方法声明有注释,一看就明白作用。类路径:src/main/java/com/xiaogang/xxljobadminsdk/service/XxlJobService.java
  2. 有任何问题欢迎看当前页面底部的加QQ群方式进群讨论

更新说明:2023-10-13

1.在2.3.1版本基础上添加了自动注册执行器与jobHandler的功能,直接使用@xxlRegistry注解标识jobHandler需要自动注册,如需自动注入,需配置groupTitle

更新说明:2023-03-21(已上传MAVEN中央仓库)

  1. 升级xxl-job-core到最新版(2.3.1),新版本消除了缺陷,其它更新可以查看官网
  2. 升级项目第三方组件依赖的版本,升级到没有漏洞缺陷的版本

更新说明:2023-03-17

  1. 项目启动之前校验每一个配置参数,如果参数错误会终止项目启动,避免配置错误却不知道执行器启动失败
  2. 将accessToken校验提前到项目启动完成之前,避免accessToken配置错误但是项目还是启动成功影响业务
  3. 每个配置参数添加对应错误提示
  4. 减少不必要的配置参数,降低集成成本,更好使用
  5. 不用再配置jobGroupId,添加任务的执行器默认为appname对应的执行器id
  6. 新增数个操作任务的方法,现在任务相关CRUD方法更充足,多样
  7. 多个方法重载实现相同功能,降低方法调用成本。删除不必要参数
  8. 新增查询执行器功能
  9. 新增只在某个时间执行一次的任务方法,参数更少,添加任务更方便
  10. 新增通过自定义字符串id作为唯一条件查询任务信息或者任务id,操作某个任务更方便(使用的任务负责人(author)字段实现,xxl-job的负责人字段查询是模糊查询,所以自定义id需要差别尽量大)
  11. 删除,停止,启动都提供了两种方法,分别操作一个和操作符合条件的所有任务
  12. 2.3.0-jobinfo-executor-2是最新版并合并到了master
  13. bug修复

项目介绍

  1. 使用java代码控制xxl-job-admin。使用代码添加job的CRUD等功能
  2. 项目使用的xxl-job-admin版本为2.3.1
  3. 此项目版本号对应xxl-job-admin版本号
  4. 配置了用户名密码之后,此模块会模拟登录请求admin来实现功能
  5. 想要通过代码往admin里面操作job等功能,只需要在springboot项目中引入此项目,配置关键参数,引入sdk类就可以了,其它什么都不用关心了
  6. 默认配置了XxlJobSpringExecutor,所以不用再额外配置此类交给Spring管理了

下面是自动配置类,默认配置如下

@Data
@ConfigurationProperties(prefix = "xxl.job.sdk")
@Configuration
public class XxlJobAdminProperties {
    private String adminUrl = "http://localhost:8080/xxl-job-admin";
    private String userName = "admin";
    private String password = "123456";
    private Integer connectionTimeOut = 5000;

    //执行器AppName [选填]:执行器心跳注册分组依据;为空则关闭自动注册
    private String appname;
    //执行器通讯TOKEN [选填]:非空时启用;
    private String accessToken;
    //执行器注册 [选填]:优先使用该配置作为注册地址,为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
    private String address;
    //执行器IP [选填]:默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册" 和 "调度中心请求并触发任务";
    private String ip;
    //执行器端口号 [选填]:小于等于0则自动获取;默认端口为9999,单机部署多个执行器时,注意要配置不同执行器端口;
    private Integer port;
    //执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径;
    private String logPath;
    //执行器日志文件保存天数 [选填] : 过期日志自动清理, 限制值大于等于3时生效; 否则, 如-1, 关闭自动清理功能;
    private Integer logRetentionDays = 30;

}

使用方法

<dependency>
    <groupId>com.lxgnb</groupId>
    <artifactId>xxl-job-boot-starter</artifactId>
    <version>2.3.0-jobinfo-executor-2</version>
</dependency>
  1. pom文件中添加上面的依赖坐标(已上传到maven中央仓库)
  2. 添加配置项,配置参数如下
  3. image
  4. 接下来注入关键的类,使用XxlJobService来控制job的crud
  5. image

添加job

  1. 添加任务有四个方法,对应的参数个数不一样,截图如下
  2. image
  3. XxlJobInfo 这是参数最全的类,官方有哪些参数,这个类就有哪些字段
  4. XxlJobInfoAddParam 这个是必填参数,其它参数和在网页上添加任务的默认参数一样
  5. DefaultXxlJobAddParam 这个和 XxlJobInfoAddParam差不多,区别在于默认参数这个类也有字段,可以修改,XxlJobInfoAddParam就只有必填参数,不能修改默认参数
  6. addJustExecuteOnceJob是2.3.0-jobinfo-executor-2新增的方法,因为很多业务只需要执行一次,为了方便添加此类业务,新增了此方法,并且还有和此配套的getJobIdByCustomId方法,方便对此任务进行修改或者删除
  7. 之所以提供三个方法来添加任务是为了方便添加任务,不用每个参数都去设置

使用方法就是这样,后续看项目情况也许会接入其它接口。 如果大家有什么问题,欢迎大家提出来。这个项目写的很粗糙,大家有什么意见和建议,非常欢迎大家来交流。谢谢

QQ群

点击链接加入群聊【xxl-job-boot-starter】:https://jq.qq.com/?_wv=1027&k=7T9xX7XY 群号:709425770

About

快速集成XXL-JOB,通过java代码控制xxl-job管理平台,动态添加任务,修改任务,删除任务,开始任务,暂停任务,查询任务,执行任务等等

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages