Spring 定時任務Scheduled 開發詳細圖文

時間  2019-11-17
標籤 spring 定時 任務 scheduled 開發 詳細 圖文 欄目 Spring 简体版
原文   原文鏈接

1、前言

1.1 定時任務

Spring 框架的定時任務是基於Java 基礎知識調度任務封裝實現的；調度任務的實現方式多樣，常見的有Java 自己工具類 Timer，ScheduledExecutor 及開源工具 Quartz、JCronTab。

1.2 開發環境

IDEA2018 + JDK1.8 + Tomcat8.0

1.3 技術實現

通常項目業務複雜或模塊較多時會採用多模塊建立項目，便於業務管理與開發。此處採用多模塊形式（爲了方即可以不用多模塊），建立Maven 父項目taskproject，建立Maven 子模塊task-service 做爲普通模塊，建立Maven 子模塊task-web 做爲web 模塊。
task-web 模塊作web 處理，建立task-web/src/main/webapp/WEB-INF/web.xml。在task-web/src/main/resources 下新建Spring 配置文件。配置spring-context.xml 到web.xml。
task-service 模塊下建立業務類，即要定時執行的任務。task-web 模塊引入task-service 模塊的依賴，建立定時任務類，經過調用一個或多個業務類去定時執行具體的業務。
本項目源碼連接: github.com/niaonao/tas…

2、建立包含WEB.xml 的Maven 項目

2.1 建立多模塊項目taskproject

使用IDEA 建立Maven 項目taskproject，父模塊taskproject 不編寫的代碼，此處刪除父模塊的src 文件夾。在taskproject 下依此建立Maven 子模塊項目普通模塊task-service 和Web 模塊task-web。
圖2-1-一、IDEA 建立Maven Project 圖

這是一張圖片

GroupId 和ArtifactId 座標填寫。
圖2-1-二、自定義taskproject 項目座標圖

圖2-1-二、自定義taskproject 項目座標圖

刪除父模塊的src 文件夾。


圖2-1-三、刪除父模塊src 文件夾圖


圖2-1-三、刪除父模塊src 文件夾圖

建立兩個module 子模塊task-service 和task-web。


圖2-1-四、建立子模塊Module 圖


圖2-1-四、建立子模塊Module 圖

圖2-1-五、建立子模塊task-service 圖


圖2-1-五、建立子模塊task-service 圖

圖2-1-六、建立子模塊task-web 圖


圖2-1-六、建立子模塊task-web 圖

此時項目結構圖下
圖2-1-七、多模塊項目結構圖一

圖2-1-七、多模塊項目結構圖一

父模塊pom.xml 引入子模塊依賴、Spring 相關依賴及Web依賴。
2.1.1 父模塊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>pers.niaonao</groupId>
    <artifactId>taskproject</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>
    <!--自動添加子模塊-->
    <modules>
        <module>task-service</module>
        <module>task-web</module>
    </modules>
    
    <!--自定義屬性，用做版本控制-->
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <treasureFinal.version>1.0.0</treasureFinal.version>
        <junit.version>4.11</junit.version>
        <spring.version>4.3.3.RELEASE</spring.version>
        <spring.remoting.version>2.0.8</spring.remoting.version>
        <useragent.version>1.20</useragent.version>
        <aspect.version>1.8.9</aspect.version>
    </properties>
    
    <!--依賴添加-->
    <dependencies>
        <!-- spring -->
        <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-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-beans</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-aspects</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-aop</artifactId>
            <version>${spring.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-remoting</artifactId>
            <version>${spring.remoting.version}</version>
        </dependency>
        <dependency>
            <groupId>eu.bitwalker</groupId>
            <artifactId>UserAgentUtils</artifactId>
            <version>${useragent.version}</version>
        </dependency>
        <dependency>
            <groupId>org.aspectj</groupId>
            <artifactId>aspectjweaver</artifactId>
            <version>${aspect.version}</version>
        </dependency>
    </dependencies>

</project>
複製代碼

    子模塊pom.xml 以下，其中task-web 引入了task-service 模塊的依賴，這裏會調用task-service 模塊的業務類。
2.1.2 子模塊task-service 的pom.xml
html

<?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">
    <!--自動引入父模塊-->
    <parent>
        <artifactId>taskproject</artifactId>
        <groupId>pers.niaonao</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <artifactId>task-service</artifactId>

</project>
複製代碼

2.1.3 子模塊task-web 的pom.xml
java

<?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">
    <parent>
        <artifactId>taskproject</artifactId>
        <groupId>pers.niaonao</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>
    <!-- 設置打包方式爲war -->
    <packaging>war</packaging>
    
    <!--引入要依賴的模塊task-service -->
    <dependencies>
        <dependency>
            <groupId>pers.niaonao</groupId>
            <artifactId>task-service</artifactId>
            <version>1.0-SNAPSHOT</version>
            <scope>compile</scope>
        </dependency>
    </dependencies>
    <artifactId>task-web</artifactId>
    
</project>
複製代碼

2.2 配置task-web 子模塊Add Web

在task-web 模塊右鍵選擇功能菜單Open Module Settings 進行設置，在taskweb 模塊添加Add Web
圖2-2-一、taskweb 子模塊Open Module Settings 圖

2-2-一、taskweb 子模塊Open Module Settings 圖

圖2-2-二、taskweb 子模塊Add Web 圖


2-2-二、taskweb 子模塊Add Web 圖

配置Web 資源文件夾Web Resource Directories，以下圖2-2-3 所示，編輯Web Resource Directory，配置Web resource directory Path，在task-web 子模塊的src/main 下新建webapp 文件夾webapp 做爲Web 資源目錄。
圖2-2-三、配置taskweb 子模塊Resource Directories 圖

2-2-三、配置taskweb 子模塊Resource Directories 圖

配置Web 部署文件Deployment Descriptors，以下圖2-2-4 所示，選中Project Structure 下的Facets 配置Web(taskweb)。編輯Type 爲Web Module Deployment Descriptor 的path。在Web Module Deployment Descriptor(web.xml) 的taskproject/task-web/src/main/webapp 路徑下新建WEB-INF，選中該路徑後，在路徑後添加\web.xml，此處經過嚮導建立Web 部署文件web.xml
圖2-2-四、配置taskweb 子模塊Deployment Descriptors 圖

2-2-四、配置taskweb 子模塊Deployment Descriptors 圖

圖2-2-五、配置taskweb 子模塊web.xml 圖


圖2-2-五、配置taskweb 子模塊web.xml 圖

依次點擊Apply OK 便可。

2.3 配置Tomcat 運行Web 項目

在task-web 模塊下的webapp 下新建index.jsp 文件 

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
</head>
<body>
Task Project!
</body>
</html>

複製代碼

    按如圖所示進入Run/Debug Configurations，添加Tomcat Server，選擇Local，在Application Server 選擇本地解壓縮的 tomcat 的路徑便可。
圖2-3-一、IDEA 進入Edit Configurations 圖

圖2-3-一、IDEA 進入Edit Configurations 圖

圖2-3-二、配置Tomcat Server 圖


圖2-3-二、配置Tomcat Server 圖

Tomcat Server 的Name 能夠自定義，此處沒作修改，默認爲Unnamed。Application Server 點擊Configure 選擇配置本地的tomcat 便可。此時有個警告Warning:No artifacts configured 下面會進行artifacts 處理。
圖2-3-三、配置Application Server 圖

圖2-3-三、配置Application Server 圖

雙擊IDEA 工做區右側Maven Projects，選擇task-web 下的package 雙擊打包(task-web 的pom.xml 文件已設置打包方式爲war)，生成war 包，如圖2-3-5 所示。
圖2-3-四、task-web 打包圖

圖2-3-四、task-web 打包圖

圖2-3-五、task-web.war 圖

圖2-3-五、task-web.war 圖

標記部署的文件，解決上一步的警告。
圖2-3-六、標記部署文件 圖

圖2-3-六、標記部署文件 圖

圖2-3-七、解決artifacts 警告圖

圖2-3-七、解決artifacts 警告圖

依此點擊Apply OK 應用便可，選中配置的tomcat(Unnamed)運行項目，運行項目的快捷鍵Ctrl + Alt + D/X。而後訪問localhost:8080，此時可以訪問到index.jsp。
圖2-3-八、Run/Debug 運行圖

圖2-3-八、Run/Debug 運行圖

3、定時任務開發

3.1 配置Spring

在子模塊task-web 的src/main/resources 資源路徑下新建spring 文件夾，新建Spring 配置文件spring-config.xml，定時任務配置文件spring-task.xml。
3.1.1 spring-config.xml
下面配置中service 掃描包(pers.niaonao.taskservice,pers.niaonao.taskweb)，後面編寫Java 類時建立。 

<?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:context="http://www.springframework.org/schema/context"
       xsi:schemaLocation=" http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.3.xsd ">
    
    <!--service註解掃描 -->
    <context:component-scan base-package="pers.niaonao.taskservice,pers.niaonao.taskweb">
        <context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
    </context:component-scan>
    
    <!-- 引入SPRING配置文件  -->
    <import resource="classpath:spring/spring-task.xml"/>

</beans>
複製代碼

3.1.2 spring-task.xml
git

<?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"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.3.xsd http://www.springframework.org/schema/task http://www.springframework.org/schema/task/spring-task-3.1.xsd">
    
    <!-- 定時任務掃描器 -->
    <task:executor id="executor" pool-size="5"/>
    <task:scheduler id="scheduler" pool-size="5"/>
    <task:annotation-driven executor="executor" scheduler="scheduler"/>
</beans>
複製代碼

3.1.3 web.xml

將Spring 配置到web.xml，經過Tomcat 部署項目，經過web.xml 加載Spring 配置。
github

<?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_4_0.xsd"
         version="4.0">
    
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath:spring/spring-config.xml</param-value>
    </context-param>
    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>
    
    <!-- 防止spring內存溢出監聽器 -->
    <listener>
        <listener-class>org.springframework.web.util.IntrospectorCleanupListener</listener-class>
    </listener>
</web-app>
複製代碼

3.2 編寫自動任務類

在task-service 子模塊的src/main/java 下建立package 包pers.niaonao.taskservice，建立用戶資產任務類UserAssetTask.java，模擬要執行的任務。
在task-web 子模塊的src/main/java 下建立package 包pers.niaonao.taskweb，建立自動任務類AutoTask.java，引入用戶資產任務，調用執行。
3.2.1 UserAssetTask.java 

package pers.niaonao.taskservice;

import org.springframework.stereotype.Service;

/**
 * @Description :用戶資產任務
 * @Author: niaonao
 * @Date: 2018/9/21 15:20
 */
@Service(value = "userAssetTask")
public class UserAssetTask {

    /**
     * 平臺用戶資產更新任務，模擬一個要執行的任務
     */
    public void platformUserAssetUpdate() {
        // 此處可調用你的service、util、entity 等，編寫你的定時任務具體的業務代碼
        System.out.println("平臺用戶資產更新完成！");
    }
}
複製代碼

3.2.2 AutoTask.java
此處設置定時任務週期爲10 S執行一次。經過註解@Scheduled(cron = "0/10 * * * * ? ")實現。此處不介紹Cron 表達式，須要瞭解可參考此連接內容
web

package pers.niaonao.taskweb;

import org.springframework.scheduling.annotation.Scheduled;
import org.springframework.stereotype.Component;
import pers.niaonao.taskservice.UserAssetTask;
import javax.annotation.Resource;

/**
 * @Description :定時器
 * @Author: niaonao
 * @Date: 2018/9/21 15:17
 */
@Component
public class AutoTask {

    @Resource
    private UserAssetTask userAssetTask;

    /**
     * 用戶資產定時更新任務
     * 10s 更新一次
     */
    @Scheduled(cron = "0/10 * * * * ? ")
    public void platformUserAssetUpdate() {
        userAssetTask.platformUserAssetUpdate();
    }
}

複製代碼

3.3 運行項目驗證定時任務

此時項目結構圖如圖3-3-1所示。
圖3-3-一、多模塊項目結構圖三

圖3-3-一、多模塊項目結構圖三

再次經過Tomcat 運行(快捷鍵Alt + Shift + D)項目，能夠在控制檯看到定時任務在執行，此處是每間隔10s，打印一次內容。運行效果如圖3-3-2 所示.
圖3-3-二、定時任務運行效果圖

圖3-3-二、定時任務運行效果圖

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程