@Scheduled執行定時任務與cron表達式

時間 2019-11-25

標籤 scheduled 執行定時任務 cron 表達式简体版

原文原文鏈接

1 配置文件形式執行定時任務

1 1.X 版本與spring結合使用實例

1.1 經常使用maven管理 pom.xml文件

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.kevin.quartz</groupId>
    <artifactId>quartz</artifactId>
    <packaging>war</packaging>
    <version>1.0</version>
    <name>quartz1.x</name>
    <url>http://maven.apache.org</url>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <spring.version>3.2.14.RELEASE</spring.version>
    </properties>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-war-plugin</artifactId>
                <configuration>
                    <attachClasses>false</attachClasses>
                </configuration>
            </plugin>

            <!-- 生成源代碼的jar包 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-source-plugin</artifactId>
                <executions>
                    <execution>
                        <id>attach-sources</id>
                        <goals>
                            <goal>jar-no-fork</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.6</source>
                    <target>1.6</target>
                </configuration>
            </plugin>
        </plugins>
        <!-- 生成jar或war包的名字 -->
        <finalName>${artifactId}</finalName>
    </build>

    <dependencies>

        <dependency>
            <groupId>javax.servlet</groupId>
            <artifactId>servlet-api</artifactId>
            <version>2.5</version>
            <scope>provided</scope>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.10</version>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.16</version>
        </dependency>

        <!-- spring framework start -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-beans</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aop</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-tx</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-orm</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context-support</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-expression</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-test</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aspects</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>aopalliance</groupId>
            <artifactId>aopalliance</artifactId>
            <version>1.0</version>
        </dependency>
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>1.8.6</version>
        </dependency>
        <!-- spring framework end -->

        <dependency>
            <groupId>org.quartz-scheduler</groupId>
            <artifactId>quartz</artifactId>
            <version>1.8.6</version>
        </dependency>
    </dependencies>

</project>

View Code

2 定義個人工做類

package com.kevin.quartz.job;  
import java.util.Date;  
public class MyJob {  
    public void work() {  
        System.out.println("current datetime: " + new Date().toString());  
    }  
}

3 Spring配置文件

<?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:p="http://www.springframework.org/schema/p"
	    xsi:schemaLocation="http://www.springframework.org/schema/beans
	    http://www.springframework.org/schema/beans/spring-beans-3.0.xsd">

	<!-- 工做的bean -->
	<bean id="myJob" class="com.kevin.quartz.job.MyJob" />

	<!-- job的配置開始 -->
	<bean id="myJobDetail"
		class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
		<property name="targetObject">
			<ref bean="myJob" />
		</property>
		<property name="targetMethod">
			<value>work</value>
		</property>
	    <!--將併發設置爲false-->  
	    <property name="concurrent" value="false" />  
	</bean>
	<!-- job的配置結束 -->

	<!-- 調度的配置開始 -->
	<bean id="crontestJobTrigger" class="org.springframework.scheduling.quartz.CronTriggerBean">
		<property name="jobDetail">
			<ref bean="myJobDetail" />
		</property>
		<property name="cronExpression">
			<value>0/1 * * * * ?</value> <!— 每1秒執行一次 -->
		</property>
	</bean>
	<!-- 調度的配置結束 -->

	<!-- 啓動觸發器的配置開始 -->
        <!--  總管理類若是將lazy-init='false'那麼容器啓動就會執行調度程序   -->  
	<bean name="startQuertz" lazy-init="false" autowire="no"
		class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
		<property name="triggers">
			<list>
                <!--做業調度器,list下可加入其餘的調度器-->  
				<ref bean="crontestJobTrigger" />
			</list>
		</property>
	</bean>
	<!-- 啓動觸發器的配置結束 -->
</beans>

4 Web.Xml配置

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="3.0" xmlns="http://java.sun.com/xml/ns/javaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
    http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd">
    <!-- 說明：Spring的配置文件設置必須在啟動Spring Bean工廠監聽以前，否則會報錯-->
    <!-- Spring配置文件開始 -->
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>/WEB-INF/classes/applicationContext.xml</param-value>
    </context-param>
    <!-- Spring配置文件結束 -->
    <!-- 啓動 Spring Bean 工廠監聽開始 -->
    <listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
    <!-- 啓動 Spring Bean 工廠監聽結束 -->
</web-app>

5 運行及效果

2 2.X與spring結合使用案例

1 maven管理項目 pom

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <groupId>com.kevin.quartz</groupId>
    <artifactId>example1</artifactId>
    <packaging>jar</packaging>
    <version>1.0</version>
    
    <name>example1</name>
    <url>http://maven.apache.org</url>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <spring.version>4.0.0.RELEASE</spring.version>
    </properties>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.6</source>
                    <target>1.6</target>
                </configuration>
            </plugin>
            <!-- 生成源代碼的jar包 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-source-plugin</artifactId>
                <executions>
                    <execution>
                        <id>attach-sources</id>
                        <goals>
                            <goal>jar-no-fork</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
        <finalName>${artifactId}</finalName>
    </build>

    <dependencies>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <version>4.10</version>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.16</version>
        </dependency>

        <!-- spring framework start -->
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-core</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-beans</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-web</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-webmvc</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aop</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-tx</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-orm</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context-support</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-expression</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-test</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-aspects</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>aopalliance</groupId>
            <artifactId>aopalliance</artifactId>
            <version>1.0</version>
        </dependency>
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>1.8.6</version>
        </dependency>
        <!-- spring framework end -->

        <dependency>
            <groupId>org.quartz-scheduler</groupId>
            <artifactId>quartz</artifactId>
            <version>2.2.1</version>
        </dependency>
    </dependencies>

</project>

View Code

2 定義個人工做類

1 package com.kevin.quartz;
2 public class MyJob {
3     public void execute(){
4         System.out.println("starting ...");
5         System.out.println("this is quartz job executing ...");
6         System.out.println("ending ...");
7     }
8 }

3 在spring中配置

 1 <?xml version="1.0" encoding="UTF-8"?>
 2 <beans xmlns="http://www.springframework.org/schema/beans"
 3     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
 4     xmlns:tx="http://www.springframework.org/schema/tx" xmlns:aop="http://www.springframework.org/schema/aop"
 5     xsi:schemaLocation="http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.0.xsd
 6         http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
 7         http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd
 8         http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd">
 9 
10     <!--要調度的對象 -->
11     <bean id="myJobBean" class="com.kevin.quartz.MyJob" />
12 
13     <!-- 配置工做細節 -->
14     <bean id="jobDetail"
15         class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
16         <property name="targetObject" ref="myJobBean" />
17         <property name="targetMethod" value="execute" />
18         <!--將併發設置爲false -->
19         <property name="concurrent" value="false" />
20     </bean>
21 
22     <!-- 配置調度策略 -->
23     <bean id="trigger" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
24         <property name="jobDetail" ref="jobDetail" />
25         <!--表達式，個人是每 5秒 執行一次 -->
26         <property name="cronExpression" value="0/5 * * * * ?" />
27     </bean>
28 
29     <!-- 總管理類若是將   lazy-init='false'那麼容器啓動就會執行調度程序 -->
30     <bean id="startQuertz"
31         class="org.springframework.scheduling.quartz.SchedulerFactoryBean"
32         lazy-init="false">
33         <property name="triggers">
34             <list>
35                 <!--做業調度器,list下可加入其餘的調度器 -->
36                 <ref bean="trigger" />
37             </list>
38         </property>
39     </bean>
40 
41 </beans>

4 測試類效果

 1 package com.kevin.quartz;
 2  
 3 import org.junit.Test;
 4 import org.junit.runner.RunWith;
 5 import org.springframework.test.context.ContextConfiguration;
 6 importorg.springframework.test.context.junit4.SpringJUnit4ClassRunner;
 7  
 8 @RunWith(SpringJUnit4ClassRunner.class)
 9 @ContextConfiguration(locations = "classpath:quartz-beans.xml")
10 public class QuartzTest {
11  
12    @Test
13    public void testExecute() {
14       try {
15          Thread.sleep(1000 * 10); //此處是爲了看到效果
16       } catch (InterruptedException e) {
17          e.printStackTrace();
18       }
19    }
20 }

    starting ...  
    this is quartz job executing...  
    ending ...  
    starting ...  
    this is quartz job executing...  
    ending ...

由於項目僅執行10秒任務每5秒執行一次因此一共就只有2次執行java

2 @Scheduled註解執行定時任務

1 註解類型：@EnableScheduling @Scheduled

    @Target(value=TYPE)   
    @Retention(value=RUNTIME)  
    @Import(value=SchedulingConfiguration.class)  
    @Documentedpublic   
    @interface EnableScheduling

若是MyTask使用了@Component註解，下面的配置方式也可讓使用了@Scheduled註解的方法在設置的時間間隔裏面被調用：web

1 @Component  //import org.springframework.stereotype.Component;    
2 public class MyTask {    
3       @Scheduled(cron="0/5 * *  * * ? ")   //每5秒執行一次    
4       @Override    
5       public void myTest(){    
6             System.out.println("進入測試");    
7       }    
8 }

1     @Configuration  
2     @ComponentScan(basePackages="com.myco.tasks")  
3     public class AppConfig {  
4     }

使用了@Scheduled註解方法也能夠在使用了@Configuration註解的類裏面使用：spring

1 @Configuration
2 @EnableScheduling
3 public class AppConfig {
4     @Scheduled(fixedRate=1000)
5     public void work() {
6         // task execution logic
7     }
8 }

上面介紹的都是在單線程的狀況下執行任務調度的。express

若是但願進行更多的控制，咱們可讓使用@Configuration註解的類實現SchedulingConfigurer接口，這樣就能夠訪問底層的ScheduledRegistrar實例。
下面的例子演示如何定製Executer去執行任務計劃：apache

@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);
    }
}

注意上面例子中使用的@bean(destroyMethod="shutdown")。api

這樣是爲了確保當Spring應用上下文關閉的時候任務執行者也被正確地關閉。併發

實現SchedulingConfigurar接口還容許細粒度控制任務經過ScheduledTaskRegistrar進行登記。

例如，下面的配置使用自定義的Trigger執行bean的方法mvc

 1  @Configuration
 2  @EnableScheduling
 3  public class AppConfig implements SchedulingConfigurer {
 4      @Override
 5      public void configureTasks(ScheduledTaskRegistrar taskRegistrar) {
 6          taskRegistrar.setScheduler(taskScheduler());
 7          taskRegistrar.addTriggerTask(
 8              new Runnable() {
 9                  public void run() {
10                      myTask().work();
11                  }
12              },
13              new CustomTrigger()
14          );
15      }
16 
17      @Bean(destroyMethod="shutdown")
18      public Executor taskScheduler() {
19          return Executors.newScheduledThreadPool(42);
20      }
21 
22      @Bean
23      public MyTask myTask() {
24          return new MyTask();
25      }
26  }

做爲參考，上面的例子和下面使用XML配置方式的做用是同樣的：app

    <beans>  
        <task:annotation-driven scheduler="taskScheduler"/>  
        <task:scheduler id="taskScheduler" pool-size="42"/>  
        <task:scheduled ref="myTask" method="work" fixed-rate="1000"/>  
        <bean id="myTask" class="com.foo.MyTask"/>  
    </beans>

3 cron表達式

CronTrigger配置格式: [秒] [分] [小時] [日] [月] [周] [年]

序號說明是否必填容許填寫的值容許的通配符
1 秒是 0-59 , - * /
2 分是 0-59 , - * /
3 小時是 0-23 , - * /
4 日是 1-31 , - * ? / L W
5 月是 1-12 or JAN-DEC , - * /
6 周是 1-7 or SUN-SAT , - * ? / L #
7 年否 empty 或 1970-2099 , - * /

通配符說明:
* 表示全部值. 例如:在分的字段上設置 "*",表示每一分鐘都會觸發。
? 表示不指定值。使用的場景爲不須要關心當前設置這個字段的值。例如:要在每個月的10號觸發一個操做，但不關心是周幾，因此須要周位置的那個字段設置爲"?" 具體設置爲 0 0 0 10 * ?
- 表示區間。例如在小時上設置 "10-12",表示 10,11,12點都會觸發。
, 表示指定多個值，例如在周字段上設置 "MON,WED,FRI" 表示週一，週三和週五觸發
/ 用於遞增觸發。如在秒上面設置"5/15" 表示從5秒開始，每增15秒觸發(5,20,35,50)。在月字段上設置'1/3'所示每個月1號開始，每隔三天觸發一次。
L 表示最後的意思。在日字段設置上，表示當月的最後一天(依據當前月份，若是是二月還會依據是不是潤年[leap]), 在周字段上表示星期六，至關於"7"或"SAT"。若是在"L"前加上數字，則表示該數據的最後一個。例如在周字段上設置"6L"這樣的格式,則表示「本月最後一個星期五"
W 表示離指定日期的最近那個工做日(週一至週五). 例如在日字段上設置"15W"，表示離每個月15號最近的那個工做日觸發。若是15號正好是週六，則找最近的週五(14號)觸發, 若是15號是周未，則找最近的下週一(16號)觸發.若是15號正好在工做日(週一至週五)，則就在該天觸發。若是指定格式爲 "1W",它則表示每個月1號日後最近的工做日觸發。若是1號正是週六，則將在3號下週一觸發。(注，"W"前只能設置具體的數字,不容許區間"-").
小提示
'L'和 'W'能夠一組合使用。若是在日字段上設置"LW",則表示在本月的最後一個工做日觸發(通常指發工資 )
# 序號(表示每個月的第幾個周幾)，例如在周字段上設置"6#3"表示在每個月的第三個週六.注意若是指定"#5",正好第五週沒有周六，則不會觸發該配置(用在母親節和父親節再合適不過了)
小提示
周字段的設置，若使用英文字母是不區分大小寫的 MON 與mon相同.

經常使用示例: 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分每分觸發 0 0/5 14 * * ? 天天下午的 2點到2點59分(整點開始，每隔5分觸發) 0 0/5 14,18 * * ? 天天下午的 2點到2點59分(整點開始，每隔5分觸發) 天天下午的 18點到18點59分(整點開始，每隔5分觸發) 0 0-5 14 * * ? 天天下午的 2點到2點05分每分觸發 0 10,44 14 ? 3 WED 3月分每週三下午的 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 每個月的第三週的星期五開始觸發 0 0 12 1/5 * ? 每個月的第一個中午開始每隔5天觸發一次 0 11 11 11 11 ? 每一年的11月11號 11點11分觸發

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。