快捷導(dǎo)航

SpringMVC Cron定時(shí)器Demo常見問題解決方案

更新時(shí)間：2020年11月23日 08:37:03 作者：劍道子羽

這篇文章主要介紹了SpringMVC Cron定時(shí)器Demo常見問題解決方案,文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下

該技術(shù)的不適用的場景

如果在集群環(huán)境下，多臺(tái)服務(wù)器中只希望有一臺(tái)執(zhí)行，那 Spring 自帶的這種定時(shí)器方式可能不太符合你的需要。
但是，如果每臺(tái)服務(wù)器都需要獨(dú)立執(zhí)行該定時(shí)器任務(wù)，且相互之間不存在同步，那么還是可以考慮的

SpringMVC 定時(shí)器

本文著重介紹的是 SpringMVC 配置定時(shí)器的方式，而不是 SpringBoot 配置定時(shí)器的方式。

注解方式

首先，在 Clock 類上添加 @Component，然后，在需要定時(shí)執(zhí)行的方法上面加上 @Scheduled，最后指定 cron 表達(dá)式。

項(xiàng)目結(jié)構(gòu)：

Clock.java

package coderead.spring.scheduled;
import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
import java.util.Date;
@Component
public class Clock {
  // 每5秒鐘執(zhí)行一次
  @Scheduled(cron = "*/5 * * * * ?")
  public void testTime() {
    System.out.println(new Date());
  }
}

spring-mvc.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:mvc="http://www.springframework.org/schema/mvc"
    xmlns:task="http://www.springframework.org/schema/task"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
      http://www.springframework.org/schema/beans/spring-beans.xsd
      http://www.springframework.org/schema/mvc
      http://www.springframework.org/schema/mvc/spring-mvc.xsd
      http://www.springframework.org/schema/context
      http://www.springframework.org/schema/context/spring-context.xsd
      http://www.springframework.org/schema/task
      http://www.springframework.org/schema/task/spring-task.xsd">

  <mvc:annotation-driven />

  <context:component-scan base-package="coderead.spring.*" />
  
  <!-- 定時(shí)任務(wù)支持注解 -->
  <task:annotation-driven />
</beans>

web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
     version="3.1">
  <!--配置多個(gè)上下文會(huì)導(dǎo)致多次執(zhí)行-->
  <context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>classpath:spring/spring-mvc.xml</param-value>
  </context-param>

  <!-- ================================== listener ================================== -->
  <listener>
    <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
  </listener>


  <!-- ================================== servlet ================================== -->
  <!-- 前端控制器 -->
  <servlet>
    <servlet-name>dispatcherServlet</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value></param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>dispatcherServlet</servlet-name>
    <url-pattern>/</url-pattern>
  </servlet-mapping>

</web-app>

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<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/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>

  <groupId>coderead.spring</groupId>
  <artifactId>spring-scheduled-test</artifactId>
  <version>1.0-SNAPSHOT</version>
  <packaging>war</packaging>


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

  <dependencies>
    <dependency>
      <groupId>org.springframework</groupId>
      <artifactId>spring-webmvc</artifactId>
      <version>${spring.version}</version>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.1</version>
        <configuration>
          <source>1.8</source>
          <target>1.8</target>
          <encoding>UTF-8</encoding>
        </configuration>
      </plugin>
      <plugin>
        <groupId>org.eclipse.jetty</groupId>
        <artifactId>jetty-maven-plugin</artifactId>
        <version>9.4.33.v20201020</version>
      </plugin>
    </plugins>
  </build>

</project>

如果你不知道怎么用 jetty 啟動(dòng)項(xiàng)目，你可以考慮參考使用maven-Jetty9-plugin插件運(yùn)行第一個(gè)Servlet

xml 配置方式

如果你需要使用 xml 配置，你會(huì)發(fā)現(xiàn) @Scheduled 注解和 <task:scheduled> 有著相同的屬性。因此我們將上一節(jié)的代碼稍稍改動(dòng)一下：

Clock.java 去掉注解

package coderead.spring.scheduled;
import java.util.Date;
public class Clock {
  public void testTime() {
    System.out.println(new Date());
  }
}

spring-mvc.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:mvc="http://www.springframework.org/schema/mvc"
    xmlns:task="http://www.springframework.org/schema/task"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:context="http://www.springframework.org/schema/context"
    xsi:schemaLocation="http://www.springframework.org/schema/beans
      http://www.springframework.org/schema/beans/spring-beans.xsd
      http://www.springframework.org/schema/mvc
      http://www.springframework.org/schema/mvc/spring-mvc.xsd
      http://www.springframework.org/schema/context
      http://www.springframework.org/schema/context/spring-context.xsd
      http://www.springframework.org/schema/task
      http://www.springframework.org/schema/task/spring-task.xsd">

  <mvc:annotation-driven />

  <context:component-scan base-package="coderead.spring.*" />

  <!--用 xml 方式注入 Clock Bean-->
  <bean id="clock" class="coderead.spring.scheduled.Clock" />
  <!--用 xml 方式設(shè)置定時(shí)器-->
  <task:scheduled-tasks>
    <task:scheduled ref="clock" method="testTime" cron="*/5 * * * * ?"/>
  </task:scheduled-tasks>

</beans>

常見問題

@Scheduled 定時(shí)任務(wù)不生效

@Scheduled定時(shí)任務(wù)不生效？？？

此方法不能有參數(shù)
此方法不能有返回值
此類中不能包含其他帶任何注解的方法（發(fā)現(xiàn)新大陸）

還有一種可能就是沒有在 spring-mvc.xml 文件中加入 <task:annotation-driven /> 而不僅僅是加入 <mvc:annotation-driven />

@Scheduled 定時(shí)任務(wù)執(zhí)行兩次

@Scheduled Spring定時(shí)任務(wù)每次執(zhí)行兩次解決方案

主要原因是 web.xml 同時(shí)設(shè)置了 <context-param> 和 <init-param> 都設(shè)置了 contextConfigLocation，兩次加載配置文件

<web-app ....>
  <context-param>
    <param-name>contextConfigLocation</param-name>
    <param-value>classpath:spring/spring-mvc.xml</param-value>
  </context-param>
  ...
  <servlet>
    <servlet-name>dispatcherServlet</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <init-param>
      <param-name>contextConfigLocation</param-name>
      <param-value>classpath:spring/spring-mvc.xml</param-value>
    </init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>
  ...
</web-app>

cron 表達(dá)式

cron 表達(dá)式是用來規(guī)定代碼執(zhí)行周期的一種表達(dá)式，cron表達(dá)式詳解這篇文章詳細(xì)的講解了 cron 表達(dá)式的使用細(xì)節(jié)。
以我的淺陋的經(jīng)驗(yàn)，我對 cron 表達(dá)式的記憶是：

常用的 cron 表達(dá)式由 6 個(gè)域組成，域和域之間以空格分開

域從左到右，時(shí)間單位從秒開始逐步增大。他們分別是 "秒分時(shí) 日期月份星期"

因?yàn)槿掌诤托瞧跁?huì)相互影響，通常如果其中一個(gè)用非? 表示任意，則另一個(gè)必須用 ? 表示“任意”。

原因：通常，在指定日期條件之后，我們雖然希望“任意星期幾”，但是實(shí)際上，此時(shí)星期需要根據(jù)日期的變化而相應(yīng)變化，做不到完全任意。

你還可以通過在線 Cron 表達(dá)式來幫助你理解前人代碼中的 cron 表達(dá)式的含義，或者根據(jù)你的需求生成一個(gè)新的 cron 表達(dá)式。

以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: