1、引入的依赖
因为@EnableScheduling是spring的注解,所以引入spring的依赖即可
2、启动类配置
添加@EnableScheduling注解
3、创建定时任务类
在需要执行定时任务的方法加上@Scheduled注解,里面写cron表达式
表示每天12,23点执行一次
4、cron表达式格式
{秒数} {分钟} {小时} {日期} {月份} {星期} {年份(可为空)}
* 字符代表所有可能的值。 * 在 {月份} 里表示每个月的含义。
/ 字符用来指定数值的增量
在{分钟} 里的“0/15”表示从第0分钟开始,每15分钟。
在{分钟}里的“3/20”表示从第3分钟开始,每20分钟(它和“3,23,43”)的含义一样。“L” 字符仅被用于{日期}和{星期},它是单词“last”的缩写。
在{日期},“L”表示一个月的最后一天。
在{星期},“L”表示一个星期的最后一天,也就是SAT。
如果在“L”前有具体的内容,它就具有其他的含义了。
“6L”表示这个月的倒数第6天,“FRIL”表示这个月的最一个星期五。
注意:在使用“L”参数时,不要指定列表或范围,
由于{日期}和{星期}这两个元素互斥的, 其中之一被指定了值以后, 必须要对另一个设为”?”。
cron表达式各占位符解释:
{秒数}{分钟} ==> 允许值范围: 0~59 ,不允许为空值。
“*” 代表每隔1秒钟触发。
“,” 代表在指定的秒数触发。比如”0,15,45”代表0秒、15秒和45秒时触发任务。
“-“代表在指定的范围内触发,比如”25-45”代表从25秒开始触发到45秒结束触发,每隔1秒触发1次。
{小时} ==> 允许值范围: 0~23 ,不允许为空值,若值不合法。占位符和秒数一样。
{日期} ==> 允许值范围: 1~31 ,不允许为空值。
{月份} ==> 允许值范围: 0~11
{星期} ==> 允许值范围: 1~7 (或 SUN,MON,TUE,WED,THU,FRI,SAT), 1代表星期天(SUN),以此类推,7代表星期六(SAT),不允许为空值。
{年份} ==> 允许值范围: 1970~2099 ,允许为空。
5. @PostConstruct注解
有的时候我们的定时任务可能几个小时需要执行一次。但是呢,我们可能会需要一些初始值。
@PostConstruct注解,这个注解呢,可以在Spring加载这个类的时候执行一次。
配合@Scheduled注解一起使用,表示spring启动的时候就会执行一次这个方法,然后每天12点,23点再分别执行一次定时任务。
6.注意
使用了 @Scheduled
注解后,主类并不一定需要添加 @EnableScheduling
注解,但需要注意以下几点:
-
Spring Boot 自动配置: 如果你的项目是基于 Spring Boot 构建的,并且使用了
@SpringBootApplication
注解,Spring Boot 会自动扫描并启用定时任务调度,无需显式添加@EnableScheduling
注解。 -
普通 Spring 项目: 如果你的项目是一个普通的 Spring 项目(非 Spring Boot),在你的主配置类(一般是标有
@Configuration
注解的类)上添加@EnableScheduling
注解,以启用 Spring 的调度功能。 -
不同配置类: 如果你的定时任务类与主配置类位于不同的包中,你需要确保配置了包扫描,以便 Spring 能够发现和管理定时任务。这可能需要在主配置类上使用
@ComponentScan
或者在 Spring Boot 中使用@SpringBootApplication(scanBasePackages = "your.base.package")
来设置扫描的包。
总之,使用 @Scheduled
注解来创建定时任务是需要 Spring 的调度功能支持的。你需要确保 Spring 在你的项目中启用了调度功能,具体的做法会根据项目是否使用了 Spring Boot 和项目的包结构来有所不同。