定时器 也叫任务调度器 Spring的定时任务 xxl-job分布式任务调度_xxl定时器

一、都有哪些定时器

JDK自带的Timer、ScheduledThreadPoolExecutor 
Spring提供的Scheduled
Quarts
xxl-job：分布式
1
2
3
4

二、JDK提供的定时线程池

定时线程池;ScheduledThreadPoolExecutor schedule = new ScheduledThreadPoolExecutor(1);
public static void main(String[] args) {
    ScheduledThreadPoolExecutor schedule = new ScheduledThreadPoolExecutor(1);

    //延时Runnable任务（只执行一次）
    schedule.schedule(new Runnable() {
        @Override
        public void run() {
            System.out.println("任务只执行一次");
        }
    }, 3, TimeUnit.SECONDS);


    //固定延时间隔执行任务
    schedule.scheduleWithFixedDelay(new Runnable() {
        @Override
        public void run() {
            System.out.println("固定延时间隔");
        }
    }, 1, 1, TimeUnit.SECONDS);


    //固定时间间隔执行任务
    schedule.scheduleAtFixedRate(new Runnable() {
        @Override
        public void run() {
            System.out.println("固定时间间隔");
        }
    }, 1, 1, TimeUnit.SECONDS);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

三、Spring提供的定时任务

一、概述
Cron表达式是一个字符串，字符串以5或6个空格隔开,中间均由空格隔开，分为6或7个域，每一个域代表一个含义，Cron有如下两种语法格式： 
	1.Seconds Minutes Hours DayofMonth Month DayofWeek Year  秒 分 小时 几号 几月 周几 年
	2.Seconds Minutes Hours DayofMonth Month DayofWeek       秒 分 小时 几号 几月 周几

二、符号详细说明
	*   表示匹配该域的任意值，假如在Minutes域使用*, 即表示每分钟都会触发事件
	*/n 表示每隔n久执行一次
	?   只能用在DayofMonth和DayofWeek两个域。它也匹配域的任意值，但实际不会。因为DayofMonth和 DayofWeek会相互影响。例如想在每月的20日
	    触发调度，不管20日到底是星期几，则只能使用如下写法： 13 13 15 20 * ?, 其中最后一位只能用？，而不能使用*，如果使用*表示不管星期
	    几都会触发，实际上并不是这样。 
	 -  表示范围，例如在Minutes域使用5-20，表示从5分到20分钟每分钟触发一次
	 ,  表示列出枚举值值。例如：在Minutes域使用5,20，则意味着在5和20分每分钟触发一次 
	 L  表示最后，只能出现在DayofWeek和DayofMonth域，如果在DayofWeek域使用5L,意味着在最后的一个星期四触发。
	 W  表示有效工作日(周一到周五),只能出现在DayofMonth域，系统将在离指定日期的最近的有效工作日触发事件。例如：在 DayofMonth使用5W，如果5日是星期六，则将在最近的工作日：星期五，即4日触发。如果5日是星期天，则在6日(周一)触发；如果5日在星期一 到星期五中的一天，则就在5日触发。另外一点，W的最近寻找不会跨过月份。
	 LW  这两个字符可以连用，表示在某个月最后一个工作日，即最后一个星期五。 
	 # 用于确定每个月第几个星期几，只能出现在DayofMonth域。例如在4#2，表示某月的第二个星期三。 


三、举几个例子: 
如果不知道怎么写，可以打开http://localhost:8080/xxl-job-admin/jobinfo新建任务
	每三个月执行一次："0 0 0 1 */3 ?"
	每隔5秒执行一次："*/5 * * * * ?"
	每隔1分钟执行一次："0 */1 * * * ?"
	每天23点执行一次："0 0 23 * * ?"
	每天凌晨1点执行一次："0 0 1 * * ?"
	每月1号凌晨1点执行一次："0 0 1 1 * ?"
	每月最后一天23点执行一次："0 0 23 L * ?"
	每周星期天凌晨1点实行一次："0 0 1 ? * L"
	在26分、29分、33分执行一次："0 26,29,33 * * * ?"
	每天的0点、13点、18点、21点都执行一次："0 0 0,13,18,21 * * ?"
	表示在每月的1日的凌晨2点调度任务："0 0 2 1 * ? *"
	表示周一到周五每天上午10：15执行作业："0 15 10 ? * MON-FRI" 
	表示2002-2006年的每个月的最后一个星期五上午10:15执行："0 15 10 ? 6L 2002-2006"

四、案例	
    SpringBoot启动类要加上注解@EnableScheduling或者定时类上加注解@EnableScheduling
    
	@Component
	@EnableScheduling
	public class PromotionSchedule {
	
	    @Scheduled(cron = "0 0 0 * * ?")
	    @Transactional(rollbackFor = Exception.class)
	    public void movePriceExecOrgList() {
	        System.out.println("进入定时器");
	    }
	}

	@Component
	@EnableScheduling
	public class PromotionSchedule {
	    private final PromotionService promotionService;
	    private final PromotionPushUserRepository promotionPushUserRepository;
	
	    public PromotionSchedule(PromotionService promotionService, PromotionPushUserRepository promotionPushUserRepository) {
	        this.promotionService = promotionService;
	        this.promotionPushUserRepository = promotionPushUserRepository;
	    }
	
	    @Scheduled(cron = "0 0 0 * * ?")
	    @Transactional(rollbackFor = Exception.class)
	    public void movePriceExecOrgList() {
	        System.out.println("进入推送定时器");
	        //搜索价格设置记录：定时推送并且推送时间是当前时间  并且推送状态是待推送
	        List<String> promotionSettingIdList = promotionPushUserRepository.promotionPushUserScheduleList();
	        if (!CollectionUtils.isEmpty(promotionSettingIdList)) {
	            for (String promotionSettingId : promotionSettingIdList) {
	                promotionService.promotionPush(promotionSettingId, "system");
	            }
	        }
	    }
	}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73

四、xxl-job分布式任务调度平台

xxl官网
xxl分布式任务调度平台文档
源码仓库(码云)

1、为什么需要分布式任务调度器：

假设一个库存微服务集群部署了三个节点，如果采用JDK或者Spring的定时器，
那么就会在三台服务器各执行一次，总共执行了三次，但我们只要执行一次
1
2

2、源码目录说明

xxl-job-admin：调度中心，理解为服务端（作用：统一管理任务调度平台上调度任务，负责触发调度执行，并且提供任务管理平台。）
xxl-job-core：公共依赖
xxl-job-executor-samples：执行器Sample示例（选择合适的版本执行器，可直接使用，也可以参考其并将现有项目改造成执行器）
   ：xxl-job-executor-sample-springboot：Springboot版本，通过Springboot管理执行器，推荐这种方式；
   ：xxl-job-executor-sample-frameless：无框架版本；
1
2
3
4
5

3、配置部署"调度中心"，理解为服务端

1、创建数据库，执行项目下/doc/db/tables_xxl_job.sql

2、更改admin配置文件数据库信息和邮件信息
    ### 调度中心JDBC链接：链接地址保持和上面所创建的调度数据库的地址一致
	spring.datasource.url=jdbc:mysql://127.0.0.1:3306/xxl_job?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true&serverTimezone=Asia/Shanghai
	spring.datasource.username=root
	spring.datasource.password=root_pwd
	spring.datasource.driver-class-name=com.mysql.jdbc.Driver
	### 报警邮箱
	spring.mail.host=smtp.qq.com
	spring.mail.port=25
	spring.mail.username=xxx@qq.com
	spring.mail.password=xxx
	spring.mail.properties.mail.smtp.auth=true
	spring.mail.properties.mail.smtp.starttls.enable=true
	spring.mail.properties.mail.smtp.starttls.required=true
	spring.mail.properties.mail.smtp.socketFactory.class=javax.net.ssl.SSLSocketFactory
	### 调度中心通讯TOKEN [选填]：非空时启用；
	xxl.job.accessToken=
	### 调度中心国际化配置 [必填]： 默认为 "zh_CN"/中文简体, 可选范围为 "zh_CN"/中文简体, "zh_TC"/中文繁体 and "en"/英文；
	xxl.job.i18n=zh_CN
	## 调度线程池最大线程配置【必填】
	xxl.job.triggerpool.fast.max=200
	xxl.job.triggerpool.slow.max=100
	### 调度中心日志表数据保存天数 [必填]：过期日志自动清理；限制大于等于7时生效，否则, 如-1，关闭自动清理功能；
	xxl.job.logretentiondays=30

3、启动admin文件下的Application服务就可访问调度中心页面
     路径：http://localhost:8080/xxl-job-admin
     账号密码为：admin/123456
    
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

4、客户端配置(可在自己的业务项目中配置)

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

3、XxlJobConfig.java
    package com.xxl.job.executor.core.config;

	import com.xxl.job.core.executor.impl.XxlJobSpringExecutor;
	import org.slf4j.Logger;
	import org.slf4j.LoggerFactory;
	import org.springframework.beans.factory.annotation.Value;
	import org.springframework.context.annotation.Bean;
	import org.springframework.context.annotation.Configuration;
	
	@Configuration
	public class XxlJobConfig {
	    private Logger logger = LoggerFactory.getLogger(XxlJobConfig.class);
	
	    @Value("${xxl.job.admin.addresses}")
	    private String adminAddresses;
	
	    @Value("${xxl.job.accessToken}")
	    private String accessToken;
	
	    @Value("${xxl.job.executor.appname}")
	    private String appname;
	
	    @Value("${xxl.job.executor.address}")
	    private String address;
	
	    @Value("${xxl.job.executor.ip}")
	    private String ip;
	
	    @Value("${xxl.job.executor.port}")
	    private int port;
	
	    @Value("${xxl.job.executor.logpath}")
	    private String logPath;
	
	    @Value("${xxl.job.executor.logretentiondays}")
	    private int logRetentionDays;
	
	
	    @Bean
	    public XxlJobSpringExecutor xxlJobExecutor() {
	        logger.info(">>>>>>>>>>> xxl-job config init.");
	        XxlJobSpringExecutor xxlJobSpringExecutor = new XxlJobSpringExecutor();
	        xxlJobSpringExecutor.setAdminAddresses(adminAddresses);
	        xxlJobSpringExecutor.setAppname(appname);
	        xxlJobSpringExecutor.setAddress(address);
	        xxlJobSpringExecutor.setIp(ip);
	        xxlJobSpringExecutor.setPort(port);
	        xxlJobSpringExecutor.setAccessToken(accessToken);
	        xxlJobSpringExecutor.setLogPath(logPath);
	        xxlJobSpringExecutor.setLogRetentionDays(logRetentionDays);
	
	        return xxlJobSpringExecutor;
	    }
	}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

5、客户端使用

1、在业务系统中新建XxlJob类(类可以有多个方法，每个方法为一个定时器)
		package com.autel.cloud.app.ocpi.job;	
		import com.xxl.job.core.biz.model.ReturnT;
		import com.xxl.job.core.handler.annotation.XxlJob;
		import com.xxl.job.core.log.XxlJobLogger;
		import lombok.extern.slf4j.Slf4j;
		import org.springframework.cloud.context.config.annotation.RefreshScope;
		import org.springframework.stereotype.Component;
		import org.springframework.web.bind.annotation.RequestBody;
		
		@Slf4j
		@RefreshScope
		@Component
		public class PullDataJob {
			
			 //也可使用默认的demoJobHandler/shardingJobHandler/commandJobHandler/httpJobHandler
		    @XxlJob(value = "Job2Handler")  //任务中心新建的任务的JobHandler，
		    public ReturnT<String> pullData(@RequestBody String param) {
		        log.info("开始拉取数据任务执行了");
		        XxlJobLogger.log("开始拉取数据任务执行了"); //XxlJobHelper.log("XXL-JOB, Hello World.");
		        return ReturnT.SUCCESS;
		    }
		
		    @XxlJob(value = "Job3Handler")  //任务中心新建的任务的JobHandler
		    public ReturnT<String> job3(@RequestBody String param) {
		        log.info("Job3Handler执行了");
		        XxlJobLogger.log("Job3Handler");
		        return ReturnT.SUCCESS;
		    }
		
		}


 2、登录admin页面，在任务管理创建JobHandler名称的任务，填写内容见下面截图(使用默认JobHandler可以省略这一步骤)
     路径：http://localhost:8080/xxl-job-admin
     账号密码为：admin/123456
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36