天天看點

spring+quartz定時任務入門使用篇-簡單的不能再簡單了。quartz:task

之前使用定時任務都是使用jar包。電腦的定時任務。本次使用java的定時任務。在spring-task和quartz之間選用了quartz,至于Timer之流的不是主流。

首先是選用原因。

quartz:

  1.     預設多線程異步執行。
  2.     能被叢集執行個體化,支援分布式部署。
  3.     使用JobStoreCMT(JDBCJobStore的子類),Quartz 能參與JTA事務;Quartz 能管理JTA事務(開始和送出)在執行任務之間,這樣,任務做的事就可以發生在JTA事務裡。
  4.     多個任務時,任務之間沒有直接影響,多任務執行的快慢取決于CPU的性能。
  5.     需要手動在xml中設定jobs(先配置job,之後為job設定特定trigger,最後将trigger在排程器中注冊即可)。
  6.     需要引入quartz的jar包。
  7.     對異常的處理:Quartz的某次執行任務過程中抛出異常,不影響下一次任務的執行,當下一次執行時間到來時,定時器會再次執行任務。
  8.     任務類的對象:Quartz每次執行都建立一個新的任務類對象。

task

  1.     預設單線程同步執行。
  2.     支援注解(個人建議:不要把表達式通過注解的方式實作:不利于維護)。
  3.     多個任務時,一個任務執行完畢以後才能執行下一個任務(如果目前任務執行時間過長,那麼下一個任務可能無法及時運作,即會有阻塞現象發生),如果希望并發運作,需要配置線程池。
  4.     對異常的處理:SpringTask不同,一旦某個任務在執行過程中抛出異常,則整個定時器生命周期就結束,以後永遠不會再執行定時器任務。
  5.     任務類的對象:SpringTask則每次使用同一個任務類對象。

這東西網上一大推,我也是借用,整理的。主要因為标紅的地方。是以選取了quartz。

下面進入正題

首先是maven依賴。如果不使用maven自己下載下傳對應的jar包。

<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>org.neris</groupId>
	<artifactId>CDExchange</artifactId>
	<packaging>war</packaging>
	<version>0.0.1-SNAPSHOT</version>
	<name>CDExchange Maven Webapp</name>
	<url>http://maven.apache.org</url>
	<properties>
		<!-- jar包版本配置 -->
		<spring.version>4.1.9.RELEASE</spring.version>
		<jstl.version>1.2</jstl.version>
		<servlet-api.version>2.5</servlet-api.version>
		<jsp-api.version>2.1</jsp-api.version>
		<mybatis.version>3.2.8</mybatis.version>
		<mybatis-spring.version>1.2.3</mybatis-spring.version>
		<druid.version>1.0.18</druid.version>
		<mysql.driver.version>5.1.30</mysql.driver.version>
		<fastjson.version>1.1.40</fastjson.version>
		<!-- 日志工具 -->
		<!-- 1.slf4j -->
		<slf4j.version>1.7.7</slf4j.version>
		<!-- 2.log4j -->
		<log4j.version>2.1</log4j.version>
		<httpclient.version>4.5.3</httpclient.version>
		<httpcore.version>4.4.6</httpcore.version>
		<quartz.version>2.2.2</quartz.version>
	</properties>

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

		<!-- SPRING begin -->
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-core</artifactId>
			<version>${spring.version}</version>
			<exclusions>
				<exclusion>
					<groupId>commons-logging</groupId>
					<artifactId>commons-logging</artifactId>
				</exclusion>
			</exclusions>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-beans</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-context-support</artifactId>
			<version>${spring.version}</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-aop</artifactId>
			<version>${spring.version}</version>
			<exclusions>
				<exclusion>
					<groupId>commons-logging</groupId>
					<artifactId>commons-logging</artifactId>
				</exclusion>
			</exclusions>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-tx</artifactId>
			<version>${spring.version}</version>
		</dependency>

		<!-- spring orm -->
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-orm</artifactId>
			<version>${spring.version}</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-jdbc</artifactId>
			<version>${spring.version}</version>
		</dependency>
		<!-- SPRING end -->

		<!-- WEB begin -->
		<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-oxm</artifactId>
			<version>${spring.version}</version>
		</dependency>
		<dependency>
			<groupId>javax.servlet</groupId>
			<artifactId>jstl</artifactId>
			<version>${jstl.version}</version>
			<type>jar</type>
		</dependency>
		<dependency>
			<groupId>javax.servlet</groupId>
			<artifactId>servlet-api</artifactId>
			<version>${servlet-api.version}</version>
			<scope>provided</scope>
		</dependency>
		<dependency>
			<groupId>javax.servlet.jsp</groupId>
			<artifactId>jsp-api</artifactId>
			<version>${jsp-api.version}</version>
			<scope>provided</scope>
		</dependency>
		<!-- WEB end -->

		<!-- 日志工具引入 start 根據中央監管資訊平台日志技術規範v1.0要求 -->
		<dependency>
			<groupId>org.slf4j</groupId>
			<artifactId>slf4j-api</artifactId>
			<version>${slf4j.version}</version>
		</dependency>
		<dependency>
			<groupId>org.apache.logging.log4j</groupId>
			<artifactId>log4j-slf4j-impl</artifactId>
			<version>${log4j.version}</version>
		</dependency>
		<dependency>
			<groupId>org.apache.logging.log4j</groupId>
			<artifactId>log4j-core</artifactId>
			<version>${log4j.version}</version>
		</dependency>
		<dependency>
			<groupId>org.apache.logging.log4j</groupId>
			<artifactId>log4j-web</artifactId>
			<version>${log4j.version}</version>
		</dependency>
		<!-- 日志工具引入 end 根據中央監管資訊平台日志技術規範v1.0要求 -->

		<!-- MyBatis -->
		<dependency>
			<groupId>org.mybatis</groupId>
			<artifactId>mybatis</artifactId>
			<version>${mybatis.version}</version>
		</dependency>
		<dependency>
			<groupId>org.mybatis</groupId>
			<artifactId>mybatis-spring</artifactId>
			<version>${mybatis-spring.version}</version>
		</dependency>

		<!-- connection pool -->
		<dependency>
			<groupId>com.alibaba</groupId>
			<artifactId>druid</artifactId>
			<version>${druid.version}</version>
		</dependency>

		<!-- jdbc driver -->
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<version>${mysql.driver.version}</version>
			<scope>runtime</scope>
		</dependency>

		<dependency>
			<groupId>com.alibaba</groupId>
			<artifactId>fastjson</artifactId>
			<version>${fastjson.version}</version>
		</dependency>

		<!-- httpclient start -->
		<dependency>
			<groupId>org.apache.httpcomponents</groupId>
			<artifactId>httpclient</artifactId>
			<version>${httpclient.version}</version>
		</dependency>
		<dependency>
			<groupId>org.apache.httpcomponents</groupId>
			<artifactId>httpcore</artifactId>
			<version>${httpcore.version}</version>
		</dependency>
		<!-- httpclient end -->
		
		<!-- quartz -->
		<dependency>  
	            <groupId>org.quartz-scheduler</groupId>  
	            <artifactId>quartz</artifactId>  
	        <version>${quartz.version}</version>  
	    </dependency> 
	</dependencies>
	<build>
		<finalName>CDExchange</finalName>
	</build>
</project>
           

不知道為什麼放在這裡,格式不太正常。我也懶得整理了。貼了這麼多其實,就最後一個依賴,當然和spring整合。肯定有spring支援quartz的jar。這些都不是重點。

配置檔案

<?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"   
	xmlns:tx="http://www.springframework.org/schema/tx" xmlns:mvc="http://www.springframework.org/schema/mvc"
    xsi:schemaLocation="
		http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.1.xsd
		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.1.xsd
		http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.1.xsd
		http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.1.xsd"
	default-lazy-init="true">
	
	<description>Quartz Configuration</description>
	
	<context:property-placeholder location="classpath:quartz.properties"/>
	<!-- 任務 -->
    <bean id="exchangeJob" class="org.neris.CDExchange.quartz.job.FyCaseExchangeJob"/>
    
    <!-- 任務詳情工廠 -->
    <bean id="exchangeJobDetail" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
    	<!-- 調用任務對象 -->
    	<property name="targetObject" ref="exchangeJob"/>
    	<!-- 調用任務對象中的方法 -->
    	<property name="targetMethod" value="execute"/>
    </bean>
    
    <!-- 觸發器 -->
    <bean id="exchangeTrigger" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">
    	<property name="jobDetail" ref="exchangeJobDetail"/>
    	<!-- 任務計劃 -->
    	<property name="cronExpression" value="${exchange_cronExpression}"/>
    </bean>
    
    <!-- 排程工廠 -->
    <bean id="scheduler" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
    	<property name="triggers">
    		<list>
    			<ref bean="exchangeTrigger"/>
    		</list>
    	</property>
    </bean>
</beans>
           

其中基本上都加上注釋了,友善以後檢視。

首先說明其中的任務類,很簡單就是說,你的定時任務做什麼。我這裡就是一個輸出而已。

package org.neris.CDExchange.quartz.job;

import java.util.Date;
import java.util.List;

import javax.annotation.Resource;

import org.neris.CDExchange.entity.po.FyCase;
import org.neris.CDExchange.service.FyCaseService;

/**
 * 複議案件任務
 * @author SiQiangMing 2020年4月24日 上午10:38:21
 */
public class FyCaseExchangeJob {
	
	@Resource
	private FyCaseService fyCaseService;
	
	public void execute(){
		List<FyCase> list = fyCaseService.list("0");
		for (FyCase fyCase : list) {
			System.out.println(new Date() + "task: " + fyCase.getCaseId());
		}
	}
}
           

接着是用任務詳情工廠管理你使用哪個定時任務的的對象。以及對象中的那個方法。

  <!-- 任務詳情工廠 -->

    <bean id="exchangeJobDetail" class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">

        <!-- 調用任務對象 -->

        <property name="targetObject" ref="exchangeJob"/>

        <!-- 調用任務對象中的方法 -->

        <property name="targetMethod" value="execute"/>

    </bean>

之後再定義一個觸發器。意思就是什麼時候觸發定時任務,當然最基本的功能是指定Job的執行時間,執行間隔,運作次數等。

<!-- 觸發器 -->

    <bean id="exchangeTrigger" class="org.springframework.scheduling.quartz.CronTriggerFactoryBean">

        <property name="jobDetail" ref="exchangeJobDetail"/>

        <!-- 任務計劃 -->

        <property name="cronExpression" value="${exchange_cronExpression}"/>

    </bean>

再後面是排程工廠,其中可以排程多個觸發器

<!-- 排程工廠 -->

    <bean id="scheduler" class="org.springframework.scheduling.quartz.SchedulerFactoryBean">

        <property name="triggers">

            <list>

                <ref bean="exchangeTrigger"/>

            </list>

        </property>

    </bean>

個人了解排程的作用就是将觸發器啟用。

這樣,一個定時任務就配置完成。當然不要忘記加載這個定時任務配置檔案spring-quartz.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
	xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
	version="2.5">

	<display-name>Archetype Created Web Application</display-name>

	<listener>
        <listener-class>org.springframework.web.context.request.RequestContextListener</listener-class>  
	</listener>
	<filter>
		<filter-name>encodingFilter</filter-name>
		<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
		<init-param>
			<param-name>encoding</param-name>
			<param-value>UTF-8</param-value>
		</init-param>
		<init-param>
			<param-name>forceEncoding</param-name>
			<param-value>true</param-value>
		</init-param>
	</filter>
	<filter-mapping>
		<filter-name>encodingFilter</filter-name>
		<url-pattern>/*</url-pattern>
	</filter-mapping>
  	
  	<!-- MVC Servlet -->
	<servlet>
		<servlet-name>springServlet</servlet-name>
		<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
		<init-param>
			<param-name>contextConfigLocation</param-name>
			<param-value>classpath*:/spring-*.xml</param-value>
		</init-param>
		<load-on-startup>1</load-on-startup>
	</servlet>
	<servlet-mapping>
		<servlet-name>springServlet</servlet-name>
		<url-pattern>/</url-pattern>
	</servlet-mapping>
</web-app>
           

至于springmvc的配置檔案可以不用看,都是copy,改改

<?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"   
	xmlns:tx="http://www.springframework.org/schema/tx" xmlns:mvc="http://www.springframework.org/schema/mvc"
    xsi:schemaLocation="
		http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.1.xsd
		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.1.xsd
		http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.1.xsd
		http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-4.1.xsd"
	default-lazy-init="true">

	<description>Spring Configuration</description>
	
    <!-- 加載配置屬性檔案 -->
	<context:property-placeholder ignore-unresolvable="true" location="classpath:jdbc.properties" />
	
	<!-- 使用Annotation自動注冊Bean,解決事物失效問題:在主容器中不掃描@Controller注解,在SpringMvc中隻掃描@Controller注解。  -->
	<context:component-scan base-package="org.neris.CDExchange"><!-- base-package 如果多個,用“,”分隔 -->
		<context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
	</context:component-scan>
	
 	<!-- MyBatis begin -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource"/>
        <property name="typeAliasesPackage" value="org.neris.CDExchange"/>
        <property name="mapperLocations" value="classpath:/mappings/*.xml"/>
		<property name="configLocation" value="classpath:/mybatis-config.xml"></property>
    </bean>
    
    <!-- 掃描basePackage下所有以@Repository注解的Dao接口,注入sqlSessionFactory -->
    <bean id="mapperScannerConfigurer" class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
        <property name="basePackage" value="org.neris.CDExchange"/>
        <property name="annotationClass" value="org.springframework.stereotype.Repository"/>
    </bean>

    <!-- 定義事務 -->
	<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
		<property name="dataSource" ref="dataSource" />
	</bean>

	<!-- 配置 Annotation 驅動,掃描@Transactional注解的類定義事務  -->
	<tx:annotation-driven transaction-manager="transactionManager" proxy-target-class="true"/>
    <!-- MyBatis end -->
    
	<!-- 資料源配置, 使用 BoneCP 資料庫連接配接池 -->
	<bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close"> 
	    <!-- 資料源驅動類可不寫,Druid預設會自動根據URL識别DriverClass -->
	    <property name="driverClassName" value="${jdbc.driver}" />
	    
		<!-- 基本屬性 url、user、password -->
		<property name="url" value="${jdbc.url}" />
		<property name="username" value="${jdbc.username}" />
		<property name="password" value="${jdbc.password}" />
		
		<!-- 配置初始化大小、最小、最大 -->
		<property name="initialSize" value="${jdbc.pool.init}" />
		<property name="minIdle" value="${jdbc.pool.minIdle}" /> 
		<property name="maxActive" value="${jdbc.pool.maxActive}" />
		
		<!-- 配置擷取連接配接等待逾時的時間 -->
		<property name="maxWait" value="60000" />
		
		<!-- 配置間隔多久才進行一次檢測,檢測需要關閉的空閑連接配接,機關是毫秒 -->
		<property name="timeBetweenEvictionRunsMillis" value="60000" />
		
		<!-- 配置一個連接配接在池中最小生存的時間,機關是毫秒 -->
		<property name="minEvictableIdleTimeMillis" value="300000" />
		
		<property name="validationQuery" value="${jdbc.testSql}" />
		<property name="testWhileIdle" value="true" />
		<property name="testOnBorrow" value="false" />
		<property name="testOnReturn" value="false" />
		
		<!-- 配置監控統計攔截的filters -->
	    <property name="filters" value="stat" /> 
	</bean>
	
	<!-- 使用Annotation自動注冊Bean,隻掃描@Controller -->
	<context:component-scan base-package="org.neris.CDExchange" use-default-filters="false"><!-- base-package 如果多個,用“,”分隔 -->
		<context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
	</context:component-scan>
	
	<!-- 定義視圖檔案解析 -->
	<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
		<property name="prefix" value="${web.view.prefix}"/>
		<property name="suffix" value="${web.view.suffix}"/>
	</bean>
	<!-- 靜态資源映射 -->
    <mvc:resources mapping="/static/**" location="/static/" cache-period="31536000"/>
    
    <mvc:annotation-driven/>
</beans>
           

花了半天時間,學習了。分享一下。