• 使用Timer

  • 使用ScheduledExecutorService

  • 使用Spring Task

  • 整合Quartz

定时任务实现的几种方式:

  • Timer:这是java自带的java.util.Timer类,这个类允许你调度一个java.util.TimerTask任务。使用这种方式可以让你的程序按照某一个频度执行,但不能在指定时间运行。一般用的较少。

  • ScheduledExecutorService:也jdk自带的一个类;是基于线程池设计的定时任务类,每个调度任务都会分配到线程池中的一个线程去执行,也就是说,任务是并发执行,互不影响。

  • Spring Task:Spring3.0以后自带的task,可以将它看成一个轻量级的Quartz,而且使用起来比Quartz简单许多。

  • Quartz:这是一个功能比较强大的的调度器,可以让你的程序在指定时间执行,也可以按照某一个频度执行,配置起来稍显复杂。

使用Timer

这个目前在项目中用的较少,直接贴demo代码。具体的介绍可以查看api

public class TestTimer {
    		public static void main(String[] args) {
        			TimerTask timerTask = new TimerTask() {
            				@Override
           			 	public void run() {
                				System.out.println("task  run:"+ new Date());
           				 }
       			 };
        		Timer timer = new Timer();
       		 //安排指定的任务在指定的时间开始进行重复的固定延迟执行。这里是每3秒执行一次
        		timer.schedule(timerTask,10,3000);
  	          }
	}

使用ScheduledExecutorService

​ 该方法跟Timer类似,直接看demo:

public class TestScheduledExecutorService {
    		public static void main(String[] args) {
        			ScheduledExecutorService service = Executors.newSingleThreadScheduledExecutor();
        			// 参数:1、任务体 2、首次执行的延时时间
      			  //      3、任务执行间隔 4、间隔时间单位
       			 service.scheduleAtFixedRate(()->System.out.println("task ScheduledExecutorService "+new Date()), 0, 3, 						TimeUnit.SECONDS);
   		 }
	}

使用Spring Task

​ 简单的定时任务,在SpringBoot项目中,我们可以很优雅的使用注解来实现定时任务,首先创建项目,导入依赖:

<dependencies>
  		<dependency>
    			<groupId>org.springframework.boot</groupId>
   			 <artifactId>spring-boot-starter-web</artifactId>
  		</dependency>
  		<dependency>
   			 <groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter</artifactId>
  		</dependency>
 		 <dependency>
    			<groupId>org.projectlombok</groupId>
    			<artifactId>lombok</artifactId>
   			 <optional>true</optional>
 		 </dependency>
 		<dependency>
    			<groupId>org.springframework.boot</groupId>
    			<artifactId>spring-boot-starter-test</artifactId>
    			<scope>test</scope>
  		</dependency>
	</dependencies>

​ 创建任务类:

			@Slf4j
			@Component
			public class ScheduledService {
    				@Scheduled(cron = "0/5 * * * * *")
    				public void scheduled(){
        					log.info("=====>>>>>使用cron  {}",System.currentTimeMillis());
   					 }
    				@Scheduled(fixedRate = 5000)
    				public void scheduled1() {
        					log.info("=====>>>>>使用fixedRate{}", System.currentTimeMillis());
    				}
    				@Scheduled(fixedDelay = 5000)
   				 public void scheduled2() {
        					log.info("=====>>>>>fixedDelay{}",System.currentTimeMillis());
    				}
			}

​ 在主类上使用@EnableScheduling注解开启对定时任务的支持,然后启动项目

​ 可以看到三个定时任务都已经执行,并且使同一个线程中串行执行,如果只有一个定时任务,这样做肯定没问题,当定时任务增多,如果一个任务卡死,会导致其他任务也无法执行。

多线程执行

​ 在传统的Spring项目中,我们可以在xml配置文件添加task的配置,而在SpringBoot项目中一般使用config配置类的方式添加配置,所以新建一个AsyncConfig类

	@Configuration
	@EnableAsync
	public class AsyncConfig {
    		 /*
   		 此处成员变量应该使用@Value从配置中读取
     		*/	
    		private int corePoolSize = 10;
    		private int maxPoolSize = 200;
    		private int queueCapacity = 10;
    		@Bean
    		public Executor taskExecutor() {
        		     ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
       		     executor.setCorePoolSize(corePoolSize);
        		     executor.setMaxPoolSize(maxPoolSize);
       		     executor.setQueueCapacity(queueCapacity);
        		     executor.initialize();
        		     return executor;
    		}
	}

@Configuration:表明该类是一个配置类 @EnableAsync:开启异步事件的支持

然后在定时任务的类或者方法上添加@Async 。最后重启项目,每一个任务都是在不同的线程中

执行时间的配置

​ 在上面的定时任务中,我们在方法上使用@Scheduled注解来设置任务的执行时间,并且使用三种属性配置方式:

  • fixedRate:定义一个按一定频率执行的定时任务

  • fixedDelay:定义一个按一定频率执行的定时任务,与上面不同的是,改属性可以配合initialDelay, 定义该任务延迟执行时间。

  • cron:通过表达式来配置任务执行时间

    一个cron表达式有至少6个(也可能7个)有空格分隔的时间元素。按顺序依次为:

    ​ 1 秒(0~59)
    ​ 2 分钟(0~59)
    ​ 3 小时(0~23)
    ​ 4 天(0~31)
    ​ 5 月(0~11)
    ​ 6 星期(1~7 1=SUN 或 SUN,MON,TUE,WED,THU,FRI,SAT)
    ​ 7 年份(1970-2099)

    其中每个元素可以是一个值(如6),一个连续区间(9-12),一个间隔时间(8-18/4)(/表示每隔4小时),一个列表(1,3,5),通配符。由于”月份中的日期”和”星期中的日期”这两个元素互斥的,必须要对其中一个设置。配置实例:

    每隔5秒执行一次:/5 * ?
    每隔1分钟执行一次:0 /1 ?
    0 0 10,14,16 ? 每天上午10点,下午2点,4点
    0 0/30 9-17 ? 朝九晚五工作时间内每半小时
    0 0 12 ? * WED 表示每个星期三中午12点
    “0 0 12 ?” 每天中午12点触发
    “0 15 10 ? “ 每天上午10:15触发
    “0 15 10 ?” 每天上午10:15触发
    “0 15 10 ? *” 每天上午10:15触发
    “0 15 10 ? 2005” 2005年的每天上午10:15触发
    “0 14 * ?” 在每天下午2点到下午2:59期间的每1分钟触发
    “0 0/5 14 ?” 在每天下午2点到下午2:55期间的每5分钟触发
    “0 0/5 14,18 ?” 在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发
    “0 0-5 14 ?” 在每天下午2点到下午2:05期间的每1分钟触发
    “0 10,44 14 ? 3 WED” 每年三月的星期三的下午2:10和2:44触发
    “0 15 10 ? * MON-FRI” 周一至周五的上午10:15触发
    “0 15 10 15 * ?” 每月15日上午10:15触发
    “0 15 10 L * ?” 每月最后一日的上午10:15触发
    “0 15 10 ? * 6L” 每月的最后一个星期五上午10:15触发
    “0 15 10 ? * 6L 2002-2005” 2002年至2005年的每月的最后一个星期五上午10:15触发
    “0 15 10 ? * 6#3” 每月的第三个星期五上午10:15触发

    整合Quartz

    • 添加依赖

      如果SpringBoot版本是2.0.0以后的,则在spring-boot-starter中已经包含了quart的依赖,则可以直接使用spring-boot-starter-quartz依赖:

      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-quartz</artifactId>
      </dependency>
      

      如果是1.5.9则要使用以下添加依赖:

      <dependency>
        <groupId>org.quartz-scheduler</groupId>
        <artifactId>quartz</artifactId>
        <version>2.3.0</version>
      </dependency>
      <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context-support</artifactId>
      </dependency>
      

      这里我使用SpringBoot版本是2.0.0.BUILD-SNAPSHOT ,该版本开始集成了Quartz,所以事实现起来很方便。其它好像比较麻烦,这里就不介绍,以后有时间再详细深入了解Quartz。

    • 创建配置类QuartzConfig

      @Configuration
      public class QuartzConfig {
          @Bean
          public JobDetail teatQuartzDetail(){
              return JobBuilder.newJob(TestQuartz.class).withIdentity("testQuartz").storeDurably().build();
          }
       
          @Bean
          public Trigger testQuartzTrigger(){
              SimpleScheduleBuilder scheduleBuilder = SimpleScheduleBuilder.simpleSchedule()
                      .withIntervalInSeconds(10)  //设置时间周期单位秒
                      .repeatForever();
              return TriggerBuilder.newTrigger().forJob(teatQuartzDetail())
                      .withIdentity("testQuartz")
                      .withSchedule(scheduleBuilder)
                      .build();
          }
      

spring boot+redis 监听过期Key的操作方法

在订单业务中,有时候需要对订单设置有效期,有效期到了后如果还未支付,就需要修改订单状态。对于这种业务的实现,有多种不同的办法,比如:

  • 使用querytz,每次生成一个订单,就创建一个定时任务,到期后执行业务代码;

  • rabbitMq中的延迟队列;

  • 对Redis的Key进行监控;

    1、引入依赖

org.springframework.boot spring-boot-starter-data-redis ```

2、修改boot的redis配置

spring:
   #redis
   redis:
   database: 0
   host: 127.0.0.1
   password: redis_123456
   port: 6379

​ 3、在服务器中 修改redis.conf配置文件(原来notify-keyspace-events 属性是" " 空的,我们只需要填上“Ex”就行了)

	notify-keyspace-events "Ex"

​ 4、创建一个Redis监控类,用于监控过期的key,该类需继承KeyExpirationEventMessageListener

    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.data.redis.connection.Message;
    import org.springframework.data.redis.listener.KeyExpirationEventMessageListener;
    import org.springframework.data.redis.listener.RedisMessageListenerContainer;

    import java.nio.charset.StandardCharsets;

    /**
     * @program: SpringCloud
     * @description: redis Key过期监听
     * @author: lch
     * @create: 2020-03-24 14:14
     */
    public class KeyExpiredListener extends KeyExpirationEventMessageListener {

     public KeyExpiredListener(RedisMessageListenerContainer listenerContainer) {
      super(listenerContainer);
     }

     @Override
     public void onMessage(Message message, byte[] pattern) {
      //System.out.println("过期key:" + message.toString());
         
          // 建议使用: valueSerializer
        byte[] body = message.getBody();
        byte[] channel = message.getChannel();
        //Redis数据的键
        String redisId = new String(body);
        System.out.println("redis的键"+redisId);
        System.out.println("onMessage >> " );
        System.out.println(String.format("channel: %s \n body: %s \n bytes: %s"
                ,new String(channel), new String(body), new String(bytes)));
     }
    }

​ 5、创建Redis配置类

    import com.zy.rabbitmq.base.Listener.KeyExpiredListener;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.context.annotation.Bean;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.data.redis.connection.RedisConnectionFactory;
    import org.springframework.data.redis.listener.RedisMessageListenerContainer;

    /**
     * @program: SpringCloud
     * @description: redis配置类
     * @author: lch
     * @create: 2020-03-24 14:17
     */
    @Configuration
    public class RedisConfiguration {

     @Autowired
     private RedisConnectionFactory redisConnectionFactory;

     @Bean
     public RedisMessageListenerContainer redisMessageListenerContainer() {
      RedisMessageListenerContainer redisMessageListenerContainer = new RedisMessageListenerContainer();
      redisMessageListenerContainer.setConnectionFactory(redisConnectionFactory);
      return redisMessageListenerContainer;
     }

     @Bean
     public KeyExpiredListener keyExpiredListener() {
      return new KeyExpiredListener(this.redisMessageListenerContainer());
     }
    }

​ 6、这里提供一个redis工具类,用于存储值,获取值,获取过期时间等操作。

import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;
import org.springframework.util.CollectionUtils;
  
import javax.annotation.Resource;
import java.util.concurrent.TimeUnit;
/**
 * redis 工具类
 * @Author lch
 */
@Component
public class RedisUtil {
  
    @Resource
    private RedisTemplate<String, Object> redisTemplate;
  
    /**
     * 指定缓存失效时间
     * 
     * @param key 键
     * @param time 时间(秒)
     * @return
     */
    public boolean expire(String key, long time) {
        try {
            if (time > 0) {
                redisTemplate.expire(key, time, TimeUnit.SECONDS);
            }
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }
  
    /**
     * 根据key 获取过期时间
     * 
     * @param key 键 不能为null
     * @return 时间(秒) 返回0代表为永久有效
     */
    public long getExpire(String key) {
        return redisTemplate.getExpire(key, TimeUnit.SECONDS);
    }
  
    /**
     * 判断key是否存在
     * 
     * @param key 键
     * @return true 存在 false不存在
     */
    public boolean hasKey(String key) {
        try {
            return redisTemplate.hasKey(key);
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }
  
    /**
     * 删除缓存
     * 
     * @param key 可以传一个值 或多个
     */
    @SuppressWarnings("unchecked")
    public void del(String... key) {
        if (key != null && key.length > 0) {
            if (key.length == 1) {
                redisTemplate.delete(key[0]);
            } else {
                redisTemplate.delete(CollectionUtils.arrayToList(key));
            }
        }
    }
  
    // ============================String=============================
    /**
     * 普通缓存获取
     * 
     * @param key 键
     * @return 值
     */
    public Object get(String key) {
        return key == null ? null : redisTemplate.opsForValue().get(key);
    }
  
    /**
     * 普通缓存放入
     * 
     * @param key 键
     * @param value 值
     * @return true成功 false失败
     */
    public boolean set(String key, Object value) {
        try {
            redisTemplate.opsForValue().set(key, value);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
  
    }
  
    /**
     * 普通缓存放入并设置时间
     * 
     * @param key 键
     * @param value 值
     * @param time 时间(秒) time要大于0 如果time小于等于0 将设置无限期
     * @return true成功 false 失败
     */
    public boolean set(String key, Object value, long time) {
        try {
            if (time > 0) {
                redisTemplate.opsForValue().set(key, value, time, TimeUnit.SECONDS);
            } else {
                set(key, value);
            }
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }
}

​ 7、测试。(这里开放两个接口,一个set值,并设置过期时间为10秒,一个获取值和过期时间,当到达过期时间,看是否回去到过期Key)

Logo

为开发者提供学习成长、分享交流、生态实践、资源工具等服务,帮助开发者快速成长。

更多推荐