106

I have several methods annotated with @Scheduled(fixedDelay=10000).

In the application context, I have this annotation-driven setup:

<task:annotation-driven />

The problem is, sometimes some of the method executions get delayed by seconds and even minutes.

I'm assuming that even if a method takes a while to finish executing, the other methods would still execute. So I don't understand the delay.

Is there a way to maybe lessen or even remove the delay?

Paulo Merson
  • 13,270
  • 8
  • 79
  • 72
froi
  • 7,268
  • 5
  • 40
  • 78

10 Answers10

77

Spring 4.x

Code below shows the simplest possible way to configure scheduler with java config:

@Configuration
@EnableScheduling
public class SpringConfiguration {

    @Bean(destroyMethod = "shutdown")
    public Executor taskScheduler() {
        return Executors.newScheduledThreadPool(5);
    }
    ...

When more control is desired, a @Configuration class may implement SchedulingConfigurer.

Spring Boot

In Spring Boot there is a simple property to configure the thread pool size:

spring.task.scheduling.pool.size=5
G. Demecki
  • 10,145
  • 3
  • 58
  • 58
  • 5
    Since the `Executor` interface does not have `shutdown()` method, I guess it's better to use `ExecutorService` as a return type to make the bean definition correct. Or will Spring discover the actual bean type in runtime? – Vladimir Vagaytsev Apr 10 '17 at 13:13
  • 3
    XML config - `` – whoami Jun 12 '17 at 12:40
  • 3
    See [here](https://stackoverflow.com/a/35017579/3890673) for an example of a SchedulingConfigurer – crusy Aug 02 '17 at 11:25
  • 6
    Does not work together with Spring autoconfig: ***The bean 'taskScheduler', defined in class path resource [org/springframework/boot/autoconfigure/task/ TaskSchedulingAutoConfiguration.class], could not be registered. A bean with that name has already been defined in class path resource ...*** – Phil Apr 12 '19 at 09:09
  • Suggesting a new answer for this for Spring Boot >= 2 (in my case v2.2.10.RELEASE) https://stackoverflow.com/a/67567777/6555159 – socona Jan 19 '22 at 11:35
71

The documentation about scheduling says:

If you do not provide a pool-size attribute, the default thread pool will only have a single thread.

So if you have many scheduled tasks, you should configure the scheduler, as explained in the documentation, to have a pool with more threads, to make sure one long task doesn't delay all the other ones.

mwalter
  • 1,003
  • 2
  • 13
  • 31
JB Nizet
  • 678,734
  • 91
  • 1,224
  • 1,255
  • 26
    Just as an fyi: It doesn't help to provide just a link to the general docs and say that you have 'configure it'... Providing an example is infinitely more helpful. I voted for g. Demecki's answer below and not yours for this very reason... Just tips to get ahead – Nicholas Terry Aug 13 '16 at 00:41
  • The quoted documentation refers to `task:scheduler` which has a `pool-size` parameter. Does this apply to the `@Scheduled` annotation which has no pool related parameters? – David Soroko Dec 15 '17 at 11:31
  • @DavidSoroko I believe so. – froi Jan 15 '18 at 10:53
64

If you're using Spring Boot:

There is also a property you can set in your application properties file that increases the pool size:

spring.task.scheduling.pool.size=10

Seems to be there since Spring Boot 2.1.0.

Zac Thompson
  • 12,401
  • 45
  • 57
L.Butz
  • 2,466
  • 25
  • 44
47

A method annotated with @Scheduled is meant to be run separately, on a different thread at a moment in time.

If you haven't provided a TaskScheduler in your configuration, Spring will use

Executors.newSingleThreadScheduledExecutor();

which returns an ScheduledExecutorService that runs on a single thread. As such, if you have multiple @Scheduled methods, although they are scheduled, they each need to wait for the thread to complete executing the previous task. You might keep getting bigger and bigger delays as the the queue fills up faster than it empties out.

Make sure you configure your scheduling environment with an appropriate amount of threads.

Sotirios Delimanolis
  • 274,122
  • 60
  • 696
  • 724
  • Link to Spring documentation? – David Soroko Dec 15 '17 at 11:38
  • 1
    @DavidSoroko This isn't immediately obvious in Javadoc. It's easier to see it in source code. `@Scheduled` (and `@EnableScheduling`) is handled by registering a `ScheduledAnnotationBeanPostProcessor`. This post processor uses a `ScheduledTaskRegistrar` [which defaults to that single-threaded `ScheduledExecutorService`](https://github.com/spring-projects/spring-framework/blob/4.3.x/spring-context/src/main/java/org/springframework/scheduling/config/ScheduledTaskRegistrar.java#L339). – Sotirios Delimanolis Dec 15 '17 at 22:14
  • 7
    I think you are too kind - it is not in the documentation at all. As to source code - it can change from release to release. – David Soroko Dec 16 '17 at 01:00
15

The @EnableScheduling annotation provides the key information and how to resolve it:

By default, will be searching for an associated scheduler definition: either a unique TaskScheduler bean in the context, or a TaskScheduler bean named "taskScheduler" otherwise; the same lookup will also be performed for a ScheduledExecutorService bean. If neither of the two is resolvable, a local single-threaded default scheduler will be created and used within the registrar.

When more control is desired, a @Configuration class may implement SchedulingConfigurer. This allows access to the underlying ScheduledTaskRegistrar instance. For example, the following example demonstrates how to customize the Executor used to execute scheduled tasks:

 @Configuration
 @EnableScheduling
 public class AppConfig implements SchedulingConfigurer {

     @Override
     public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
         taskRegistrar.setScheduler(taskExecutor());
     }

     @Bean(destroyMethod="shutdown")
     public Executor taskExecutor() {
         return Executors.newScheduledThreadPool(100);
     }
 }

(emphasis added)

jgreen
  • 1,132
  • 2
  • 14
  • 18
  • Making `taskExecutor()` a bean function is pointless, since it's not going to be injected anywhere (therefore no need to keep a singleton bean in memory), but rather called directly from `configureTasks()`. Thus, `shutdown` will never be triggered, as `Executor` wont be a managed bean. – Yves Calaci Apr 05 '23 at 16:20
  • 1
    @YvesCalaci The code is from their docs, not mine. – jgreen Apr 18 '23 at 21:41
11

you can use:

@Bean()
public  ThreadPoolTaskScheduler  taskScheduler(){
    ThreadPoolTaskScheduler taskScheduler = new ThreadPoolTaskScheduler();
    taskScheduler.setPoolSize(2);
    return  taskScheduler;
}
sj8515465
  • 127
  • 1
  • 2
  • 2
    I think its good practice to call `taskScheduler.initialize();` before returning your instance of `taskScheduler` – Orby Feb 12 '19 at 13:44
  • Did not work for me with Spring Boot v2.2.10.RELEASE: Followed another answer from @NeeruKSingh successfully: https://stackoverflow.com/a/67567777/6555159 – socona Jan 19 '22 at 11:33
1

Use below link for the reference..great explanation and implementation:

https://crmepham.github.io/spring-boot-multi-thread-scheduling/#:~:text=By%20default%20Spring%20Boot%20will,there%20is%20enough%20threads%20available).

NeeruKSingh
  • 1,545
  • 3
  • 22
  • 26
0

Using XML file add below lines..

<task:scheduler id="taskScheduler" pool-size="15" />
<task:scheduled-tasks scheduler="taskScheduler" >
....
</task:scheduled-tasks>
Ashok Parmar
  • 336
  • 4
  • 4
-2

default spring using a single thread for schedule task. you can using @Configuration for class implements SchedulingConfigurer . referce: https://crmepham.github.io/spring-boot-multi-thread-scheduling/

zhaoyou
  • 308
  • 4
  • 19
-2

We need to pass our own thread pool scheduler, otherwise it will use default single threaded executor. Have added below code to fix-

@Bean
public Executor scheduledTaskThreadPool() {
    ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
    executor.setCorePoolSize(10);
    executor.setMaxPoolSize(10);
    executor.setThreadNamePrefix("name-");
    executor.initialize();
    return executor;
}
shubham sachan
  • 125
  • 1
  • 7