一、前言
在Java中有三种实现定时任务的方式：1.java自带的API java.util.Timer类 java.util.TimerTask类。2.Quartz框架 开源 功能强大 使用起来稍显复杂. 3.Spring 3.0以后自带了task 调度工具，比Quartz更加的简单方便.
二、使用
Spring从3.0后自带了task调度工具，不需要引入其他的第三方依赖。在启动类上添加@EnableScheduling注解
ScheduleTask.java
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
@Component
public class ScheduleTask {
Logger logger = LoggerFactory.getLogger(this.getClass());
@Scheduled(cron = "0 0 2 * * ?")
public void queryNumber(){
try {
System.out.println("定时任务执行了");
} catch (Exception e) {
logger.error("定时任务发生了错误，错误信息为："+e.getMessage());
}
}
}
在需要定时执行的方法上添加@Scheduled注解并指定cron的值，上面的这个例子让打印语句每天凌晨两点执行一次。
三、@Scheduled注解详解
/*
* Copyright 2002-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.scheduling.annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.scheduling.config.ScheduledTaskRegistrar;
/**
* Annotation that marks a method to be scheduled. Exactly one of the
* {@link #cron}, {@link #fixedDelay}, or {@link #fixedRate} attributes must be
* specified.
*
* <p>The annotated method must expect no arguments. It will typically have
* a {@code void} return type; if not, the returned value will be ignored
* when called through the scheduler.
*
* <p>Processing of {@code @Scheduled} annotations is performed by
* registering a {@link ScheduledAnnotationBeanPostProcessor}. This can be
* done manually or, more conveniently, through the {@code <task:annotation-driven/>}
* element or @{@link EnableScheduling} annotation.
*
* <p>This annotation may be used as a <em>meta-annotation</em> to create custom
* <em>composed annotations</em> with attribute overrides.
*
* @author Mark Fisher
* @author Juergen Hoeller
* @author Dave Syer
* @author Chris Beams
* @since 3.0
* @see EnableScheduling
* @see ScheduledAnnotationBeanPostProcessor
* @see Schedules
*/
@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Repeatable(Schedules.class)
public @interface Scheduled {
/**
* A special cron expression value that indicates a disabled trigger: {@value}.
* <p>This is primarily meant for use with <code>${...}</code> placeholders,
* allowing for external disabling of corresponding scheduled methods.
* @since 5.1
* @see ScheduledTaskRegistrar#CRON_DISABLED
*/
String CRON_DISABLED = ScheduledTaskRegistrar.CRON_DISABLED;
/**
* A cron-like expression, extending the usual UN*X definition to include triggers
* on the second, minute, hour, day of month, month, and day of week.
* <p>For example, {@code "0 * * * * MON-FRI"} means once per minute on weekdays
* (at the top of the minute - the 0th second).
* <p>The fields read from left to right are interpreted as follows.
* <ul>
* <li>second</li>
* <li>minute</li>
* <li>hour</li>
* <li>day of month</li>
* <li>month</li>
* <li>day of week</li>
* </ul>
* <p>The special value {@link #CRON_DISABLED "-"} indicates a disabled cron
* trigger, primarily meant for externally specified values resolved by a
* <code>${...}</code> placeholder.
* @return an expression that can be parsed to a cron schedule
* @see org.springframework.scheduling.support.CronSequenceGenerator
*/
String cron() default "";
/**
* A time zone for which the cron expression will be resolved. By default, this
* attribute is the empty String (i.e. the server's local time zone will be used).
* @return a zone id accepted by {@link java.util.TimeZone#getTimeZone(String)},
* or an empty String to indicate the server's default time zone
* @since 4.0
* @see org.springframework.scheduling.support.CronTrigger#CronTrigger(String, java.util.TimeZone)
* @see java.util.TimeZone
*/
String zone() default "";
/**
* Execute the annotated method with a fixed period in milliseconds between the
* end of the last invocation and the start of the next.
* @return the delay in milliseconds
*/
long fixedDelay() default -1;
/**
* Execute the annotated method with a fixed period in milliseconds between the
* end of the last invocation and the start of the next.
* @return the delay in milliseconds as a String value, e.g. a placeholder
* or a {@link java.time.Duration#parse java.time.Duration} compliant value
* @since 3.2.2
*/
String fixedDelayString() default "";
/**
* Execute the annotated method with a fixed period in milliseconds between
* invocations.
* @return the period in milliseconds
*/
long fixedRate() default -1;
/**
* Execute the annotated method with a fixed period in milliseconds between
* invocations.
* @return the period in milliseconds as a String value, e.g. a placeholder
* or a {@link java.time.Duration#parse java.time.Duration} compliant value
* @since 3.2.2
*/
String fixedRateString() default "";
/**
* Number of milliseconds to delay before the first execution of a
* {@link #fixedRate} or {@link #fixedDelay} task.
* @return the initial delay in milliseconds
* @since 3.2
*/
long initialDelay() default -1;
/**
* Number of milliseconds to delay before the first execution of a
* {@link #fixedRate} or {@link #fixedDelay} task.
* @return the initial delay in milliseconds as a String value, e.g. a placeholder
* or a {@link java.time.Duration#parse java.time.Duration} compliant value
* @since 3.2.2
*/
String initialDelayString() default "";
}
这个注解标记了一个将要被定时执行的方法，cron、fixedDelay与fixedRate三个属性必选其一。
被注解的方法不能传入参数，通常有一个void的返回值，如果不是，返回值将会被忽略。
cron是一个类似cron的表达式，可以指定秒、分、时、一个月的第几天、月、一周的星期几。例如，"0 * * * * MON-FRI"表示工作日的每一分钟都执行。
zone指定了cron表达式的时区。如果未指定，则是服务器的默认时区。
fixedDelay：执行注解方法的固定的毫秒数间隔，这个间隔是指上一次调用的结束和下一次调用的开始的时间。
fixedRate：执行注解方法的固定的毫秒数间隔，这个间隔是指每次调用之间的时间。与上面的区别是：fixedDelay是前一个方法执行完毕后的固定时间再执行下一个方法，fixedRate是上一个方法开始执行固定时间后执行下一个方法。
四、cron表达式
1、分类
cron表达式可以分为两种：
1、6位长度的 秒 分 时 日 月 星期
2、7位长度的 秒 分 时 日 月 星期 年
一般都是用6位长度的。
2、每个位置可以出现的字符
秒: 可出现 , - * / 四个字符，有效范围为0-59的整数
分: 可出现,- * / 四个字符，有效范围为0-59的整数
时: 可出现,- * / 四个字符，有效范围为0-23的整数
日: 可出现,- * / ? L W C八个字符，有效范围为0-31的整数
月: 可出现,- * / 四个字符，有效范围为1-12的整数或JAN-DEC
星期: 可出现,- * / ? L C #八个字符，有效范围为1-7的整数或SUN-SAT两个范围。1表示星期天
年: 可出现,- * / 四个字符，有效范围为1970-2099年
3、字符的含义
(1)*：表示匹配该域的任意值，假如在Minutes域使用*,即表示每分钟都会触发事件。
(2)?:只能用在DayofMonth和DayofWeek两个域。它也匹配域的任意值，但实际不会。因为DayofMonth和DayofWeek会相互影响。
例如想在每月的20日触发调度，不管20日到底是星期几，则只能使用如下写法： 13 13 15 20 * ?,其中最后一位只能用？，而不能使用*，如果使用*表示不管星期几都会触发，实际上并不是这样。
(3)-:表示范围，例如在Minutes域使用5-20，表示从5分到20分钟每分钟触发一次
(4)/：表示起始时间开始触发，然后每隔固定时间触发一次，例如在Minutes域使用5/20,则意味着5分钟触发一次，而25，45等分别触发一次.
(5),:表示列出枚举值值。例如：在Minutes域使用5,20，则意味着在5和20分每分钟触发一次。
(6)L:表示最后，只能出现在DayofWeek和DayofMonth域，如果在DayofWeek域使用5L,意味着在最后的一个星期四触发。
(7)W:表示有效工作日(周一到周五),只能出现在DayofMonth域，系统将在离指定日期的最近的有效工作日触发事件。
例如：在DayofMonth使用5W，如果5日是星期六，则将在最近的工作日：星期五，即4日触发。如果5日是星期天，则在6日触发；
如果5日在星期一到星期五中的一天，则就在5日触发。另外一点，W的最近寻找不会跨过月份
(8)LW:这两个字符可以连用，表示在某个月最后一个工作日，即最后一个星期五。
(9)#:用于确定每个月第几个星期几，只能出现在DayofMonth域。例如在4#2，表示某月的第二个星期三。
4、cron表达式举例
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触发
五、多线程定时任务
有时候需要执行的定时任务会很多，如果是串行执行会带来一些问题，比如一个很耗时的任务阻塞住了，一些需要短周期循环执行的任务也会卡住，所以可以配置一个线程池来并行执行定时任务。
有两种配置方式，一种是写一个配置类创建一个线程池，另一种是在yml文件中进行配置创建线程池。
@EnableAsync //开启对异步任务的支持
public class TaskExecutorConfig implements AsyncConfigurer {
@Override
public Executor getAsyncExecutor() {
ThreadPoolTaskExecutor taskExecutor = new ThreadPoolTaskExecutor();
taskExecutor.setCorePoolSize(5);//线程池维护线程的最少数量
taskExecutor.setMaxPoolSize(10);//线程池维护线程的最大数量
taskExecutor.setQueueCapacity(25);//缓冲队列的数量
taskExecutor.initialize();//初始化
return taskExecutor;
}
@Override
public AsyncUncaughtExceptionHandler getAsyncUncaughtExceptionHandler() {
return null;
}
}
import org.springframework.scheduling.annotation.Async;
import org.springframework.stereotype.Service;
@Service
@Async //放在类上，表明该类中所有方法都是异步执行
public class AsyncTaskService {
@Scheduled("0 15 10 * * ?")
public void executeAysncTask1(Integer i){
System.out.println("executeAysncTask1: " + i);
}
@Scheduled("0 15 10 * * ?")
public void executeAysncTask2(Integer i){
System.out.println("executeAysncTask2: " + i);
}
}
配置文件的方式：
spring:
task:
# spring定时任务执行器配置，对于spring的异步任务，会使用该执行器
execution:
thread-name-prefix: mytask- # 线程池的线程名前缀
pool:
core-size: 8 # 核心线程数，线程池创建的时候初始化的线程数
max-size: 20 # 最大线程数，缓冲队列满了后才会申请超过核心线程数的线程
keep-alive: 60s # 非核心线程的允许最大空闲时间
queue-capacity: 200 # 缓冲队列大小，用来缓冲执行任务的队列的大小
allow-core-thread-timeout: true # 是否允许核心线程超时，即开启线程池的动态增长和缩小，默认为true
shutdown: # 实现异步任务的优雅关闭
await-termination: true # 应用关闭时，是否等待定时任务执行完成
await-termination-period: 60 # 等待任务完成的最大时长，单位为秒
网友评论