小言_互联网的博客

spring boot集成xxl job

345人阅读  评论(0)

目录

1.xxl job介绍

2.搭建说明

(1)配置调度中心

(2)配置执行器

(3).执行


1.xxl job介绍

官网地址:分布式任务调度平台XXL-JOB

XXL-JOB是一个分布式任务调度平台,其核心设计目标是开发迅速、学习简单、轻量级、易扩展。

2.搭建说明

环境搭建主要分为两个部分。调度中心和执行器。

从git上下载调度中心的代码,分为以下几个部分。

  • xxl-job-admin:调度中心
  • xxl-job-core:公共依赖
  • xxl-job-executor-samples:执行器Sample示例(选择合适的版本执行器,可直接使用,也可以参考其并将现有项目改造成执行器)
  • :xxl-job-executor-sample-springboot:Springboot版本,通过Springboot管理执行器,推荐这种方式;
  • :xxl-job-executor-sample-frameless:无框架版本;

(1)配置调度中心

配置文件(下面只是配置文件的部分内容,详细的看git中的工程)中有以下内容需要注意:

  • 修改其中的jdbc的连接,在数据库中创建需要的表。
  • 报警邮件可以先不设置,部署完调度中心之后,可以针对具体的任务设置报警邮件。
  • 调度中心通讯token可以设置,设置的内容必须和执行器中的token一致。
  • 其他内容可以视情况填写。
  • port及congtext-path会在后面执行器的配置中用到,用来关联调度中心。

  
  1. server.port = 8080
  2. server.servlet.context-path = /wms-job-admin
  3. ### 调度中心JDBC链接:链接地址请保持和 2.1章节 所创建的调度数据库的地址一致
  4. spring.datasource.url =jdbc:mysql: / / 127.0.0.1: 3306 /xxl_job?useUnicode = true &characterEncoding =UTF- 8 &autoReconnect = true &serverTimezone =Asia /Shanghai
  5. spring.datasource.username =root
  6. spring.datasource.password =root_pwd
  7. spring.datasource.driver-class-name =com.mysql.jdbc.Driver
  8. ### 报警邮箱
  9. spring.mail.host =smtp.qq.com
  10. spring.mail.port = 25
  11. spring.mail.username =xxx@qq.com
  12. spring.mail.password =xxx
  13. spring.mail.properties.mail.smtp.auth = true
  14. spring.mail.properties.mail.smtp.starttls.enable = true
  15. spring.mail.properties.mail.smtp.starttls.required = true
  16. spring.mail.properties.mail.smtp.socketFactory. class =javax.net.ssl.SSLSocketFactory
  17. ### 调度中心通讯TOKEN [选填]:非空时启用;
  18. xxl.job.accessToken =
  19. ### 调度中心国际化配置 [必填]: 默认为 "zh_CN" /中文简体, 可选范围为 "zh_CN" /中文简体, "zh_TC" /中文繁体 and "en" /英文;
  20. xxl.job.i 18n =zh_CN
  21. ## 调度线程池最大线程配置【必填】
  22. xxl.job.triggerpool.fast.max = 200
  23. xxl.job.triggerpool.slow.max = 100
  24. ### 调度中心日志表数据保存天数 [必填]:过期日志自动清理;限制大于等于 7时生效,否则, 如- 1,关闭自动清理功能;
  25. xxl.job.logretentiondays = 30

如果已经正确进行上述配置,可将项目编译打包部署。

调度中心访问地址:http://localhost:8080/xxl-job-admin (该地址执行器将会使用到,作为回调地址)

默认登录账号 “admin/123456”, 登录后运行界面如下图所示。至此调度中心部署完成。

 调度中心支持集群。

在调度中心创建用于执行任务的执行器,执行器的appNamen会在执行器程序中使用到,执行器程序中配置的appName的名字就是在这边设置的,注册方式一般使用自动注册。

 注意


  
  1. AppName: 是每个执行器集群的唯一标示AppName, 执行器会周期性以AppName为对象进行自动注册。可通过该配置自动发现注册成功的执行器, 供任务调度时使用;
  2. 名称: 执行器的名称, 因为AppName限制字母数字等组成,可读性不强, 名称为了提高执行器的可读性;
  3. 排序: 执行器的排序, 系统中需要执行器的地方,如任务新增, 将会按照该排序读取可用的执行器列表;
  4. 注册方式:调度中心获取执行器地址的方式;
  5. 自动注册:执行器自动进行执行器注册,调度中心通过底层注册表可以动态发现执行器机器地址;
  6. 手动录入:人工手动录入执行器的地址信息,多地址逗号分隔,供调度中心使用;
  7. 机器地址: "注册方式""手动录入"时有效,支持人工维护执行器的地址信息;

(2)配置执行器

我们的springboot项目就是xxl job的执行器项目。

1.导入依赖


  
  1. <dependency >
  2. <groupId >com.xuxueli < /groupId >
  3. <artifactId >xxl-job-core < /artifactId >
  4. <version >${最新稳定版本} < /version >
  5. < /dependency >

2.执行器yml配置

在yml文件中进行xxl job的配置,注意点如下:

xxl.job.admin.addresses:就是调度中心的访问地址,内容由调度中心配置文件中的端口和上下文确定。

xxl.job.accessToken:必须和调度中心的token一致。

xxl.job.executor.appname:在调度中心的画面上的创建的执行器的名字,标明此任务在哪个执行器下执行。

执行器注册相关的信息可以按照下面的设定,进行执行器地址的自动获取。当然有时候执行器的地址必须手动设置,可以在配置文件中进行设置,也可以在调度中心的画面创建执行器时设置。


  
  1. ### 调度中心部署根地址 [选填]:如调度中心集群部署存在多个地址则用逗号分隔。执行器将会使用该地址进行 "执行器心跳注册""任务结果回调";为空则关闭自动注册;
  2. xxl.job.admin.addresses =http: / / 127.0.0.1: 8080 /xxl-job-admin
  3. ### 执行器通讯TOKEN [选填]:非空时启用;
  4. xxl.job.accessToken =
  5. ### 执行器AppName [选填]:执行器心跳注册分组依据;为空则关闭自动注册
  6. xxl.job.executor.appname =xxl-job-executor-sample
  7. ### 执行器注册 [选填]:优先使用该配置作为注册地址,为空时使用内嵌服务 ”IP:PORT“ 作为注册地址。从而更灵活的支持容器类型执行器动态IP和动态映射端口问题。
  8. xxl.job.executor. address =
  9. ### 执行器IP [选填]:默认为空表示自动获取IP,多网卡时可手动设置指定IP,该IP不会绑定Host仅作为通讯实用;地址信息用于 "执行器注册""调度中心请求并触发任务"
  10. xxl.job.executor.ip =
  11. ### 执行器端口号 [选填]:小于等于 0则自动获取;默认端口为 9999,单机部署多个执行器时,注意要配置不同执行器端口;
  12. xxl.job.executor.port = 9999
  13. ### 执行器运行日志文件存储磁盘路径 [选填] :需要对该路径拥有读写权限;为空则使用默认路径;
  14. xxl.job.executor.logpath = / data /applogs /xxl-job /jobhandler
  15. ### 执行器日志文件保存天数 [选填] : 过期日志自动清理, 限制值大于等于 3时生效; 否则, 如- 1, 关闭自动清理功能;
  16. xxl.job.executor.logretentiondays = 30

3.执行器组件配置

根据配置文件中的内容,创建执行器的配置bean,交由spring容器管理。


  
  1. @Bean
  2. public XxlJobSpringExecutor xxlJobExecutor() {
  3. logger.info( ">>>>>>>>>>> xxl-job config init.");
  4. XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
  5. xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
  6. xxlJobSpringExecutor.setAppname(appname);
  7. xxlJobSpringExecutor.setIp(ip);
  8. xxlJobSpringExecutor.setPort(port);
  9. xxlJobSpringExecutor.setAccessToken(accessToken);
  10. xxlJobSpringExecutor.setLogPath(logPath);
  11. xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
  12. return xxlJobSpringExecutor;
  13. }

执行器也可以部署集群。 

4.创建定时任务(以BEAN模式(方法形式)举例)

这里只介绍bean模式的方法模式,其他的可以参照官网。

(1).开发job方法


  
  1. 1、任务开发:在Spring Bean实例中,开发Job方法;
  2. 2、注解配置:为Job方法添加注解 "@XxlJob(value="自定义jobhandler名称 ", init = "JobHandler初始化方法 ", destroy = "JobHandler销毁方法 ")",注解 value值对应的是调度中心新建任务的JobHandler属性的值。
  3. 3、执行日志:需要通过 "XxlJobHelper.log" 打印执行日志;
  4. 4、任务结果:默认任务结果为 "成功" 状态,不需要主动设置;如有诉求,比如设置任务结果为失败,可以通过 "XxlJobHelper.handleFail/handleSuccess" 自主设置任务结果;

示例:


  
  1. @XxlJob("demoJobHandler")
  2. public void demoJobHandler () throws Exception {
  3. XxlJobHelper.log( "XXL-JOB, Hello World.");
  4. }

(2)调度中心新建任务

运行模式选中 “BEAN模式”,JobHandler属性填写任务注解“@XxlJob”中定义的值。执行器选择你配置的执行器。可以动态的进行任务的删除和修改,并且实时生效。

(3).执行

调用中心和执行器程序都启动起来之后,可以在任务画面进行任务的执行,可以通过调度日志查看任务的执行状况。


转载:https://blog.csdn.net/m0_72167535/article/details/128856786
查看评论
* 以上用户言论只代表其个人观点,不代表本网站的观点或立场