首页后端开发其他后端知识Java Spring定时任务方法都有哪些方式呢

Java Spring定时任务方法都有哪些方式呢

时间2024-03-24 23:10:04发布访客分类其他后端知识浏览1395
导读:在这篇文章中我们将学习“Java Spring定时任务方法都有哪些方式呢”的相关知识,下文有详细的介绍及实例,步骤过程清晰,简单易懂,小编觉得挺不错的,有需要的朋友可以借鉴参考,希望大家阅读完这篇能有所获。...
在这篇文章中我们将学习“Java Spring定时任务方法都有哪些方式呢”的相关知识,下文有详细的介绍及实例,步骤过程清晰,简单易懂,小编觉得挺不错的,有需要的朋友可以借鉴参考,希望大家阅读完这篇能有所获。



Java实现定时任务

Jdk自带的库中,有两种方式可以实现定时任务,一种是Timer,另一种是ScheduledThreadPoolExecutor

Timer+TimerTask

创建一个Timer就创建了一个线程,可以用来调度TimerTask任务

Timer有四个构造方法,可以指定Timer线程的名字以及是否设置为为守护线程。默认名字Timer-编号,默认不是守护线程。

主要有三个比较重要的方法:

cancel():终止任务调度,取消当前调度的所有任务,正在运行的任务不受影响

purge():从任务队列中移除所有已经取消的任务

schedule:开始调度任务,提供了几个重载方法:

schedule(TimerTask task, long delay)延时执行,表示delay毫秒后执行一次task任务

schedule(TimerTask task, Date time)`指定时间执行,到`time`时间的时候执行一次`task
schedule(TimerTask task, long delay, long period)`延时周期执行,经过`delay`毫秒后每`period`毫秒执行一次`task
schedule(TimerTask task, Date firstTime, long period)`指定时间后周期执行,到达指定时间`firstTime`后每`period`毫秒执行一次`task

示例

public class TimerTest {

    public static void main(String[] args) {
    
        Timer timer = new Timer("aa");
    
        Task task = new Task();
    
        timer.schedule(task,new Date(),1000);

    }

}

class Task extends TimerTask{

    @Override
    public void run() {
    
        System.out.println(new Date());

    }

}

输出:
Thu Jul 07 14:50:02 CST 2022
Thu Jul 07 14:50:03 CST 2022
Thu Jul 07 14:50:04 CST 2022
Thu Jul 07 14:50:05 CST 2022
…………

弊端

Timer是单线程的,并且不会抛出异常,一旦定时任务抛出异常,将会导致整个线程停止,即定时任务停止。

ScheduledThreadPoolExecutor

因为Timer的缺陷,所以不建议使用Timer,建议使用ScheduledThreadPoolExecutor

ScheduledThreadPoolExecutorTimer的替代者,于JDK1.5引入,继承了ThreadPoolExecutor,是基于线程池设计的定时任务类。

主要的调度方法:

schedule只执行一次调度,(任务,延迟时间,延迟时间单位)

scheduleAtFixedRate按固定的频率调度,如果执行时间过长,下次调度会延迟,(任务,第一次执行的延迟时间,周期,时间单位)

scheduleWithFixedDelay延迟调度,一次任务执行完后加上延迟时间执行下一次任务,(任务,第一次执行的延迟时间,间隔时间,时间单位)

示例

public class TimerTest {

    public static void main(String[] args) throws Exception{
    
        ScheduledExecutorService scheduledExecutorService = Executors.newScheduledThreadPool(10);
    
        scheduledExecutorService.scheduleAtFixedRate(
                () ->
     System.out.println(new Date()),
                1,3, TimeUnit.SECONDS);

    }

}

Spring定时任务

Spring定时任务主要靠@Scheduled注解实现,corn,fixedDelay,fixedDelayString,fixedRate,fixedRateString五个参数必须指定其一,传两个或三个都会抛出异常

@Target({
ElementType.METHOD, ElementType.ANNOTATION_TYPE}
)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Repeatable(Schedules.class)
public @interface Scheduled {
    
	String CRON_DISABLED = ScheduledTaskRegistrar.CRON_DISABLED;
    
    // cron表达式
	String cron() default "";
    
    // 时区
	String zone() default "";
    
    // 从上一次调用结束到下一次调用之间的固定时间
	long fixedDelay() default -1;

    // 和fixedDelay意思相同,只是使用字符传格式,支持占位符。例如:fixedDelayString = "${
time.fixedDelay}
    "
	String fixedDelayString() default "";
    
    // 两次调用之间固定的毫秒数(不需要等待上次任务完成)
	long fixedRate() default -1;
    
    // 同上,支持占位符
	String fixedRateString() default "";
    
    // 第一次执行任务前延迟的毫秒数
	long initialDelay() default -1;
    
    // 同上,支持占位符
	String initialDelayString() default "";

}

示例

@Component
@EnableScheduling
public class ScheduledTask {

    @Scheduled(fixedDelay = 1000)
    public void task(){
    
        System.out.println("aaa");

    }

}

原理

项目启动ScheduledAnnotationBeanPostProcessorpostProcessAfterInitialization()方法扫描带有@Scheduled注解的方法:

	@Override
	public Object postProcessAfterInitialization(Object bean, String beanName) {

		if (bean instanceof AopInfrastructureBean || bean instanceof TaskScheduler ||
				bean instanceof ScheduledExecutorService) {
    
			// Ignore AOP infrastructure such as scoped proxies.
			return bean;

		}
    
		Class?>
     targetClass = AopProxyUtils.ultimateTargetClass(bean);
    
		if (!this.nonAnnotatedClasses.contains(targetClass) &
    &

				AnnotationUtils.isCandidateClass(targetClass, Arrays.asList(Scheduled.class, Schedules.class))) {
    
			MapMethod, SetScheduled>
    >
     annotatedMethods = MethodIntrospector.selectMethods(targetClass,
					(MethodIntrospector.MetadataLookupSetScheduled>
    >
    ) method ->
 {
    
						SetScheduled>
     scheduledMethods = AnnotatedElementUtils.getMergedRepeatableAnnotations(
								method, Scheduled.class, Schedules.class);
    
						return (!scheduledMethods.isEmpty() ? scheduledMethods : null);

					}
    );

			if (annotatedMethods.isEmpty()) {
    
				this.nonAnnotatedClasses.add(targetClass);

				if (logger.isTraceEnabled()) {
    
					logger.trace("No @Scheduled annotations found on bean class: " + targetClass);

				}

			}

			else {
    
				// Non-empty set of methods
				annotatedMethods.forEach((method, scheduledMethods) ->
    
                        // 调用processScheduled方法将定时任务的方法存放到任务队列中
						scheduledMethods.forEach(scheduled ->
     processScheduled(scheduled, method, bean)));

				if (logger.isTraceEnabled()) {
    
					logger.trace(annotatedMethods.size() + " @Scheduled methods processed on bean '" + beanName +
							"': " + annotatedMethods);

				}

			}

		}
    
		return bean;

	}
	protected void processScheduled(Scheduled scheduled, Method method, Object bean) {

		try {
    
            // 创建任务线程
			Runnable runnable = createRunnable(bean, method);
    
            // 解析到定时任务方式的标记,解析到正确的参数后会设置为TRUE,如果在解析到了其他的参数就会抛出异常
			boolean processedSchedule = false;
    
			String errorMessage =
					"Exactly one of the 'cron', 'fixedDelay(String)', or 'fixedRate(String)' attributes is required";
    
			SetScheduledTask>
     tasks = new LinkedHashSet>
    (4);
    
			// Determine initial delay 解析第一次的延迟(解析initialDelay参数)
			long initialDelay = scheduled.initialDelay();
    
			String initialDelayString = scheduled.initialDelayString();

			if (StringUtils.hasText(initialDelayString)) {
    
                // initialDelay不能小于0
				Assert.isTrue(initialDelay  0, "Specify 'initialDelay' or 'initialDelayString', not both");

				if (this.embeddedValueResolver != null) {
    
					initialDelayString = this.embeddedValueResolver.resolveStringValue(initialDelayString);

				}

				if (StringUtils.hasLength(initialDelayString)) {

					try {
    
						initialDelay = parseDelayAsLong(initialDelayString);

					}

					catch (RuntimeException ex) {
    
						throw new IllegalArgumentException(
								"Invalid initialDelayString value \"" + initialDelayString + "\" - cannot parse into long");

					}

				}

			}
    
			// Check cron expression 解析cron表达式
			String cron = scheduled.cron();

			if (StringUtils.hasText(cron)) {
    
                // 解析时区
				String zone = scheduled.zone();

				if (this.embeddedValueResolver != null) {
    
					cron = this.embeddedValueResolver.resolveStringValue(cron);
    
					zone = this.embeddedValueResolver.resolveStringValue(zone);

				}

				if (StringUtils.hasLength(cron)) {
    
					Assert.isTrue(initialDelay == -1, "'initialDelay' not supported for cron triggers");
    
					processedSchedule = true;

					if (!Scheduled.CRON_DISABLED.equals(cron)) {
    
						TimeZone timeZone;

						if (StringUtils.hasText(zone)) {
    
							timeZone = StringUtils.parseTimeZoneString(zone);

						}

						else {
    
							timeZone = TimeZone.getDefault();

						}
    
						tasks.add(this.registrar.scheduleCronTask(new CronTask(runnable, new CronTrigger(cron, timeZone))));

					}

				}

			}

            // 第一次延迟参数小于0,默认为0
			// At this point we don't need to differentiate between initial delay set or not anymore
			if (initialDelay  0) {
    
				initialDelay = 0;

			}
    
			// Check fixed delay 解析fixedDelay参数
			long fixedDelay = scheduled.fixedDelay();
    
			if (fixedDelay >
= 0) {
    
				Assert.isTrue(!processedSchedule, errorMessage);
    
				processedSchedule = true;
    
				tasks.add(this.registrar.scheduleFixedDelayTask(new FixedDelayTask(runnable, fixedDelay, initialDelay)));

			}
    
			String fixedDelayString = scheduled.fixedDelayString();

			if (StringUtils.hasText(fixedDelayString)) {

				if (this.embeddedValueResolver != null) {
    
					fixedDelayString = this.embeddedValueResolver.resolveStringValue(fixedDelayString);

				}

				if (StringUtils.hasLength(fixedDelayString)) {
    
					Assert.isTrue(!processedSchedule, errorMessage);
    
					processedSchedule = true;

					try {
    
						fixedDelay = parseDelayAsLong(fixedDelayString);

					}

					catch (RuntimeException ex) {
    
						throw new IllegalArgumentException(
								"Invalid fixedDelayString value \"" + fixedDelayString + "\" - cannot parse into long");

					}
    
					tasks.add(this.registrar.scheduleFixedDelayTask(new FixedDelayTask(runnable, fixedDelay, initialDelay)));

				}

			}
    
			// Check fixed rate 解析fixedRate参数
			long fixedRate = scheduled.fixedRate();
    
			if (fixedRate >
= 0) {
    
				Assert.isTrue(!processedSchedule, errorMessage);
    
				processedSchedule = true;
    
				tasks.add(this.registrar.scheduleFixedRateTask(new FixedRateTask(runnable, fixedRate, initialDelay)));

			}
    
			String fixedRateString = scheduled.fixedRateString();

			if (StringUtils.hasText(fixedRateString)) {

				if (this.embeddedValueResolver != null) {
    
					fixedRateString = this.embeddedValueResolver.resolveStringValue(fixedRateString);

				}

				if (StringUtils.hasLength(fixedRateString)) {
    
					Assert.isTrue(!processedSchedule, errorMessage);
    
					processedSchedule = true;

					try {
    
						fixedRate = parseDelayAsLong(fixedRateString);

					}

					catch (RuntimeException ex) {
    
						throw new IllegalArgumentException(
								"Invalid fixedRateString value \"" + fixedRateString + "\" - cannot parse into long");

					}
    
					tasks.add(this.registrar.scheduleFixedRateTask(new FixedRateTask(runnable, fixedRate, initialDelay)));

				}

			}
    
			// Check whether we had any attribute set
            // 如果五个参数一个也没解析到,抛出异常
			Assert.isTrue(processedSchedule, errorMessage);

			// Finally register the scheduled tasks
            // 并发控制将任务队列存入注册任务列表
			synchronized (this.scheduledTasks) {
    
				SetScheduledTask>
     regTasks = this.scheduledTasks.computeIfAbsent(bean, key ->
     new LinkedHashSet>
    (4));
    
				regTasks.addAll(tasks);

			}

		}

		catch (IllegalArgumentException ex) {
    
			throw new IllegalStateException(
					"Encountered invalid @Scheduled method '" + method.getName() + "': " + ex.getMessage());

		}

	}

将任务解析并添加到任务队列后,交由ScheduledTaskRegistrar类的scheduleTasks方法添加(注册)定时任务到环境中

protected void scheduleTasks() {

   if (this.taskScheduler == null) {
    
       //获取ScheduledExecutorService对象,实际上都是使用ScheduledThreadPoolExecutor执行定时任务调度
      this.localExecutor = Executors.newSingleThreadScheduledExecutor();
    
      this.taskScheduler = new ConcurrentTaskScheduler(this.localExecutor);

   }

   if (this.triggerTasks != null) {

      for (TriggerTask task : this.triggerTasks) {
    
         addScheduledTask(scheduleTriggerTask(task));

      }

   }

   if (this.cronTasks != null) {

      for (CronTask task : this.cronTasks) {
    
         addScheduledTask(scheduleCronTask(task));

      }

   }

   if (this.fixedRateTasks != null) {

      for (IntervalTask task : this.fixedRateTasks) {
    
         addScheduledTask(scheduleFixedRateTask(task));

      }

   }

   if (this.fixedDelayTasks != null) {

      for (IntervalTask task : this.fixedDelayTasks) {
    
         addScheduledTask(scheduleFixedDelayTask(task));

      }

   }

}

private void addScheduledTask(@Nullable ScheduledTask task) {

   if (task != null) {
    
      this.scheduledTasks.add(task);

   }

}
    



到此这篇关于“Java Spring定时任务方法都有哪些方式呢”的文章就介绍到这了,感谢各位的阅读,更多相关Java Spring定时任务方法都有哪些方式呢内容,欢迎关注网络资讯频道,小编将为大家输出更多高质量的实用文章!

声明:本文内容由网友自发贡献,本站不承担相应法律责任。对本内容有异议或投诉,请联系2913721942#qq.com核实处理,我们将尽快回复您,谢谢合作!


若转载请注明出处: Java Spring定时任务方法都有哪些方式呢
本文地址: https://pptw.com/jishu/652380.html
PHP函数参数赋值有几种方法,代码怎么写 SpringBoot接口怎么用,怎么能够实现对参数检验

游客 回复需填写必要信息