Spring中@Scheduled功能的使用方法詳解

更新時(shí)間：2022年04月08日 12:24:49 作者：青Cheng序員石頭

@Scheduled 由Spring定義,用于將方法設(shè)置為調(diào)度任務(wù),下面這篇文章主要給大家介紹了關(guān)于Spring中@Scheduled功能的使用方法,文中通過示例代碼介紹的非常詳細(xì),需要的朋友可以參考下

前言

Spring 為任務(wù)調(diào)度和基于使用@Scheduled 注釋的 cron 表達(dá)式的異步方法執(zhí)行提供了極好的支持。可以將@Scheduled 注釋與觸發(fā)器元數(shù)據(jù)一起添加到方法中。在這篇文章中，我將以4種不同的方式展示@Scheduled 功能的使用方法。

一、Spring @Scheduled Annotation

@ scheduled注釋用于任務(wù)調(diào)度。觸發(fā)器信息需要與這個(gè)注釋一起提供。

您可以使用屬性 fixedDelay/fixedRate/cron 來提供觸發(fā)信息。

fixedRate 使 Spring 定期運(yùn)行任務(wù)，即使最后一次調(diào)用仍在運(yùn)行
fixedDelay 特別控制最后一次執(zhí)行結(jié)束時(shí)的下一次執(zhí)行時(shí)間。
Cron 是一個(gè)源自 Unix cron 實(shí)用工具的特性，并且根據(jù)您的需求有各種選項(xiàng)。

示例用法如下:

@Scheduled Usages
@Scheduled(fixedDelay =30000)
public void demoServiceMethod () {... }
 
@Scheduled(fixedRate=30000)
public void demoServiceMethod () {... }
 
@Scheduled(cron="0 0 * * * *")
public void demoServiceMethod () {... }

1.2 如何啟用@Scheduled 注釋

要在 spring 應(yīng)用程序中使用@Scheduled，必須首先在 applicationConfig.xml 文件中定義 xml 名稱空間和模式位置定義。還添加任務(wù): 注釋驅(qū)動(dòng)，以支持基于注釋的任務(wù)調(diào)度。

applicationConfig.xml
xmlns:task="http://www.springframework.org/schema/task"
http://www.springframework.org/schema/task/
http://www.springframework.org/schema/task/spring-task-3.0.xsd
 
<task:annotation-driven>

上面的添加是必要的，因?yàn)槲覀儗⑹褂没谧⑨尩呐渲谩?/p>

1.3 使用@Scheduled 注釋

下一步是在類中創(chuàng)建一個(gè)類和一個(gè)方法，如下所示:

DemoService.java
public class DemoService
{
  @Scheduled(cron="*/5 * * * * ?")
  public void demoServiceMethod()
  {
    System.out.println("Method executed at every 5 seconds. Current time is :: "+ new Date());
  }
}

在上面的例子中

使用@Scheduled 注釋反過來會(huì)使 Spring 容器理解這個(gè)注釋下面的方法將作為作業(yè)運(yùn)行。
記住，帶@Scheduled 注釋的方法不應(yīng)該有傳遞給它們的參數(shù)。
它們也不應(yīng)該返回任何值
如果希望在@Scheduled 方法中使用外部對(duì)象，應(yīng)該使用自動(dòng)連接將它們注入到 DemoService 類中，而不是將它們作為參數(shù)傳遞給@Scheduled 方法。

二、固定的延時(shí)和頻率使用@Scheduled

在這個(gè)方法中，fixedDelay 屬性與@Scheduled 注釋一起使用。

舉例：

DemoServiceBasicUsageFixedDelay.java
package com.howtodoinjava.service;
 
import java.util.Date;
import org.springframework.scheduling.annotation.Scheduled;
 
public class DemoServiceBasicUsageFixedDelay
{
 &nbsp;@Scheduled(fixedDelay = 5000)
 &nbsp;//@Scheduled(fixedRate = 5000)  //Or use this
 &nbsp;public void demoServiceMethod()
  {
 &nbsp; &nbsp;System.out.println("Method executed at every 5 seconds. Current time is :: "+ new Date());
  }
}
復(fù)制代碼

應(yīng)用程序配置如下:

applicationContext.xml
< ?xml  version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:task="http://www.springframework.org/schema/task"
 xmlns:util="http://www.springframework.org/schema/util"
 xmlns:context="http://www.springframework.org/schema/context"
 xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
    http://www.springframework.org/schema/context/ http://www.springframework.org/schema/context/spring-context.xsd
    http://www.springframework.org/schema/util/ http://www.springframework.org/schema/util/spring-util.xsd
        http://www.springframework.org/schema/task/ http://www.springframework.org/schema/task/spring-task-3.0.xsd">
    <task:annotation-driven />
    <bean id="demoServiceBasicUsageFixedDelay" class="com.howtodoinjava.service.DemoServiceBasicUsageFixedDelay"></bean>
</beans>

三、配合cron表達(dá)式使用@Scheduled

在此方法中，cron 屬性與@Scheduled 注釋一起使用。

舉例：

DemoServiceBasicUsageCron.java
package com.howtodoinjava.service;
import java.util.Date;
import org.springframework.scheduling.annotation.Scheduled;
public class DemoServiceBasicUsageCron
{
  @Scheduled(cron="*/5 * * * * ?")
  public void demoServiceMethod()
  {
    System.out.println("Method executed at every 5 seconds. Current time is :: "+ new Date());
  }
}

應(yīng)用程序配置如下:

applicationContext.xml
< ?xml  version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:task="http://www.springframework.org/schema/task"
 xmlns:util="http://www.springframework.org/schema/util"
 xmlns:context="http://www.springframework.org/schema/context"
 xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
    http://www.springframework.org/schema/context/ http://www.springframework.org/schema/context/spring-context.xsd
    http://www.springframework.org/schema/util/ http://www.springframework.org/schema/util/spring-util.xsd
        http://www.springframework.org/schema/task/ http://www.springframework.org/schema/task/spring-task-3.0.xsd">
    <task:annotation-driven />
    <bean id="demoServiceBasicUsageCron" class="com.howtodoinjava.service.DemoServiceBasicUsageCron"></bean>
</beans>

四、使用properties文件配置Cron

在這個(gè)方法中，cron 屬性與@Scheduled 注釋一起使用。此屬性的值必須是 cron 表達(dá)式，如前面的方法所示，但是，此 cron 表達(dá)式將在屬性文件中定義，相關(guān)屬性的鍵將用于@Scheduled 注釋。

這將使 cron 表達(dá)式與源代碼分離，從而使更改變得容易。

DemoServicePropertiesExample.java
package com.howtodoinjava.service;
import java.util.Date;
import org.springframework.scheduling.annotation.Scheduled;
public class DemoServicePropertiesExample {
  @Scheduled(cron = "${cron.expression}")
  public void demoServiceMethod()
  {
    System.out.println("Method executed at every 5 seconds. Current time is :: "+ new Date());
  }
}

應(yīng)用程序配置如下:

applicationContext.xml
<?xml  version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:task="http://www.springframework.org/schema/task"
 xmlns:util="http://www.springframework.org/schema/util"
 xmlns:context="http://www.springframework.org/schema/context"
 xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
    http://www.springframework.org/schema/context/ http://www.springframework.org/schema/context/spring-context.xsd
    http://www.springframework.org/schema/util/ http://www.springframework.org/schema/util/spring-util.xsd
        http://www.springframework.org/schema/task/ http://www.springframework.org/schema/task/spring-task-3.0.xsd">
    <task:annotation-driven />
    <util:properties id="applicationProps" location="application.properties" />
  <context:property-placeholder properties-ref="applicationProps" />
    <bean id="demoServicePropertiesExample" class="com.howtodoinjava.service.DemoServicePropertiesExample"></bean>
</beans>

五、使用context配置Cron

該方法在屬性文件中配置 cron 表達(dá)式，在配置文件中使用 cron 表達(dá)式的屬性鍵配置作業(yè)調(diào)度。主要的變化是您不需要在任何方法上使用@Scheduled 注釋。方法配置也是在應(yīng)用程序配置文件中完成的。

舉例：

DemoServiceXmlConfig.java
package com.howtodoinjava.service;
import java.util.Date;
public class DemoServiceXmlConfig
{
  public void demoServiceMethod()
  {
    System.out.println("Method executed at every 5 seconds. Current time is :: "+ new Date());
  }
}

應(yīng)用程序配置如下：

applicationContext.xml
<?xml  version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xmlns:task="http://www.springframework.org/schema/task"
 xmlns:util="http://www.springframework.org/schema/util"
 xmlns:context="http://www.springframework.org/schema/context"
 xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
    http://www.springframework.org/schema/context/ http://www.springframework.org/schema/context/spring-context.xsd
    http://www.springframework.org/schema/util/ http://www.springframework.org/schema/util/spring-util.xsd
        http://www.springframework.org/schema/task/ http://www.springframework.org/schema/task/spring-task-3.0.xsd">
    <task:annotation-driven />
    <util:properties id="applicationProps" location="application.properties" />
  <context:property-placeholder properties-ref="applicationProps" />
  <bean id="demoServiceXmlConfig" class="com.howtodoinjava.service.DemoServiceXmlConfig" />
  <task:scheduled-tasks>
      <task:scheduled ref="demoServiceXmlConfig" method="demoServiceMethod" cron="#{applicationProps['cron.expression']}"></task:scheduled>
  </task:scheduled-tasks>
</beans>