1. 定时任务组件Quartz

1.1 Quartz介绍

Quartz既可以单独使用也可以跟spring框架整合使用,在实际开发中一般会使用后者。使用Quartz可以开发一个或者多个定时任务,每个定时任务可以单独指定执行的时间,例如每隔1小时执行一次、每个月第一天上午10点执行一次、每个月最后一天下午5点执行一次等。

官网:http://www.quartz-scheduler.org/

maven坐标:

  1. <dependency>
  2. <groupId>org.quartz-scheduler</groupId>
  3. <artifactId>quartz</artifactId>
  4. <version>2.2.1</version>
  5. </dependency>
  6. <dependency>
  7. <groupId>org.quartz-scheduler</groupId>
  8. <artifactId>quartz-jobs</artifactId>
  9. <version>2.2.1</version>
  10. </dependency>

1.2 Quartz入门案例

本案例基于Quartz和spring整合的方式使用。具体步骤:

(1)创建maven工程quartzdemo,导入Quartz和spring相关坐标,pom.xml文件如下

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5. <modelVersion>4.0.0</modelVersion>
  6. <groupId>com.itheima</groupId>
  7. <artifactId>quartdemo</artifactId>
  8. <version>1.0-SNAPSHOT</version>
  9. <dependencies>
  10. <dependency>
  11. <groupId>org.springframework</groupId>
  12. <artifactId>spring-context-support</artifactId>
  13. <version>5.0.2.RELEASE</version>
  14. </dependency>
  15. <dependency>
  16. <groupId>org.springframework</groupId>
  17. <artifactId>spring-tx</artifactId>
  18. <version>5.0.2.RELEASE</version>
  19. </dependency>
  20. <dependency>
  21. <groupId>org.quartz-scheduler</groupId>
  22. <artifactId>quartz</artifactId>
  23. <version>2.2.1</version>
  24. </dependency>
  25. <dependency>
  26. <groupId>org.quartz-scheduler</groupId>
  27. <artifactId>quartz-jobs</artifactId>
  28. <version>2.2.1</version>
  29. </dependency>
  30. </dependencies>
  31. </project>

(2)自定义一个Job

  1. package com.itheima.jobs;
  2. /**
  3. * 自定义Job
  4. */
  5. public class JobDemo {
  6. public void run(){
  7. System.out.println("job execute...");
  8. }
  9. }

(3)提供Spring配置文件spring-jobs.xml,配置自定义Job、任务描述、触发器、调度工厂等

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <beans xmlns="http://www.springframework.org/schema/beans"
  3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4. xmlns:context="http://www.springframework.org/schema/context"
  5. xmlns:dubbo="http://code.alibabatech.com/schema/dubbo"
  6. xmlns:mvc="http://www.springframework.org/schema/mvc"
  7. xsi:schemaLocation="http://www.springframework.org/schema/beans
  8. http://www.springframework.org/schema/beans/spring-beans.xsd
  9. http://www.springframework.org/schema/mvc
  10. http://www.springframework.org/schema/mvc/spring-mvc.xsd
  11. http://code.alibabatech.com/schema/dubbo
  12. http://code.alibabatech.com/schema/dubbo/dubbo.xsd
  13. http://www.springframework.org/schema/context
  14. http://www.springframework.org/schema/context/spring-context.xsd">
  15. <!-- 注册自定义Job -->
  16. <bean id="jobDemo" class="com.itheima.jobs.JobDemo"></bean>
  17. <!-- 注册JobDetail,作用是负责通过反射调用指定的Job -->
  18. <bean id="jobDetail"
  19. class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
  20. <!-- 注入目标对象 -->
  21. <property name="targetObject" ref="jobDemo"/>
  22. <!-- 注入目标方法 -->
  23. <property name="targetMethod" value="run"/>
  24. </bean>
  25. <!-- 注册一个触发器,指定任务触发的时间 -->
  26. <bean id="myTrigger" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
  27. <!-- 注入JobDetail -->
  28. <property name="jobDetail" ref="jobDetail"/>
  29. <!-- 指定触发的时间,基于Cron表达式 -->
  30. <property name="cronExpression">
  31. <value>0/10 * * * * ?</value>
  32. </property>
  33. </bean>
  34. <!-- 注册一个统一的调度工厂,通过这个调度工厂调度任务 -->
  35. <bean id="scheduler" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
  36. <!-- 注入多个触发器 -->
  37. <property name="triggers">
  38. <list>
  39. <ref bean="myTrigger"/>
  40. <!-- <ref bean="myTrigger"/> -->
  41. </list>
  42. </property>
  43. </bean>
  44. </beans>

(4)编写main方法进行测试

  1. package com.itheima.jobs.com.itheima.app;
  2. import org.springframework.context.support.ClassPathXmlApplicationContext;
  3. public class App {
  4. public static void main(String[] args) {
  5. new ClassPathXmlApplicationContext("spring-jobs.xml");
  6. }
  7. }

执行上面main方法观察控制台,可以发现每隔10秒会输出一次,说明每隔10秒自定义Job被调用一次。

1.3 cron表达式

上面的入门案例中我们指定了一个表达式:0/10 ?

这种表达式称为cron表达式,通过cron表达式可以灵活的定义出符合要求的程序执行的时间。本小节我们就来学习一下cron表达式的使用方法。如下图:

  1. 0 0 10,14,16 _ _ ?
  2. 0 0-5 14 _ _
  3. 0 0/5 14 _ _
  4. 每天下午2 --> 255 这中间每5分钟执行一次

6.png

cron表达式分为七个域,之间使用空格分隔。其中最后一个域(年)可以为空。每个域都有自己允许的值和一些特殊字符构成。使用这些特殊字符可以使我们定义的表达式更加灵活。

下面是对这些特殊字符的介绍:

逗号(,):指定一个值列表,例如使用在月域上1,4,5,7表示1月、4月、5月和7月(也就是或者的关系)

横杠(-):指定一个范围,例如在时域上3-6表示3点到6点(即3点、4点、5点、6点)

星号(*):表示这个域上包含所有合法的值。例如,在月份域上使用星号意味着每个月都会触发

斜线(/):表示递增,例如使用在秒域上0/15表示每15秒

问号(?):能用在日和周域上,但是不能在这两个域上同时使用。表示不指定,也就是不关心?处的值

井号(#):只能使用在周域上,用于指定月份中的第几周的哪一天,例如6#3,意思是某月的第三个周五 (6=星期五,3意味着月份中的第三周)

L:某域上允许的最后一个值。只能使用在日和周域上。当用在日域上,表示的是在月域上指定的月份的最后一天。用于周域上时,表示周的最后一天,就是星期六

W:W 字符代表着工作日 (星期一到星期五),只能用在日域上,它用来指定离指定日的最近的一个工作日

1.4 cron表达式在线生成器

前面介绍了cron表达式,但是自己编写表达式还是有一些困难的,我们可以借助一些cron表达式在线生成器来根据我们的需求生成表达式即可。

http://cron.qqe2.com/

7.png
实际应用场景:定时清理垃圾图片
创建maven工程health_jobs,打包方式为war,导入Quartz等相关坐标
image.png

  1. package com.itheima.jobs;
  2. import com.itheima.constant.RedisConstant;
  3. import com.itheima.util.QiniuUtils;
  4. import org.springframework.beans.factory.annotation.Autowired;
  5. import redis.clients.jedis.JedisPool;
  6. import java.util.Set;
  7. /**
  8. * @author heqiaosheng
  9. * @version 1.0
  10. * @date 2021/2/10 17:20
  11. */
  12. public class ClearImgJob {
  13. @Autowired
  14. private JedisPool jedisPool;
  15. public void clearImg(){
  16. //根据Redis中保存的两个set集合进行差值计算,获得垃圾图片名称集合
  17. Set<String> sdiff = jedisPool.getResource().sdiff(RedisConstant.SETMEAL_PIC_RESOURCES, RedisConstant.SETMEAL_PIC_DB_RESOURCES);
  18. if (sdiff!=null){
  19. for (String img : sdiff) {
  20. //删除七牛云服务器上的图片
  21. QiniuUtils.deleteFileFromQiniu(img);
  22. //从Redis集合中删除图片名称
  23. jedisPool.getResource().srem(RedisConstant.SETMEAL_PIC_RESOURCES,img);
  24. }
  25. }
  26. }
  27. }