CODEWITHSUNDEEP
javaspringconfigurationannotationsscheduling
ngeek
ngeek

Reputation: 7883

How to parameterize @Scheduled(fixedDelay) with Spring 3.0 expression language?

When using the Spring 3.0 capability to annotate a scheduled task, I would like to set the fixedDelay as parameter from my configuration file, instead of hard-wiring it into my task class, like currently...

@Scheduled(fixedDelay = 5000)
public void readLog() {
        ...
}

Unfortunately it seems that with the means of the Spring Expression Language (SpEL) @Value returns a String object which in turn is not able to be auto-boxed to a long value as required by the fixedDelay parameter.

Upvotes: 155

Views: 136464

Answers (6)

Grigory Kislin
Grigory Kislin

Reputation: 18010

In case of delay configured as Duration, e.g. 5s, there are not pretty, but working solution from issues: support flexible duration parsing in placeholders

@Scheduled(fixedRateString = 
   "#{T(org.springframework.boot.convert.DurationStyle).detectAndParse('${app.update-cache}')}")

I do not understand, why issue is closed and Duration is not realized yet
BTW: I've tried, but without success, a little more pretty:

@Scheduled(fixedRateString = "'PT'+'${app.update-cache}'") and
@Scheduled(fixedRateString = "'PT'.concat('${app.update-cache}')

Upvotes: 1

attacomsian
attacomsian

Reputation: 2923

In Spring Boot 2, we can use Spring Expression Language (SpPL) for @Scheduled annotation properties:

@Scheduled(fixedRateString = "${fixed-rate.in.milliseconds}")
public void fixedRate() {
    // do something here
}

@Scheduled(fixedDelayString = "${fixed-delay.in.milliseconds}")
public void fixedDelay() {
    // do something here
}

@Scheduled(cron = "${cron.expression}")
public void cronExpression() {
    // do something here
}

The application.properties file will look like this:

fixed-rate.in.milliseconds=5000
fixed-delay.in.milliseconds=4000
cron.expression=0 15 5 * * FRI

That's it. Here is an article that explains task scheduling in detail.

Upvotes: 16

Mark-A
Mark-A

Reputation: 5936

Spring v3.2.2 has added String parameters to the original 3 long parameters to handle this. fixedDelayString, fixedRateString and initialDelayString are now available too.

@Scheduled(fixedDelayString = "${my.fixed.delay.prop}")
public void readLog() {
        ...
}

Upvotes: 494

kan
kan

Reputation: 28951

You can use the @Scheduled annotation, but together with the cron parameter only:

@Scheduled(cron = "${yourConfiguration.cronExpression}")

Your 5 seconds interval could be expressed as "*/5 * * * * *". However as I understand you cannot provide less than 1 second precision.

Upvotes: 54

Grzegorz Oledzki
Grzegorz Oledzki

Reputation: 24261

I guess the @Scheduled annotation is out of question. So maybe a solution for you would be to use task-scheduled XML configuration. Let's consider this example (copied from Spring doc):

<task:scheduled-tasks scheduler="myScheduler">
    <task:scheduled ref="someObject" method="readLog" 
               fixed-rate="#{YourConfigurationBean.stringValue}"/>
</task:scheduled-tasks>

... or if the cast from String to Long didn't work, something like this would:

<task:scheduled-tasks scheduler="myScheduler">
    <task:scheduled ref="someObject" method="readLog"
            fixed-rate="#{T(java.lang.Long).valueOf(YourConfigurationBean.stringValue)}"/>
</task:scheduled-tasks>

Again, I haven't tried any of these setups, but I hope it might help you a bit.

Upvotes: 26

Grzegorz Oledzki
Grzegorz Oledzki

Reputation: 24261

I guess you can convert the value yourself by defining a bean. I haven't tried that, but I guess the approach similar to the following might be useful for you:

<bean id="FixedDelayLongValue" class="java.lang.Long"
      factory-method="valueOf">
    <constructor-arg value="#{YourConfigurationBean.stringValue}"/>
</bean>

where:

<bean id="YourConfigurationBean" class="...">
         <property name="stringValue" value="5000"/>
</bean>

Upvotes: 1

Related Questions