解决Spring定时计划任务重复执行两次（实例被构造两次）问题的方法

 

原文地址： http://blog.csdn.net/chaijunkun/article/details/6925889

 

定时计划任务：spring + quartz

 

最近在学习使用spring定时计划任务， 发现计划任务被执行了2次， 经过查找， 在网上找到一个很详细的解决方法

 

在文章的最后，我会将自己更简单的解决方法贴出来供大家参考。下面请先来看看造成计划任务被重复执行的原因何在：

原文：

今天在做一个项目的时候用到了Spring的定时计划任务。这是Spring的特色功能，可以根据设置在特定的时间或间隔时间做特定的事。

下面给出一个例子：

package net.csdn.blog.chaijunkukn;

import java.text.SimpleDateFormat;
import java.util.Calendar;
import java.util.Locale;

public class TimerTask {
    public void printTimeStamp(){
        Calendar ca= Calendar.getInstance();
        ca.setTimeInMillis(System.currentTimeMillis());
        SimpleDateFormat sdf= new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS ", Locale.CHINA);
        //显示当前时间 精确到毫秒
        System.out.print(sdf.format(ca.getTime()));
    }
    public TimerTask(){
        this.printTimeStamp();
        System.out.println("计划任务被初始化了");
    }
    public void doTask(){
        this.printTimeStamp();
        System.out.print("计划任务被执行,线程id:");
        System.out.println(Thread.currentThread().getId());
    }
}

根据Spring关于定时任务的规范，任务执行方法应为无参数无返回的方法，因此按照规范上面的例子中声明了doTask方法。上面的例子很简单，Spring作为IoC容器，构造TimerTask实例时会调用无参构造函数，此类会在实例化时在控制台输出当前时间和构造信息。当定时任务被触发时，也会在控制台显示当前时间和任务被执行的提示信息。

下面是配置（需要声明的是，本实例基于J2EE工程，使用了log4j，配置文件只是工程中的一部分）： 

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

    <bean id="timer"
        class="org.springframework.scheduling.quartz.SchedulerFactoryBean">
        <property name="triggers">
            <list>
                <ref bean="timerTaskTrigger" />
            list>
        property>
    bean>

    <bean id="timerTaskTrigger" class="org.springframework.scheduling.quartz.CronTriggerBean">
        <property name="jobDetail">
            <ref bean="timerTaskJobDetail" />
        property>
        <property name="cronExpression">

            <value>0/3 * * * * ?value>
        property>
    bean>

    <bean id="timerTaskJobDetail"
        class="org.springframework.scheduling.quartz.MethodInvokingJobDetailFactoryBean">
        <property name="targetObject">
            <ref bean="timerTaskInstance" />
        property>
        <property name="targetMethod">
            <value>doTaskvalue>
        property>
        <property name="concurrent" value="false" />
    bean>

    <bean id="timerTaskInstance" class="net.csdn.blog.chaijunkukn.TimerTask" />
beans>

 

web.xml的配置： 

xml version="1.0" encoding="UTF-8"?>
<web-app id="WebApp_ID" version="2.4"
    xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
    <display-name>TaskTestdisplay-name>
    <servlet>
        <servlet-name>springappservlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServletservlet-class>
        <init-param>
            <param-name>contextConfigLocationparam-name>
            <param-value>/WEB-INF/classes/applicationContext*.xmlparam-value>
        init-param>
        <load-on-startup>1load-on-startup>
    servlet>

    <servlet-mapping>
        <servlet-name>springappservlet-name>
        <url-pattern>*.htmurl-pattern>
    servlet-mapping>

    <filter>
        <filter-name>EncodingFilterfilter-name>
        <filter-class>com.ku6.tech.wap.filter.EncodingFilterfilter-class>
        <init-param>
            <param-name>encodingparam-name>
            <param-value>utf-8param-value>
        init-param>
        <init-param>
            <param-name>forceEncodingparam-name>
            <param-value>trueparam-value>
        init-param>
    filter>

    <filter-mapping>
        <filter-name>EncodingFilterfilter-name>
        <url-pattern>*.htmurl-pattern>
    filter-mapping>

    <error-page>
        <error-code>404error-code>
        <location>/error.jsplocation>
    error-page>

    <welcome-file-list>
        <welcome-file>index.jspwelcome-file>
    welcome-file-list>

    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListenerlistener-class>
    listener>

    <context-param>
        <param-name>contextConfigLocationparam-name>
        <param-value>/WEB-INF/classes/applicationContext*.xmlparam-value>
    context-param>
web-app>

 

配置的部分就是这样，然后我使用MyEclipse 9.1关联上Tomcat服务器。一切都是默认的设置，然后将本引用部署并启动Tomcat服务器。

这时候问题来了，我的任务类居然被创建了两次，下面是截取的部分日志数据：

2011-11-01 19:09:02,568 INFO [main] - org.springframework.orm.hibernate3.HibernateTransactionManager.afterPropertiesSet(421) | Using DataSource [org.apache.commons.dbcp.BasicDataSource@f2ff9b] of Hibernate SessionFactory for HibernateTransactionManager
2011-11-01 19:09:02,756 INFO [main] - org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer.postProcessTemplateLoaders(124) | ClassTemplateLoader for Spring macros added to FreeMarker configuration
2011-11-01 19:09:03.878 计划任务被初始化了
2011-11-01 19:09:03,987 INFO [main] - org.quartz.core.SchedulerSignalerImpl.<init>(63) | Initialized Scheduler Signaller of type: class org.quartz.core.SchedulerSignalerImpl
2011-11-01 19:09:03,987 INFO [main] - org.quartz.core.QuartzScheduler.<init>(214) | Quartz Scheduler v.1.6.1-RC1 created.
...
2011-11-01 19:09:05,140 WARN [main] - org.hibernate.cache.EhCacheProvider.buildCache(86) | Could not find configuration [org.hibernate.cache.StandardQueryCache]; using defaults.
2011-11-01 19:09:05,218 INFO [main] - org.springframework.orm.hibernate3.HibernateTransactionManager.afterPropertiesSet(421) | Using DataSource [org.apache.commons.dbcp.BasicDataSource@85b4c5] of Hibernate SessionFactory for HibernateTransactionManager
2011-11-01 19:09:05,218 INFO [main] - org.springframework.web.servlet.view.freemarker.FreeMarkerConfigurer.postProcessTemplateLoaders(124) | ClassTemplateLoader for Spring macros added to FreeMarker configuration
2011-11-01 19:09:05.249 计划任务被初始化了
2011-11-01 19:09:05,249 INFO [main] - org.quartz.core.SchedulerSignalerImpl.<init>(63) | Initialized Scheduler Signaller of type: class org.quartz.core.SchedulerSignalerImpl
2011-11-01 19:09:05,249 INFO [main] - org.quartz.core.QuartzScheduler.<init>(214) | Quartz Scheduler v.1.6.1-RC1 created.
...
2011-11-1 19:09:05 org.apache.catalina.startup.Catalina start
信息: Server startup in 9451 ms
2011-11-01 19:09:06.013 计划任务被执行,线程id:17
2011-11-01 19:09:06.013 计划任务被执行,线程id:39
2011-11-01 19:09:09.021 计划任务被执行,线程id:19
2011-11-01 19:09:09.021 计划任务被执行,线程id:40

从上面的日志中可以看出，

在2011-11-01 19:09:03.878 定时计划任务类产生了一个实例 

在2011-11-01 19:09:05.249 定时 计划任务类又产生了一个实例

起初我对它并不关心，但是下面的问题却是不可接受的，计划任务确实是差不多每隔3秒钟被调度的，但是每次调度执行了任务方法两次。设想一下，这仅仅是个开销很小的例子，但是如果这个方法执行的是一个非常耗时耗资源的任务，好不容易执行完一次后又要执行一次，这是对计算资源的极大浪费。于是查找了一天的原因，最后在国外的一个论坛上找到了解决的办法（http://forum.springsource.org/showthread.php?33311-IoC-Container-initializes-my-app-twice）。

 

楼主roncox和我遇到了同样的问题，他和我的配置差不多，同样也贴出了配置文件。虽然其他人没有解决问题，但是他自己解决了，并提供了最后的解决方法：

 

解决办法就是将web.xml配置文件中的如下节点删掉：

<listener>
    <listener-class>org.springframework.web.context.ContextLoaderListenerlistener-class>
listener>

<context-param>
    <param-name>contextConfigLocationparam-name>
    <param-value>/WEB-INF/classes/applicationContext*.xmlparam-value>
context-param>

修改之后程序运行一切正常。个人推测，由于org.springframework.web.context.ContextLoaderListener和org.springframework.web.servlet.DispatcherServlet都能够加载applicationContext*.xml（“*”是通配符，表示所有以“applicationContext”开头的xml文件）。而两个类殊途同归，最终都将这些配置文件交给了Spring框架的Ioc容器进行实例化。因此每个类都会被实例化两次。

 

2012年1月10日补充：今天做项目自习研究了一下spring的配置文件，发现之前说的不完全正确，不应该删除web.xml中的如下节点

 

<listener>
    <listener-class>org.springframework.web.context.ContextLoaderListenerlistener-class>
listener>

<context-param>
    <param-name>contextConfigLocationparam-name>
    <param-value>/WEB-INF/classes/applicationContext*.xmlparam-value>
context-param>

因为该节点指派的applicationContext*.xml是用于实例化除servlet之外的所有对象的，可以说项目中绝大多数的service和dao层操作都由ContextLoaderListener传递给Spring来进行实例化。

 

在web应用中，web.xml还经常出现如下的配置：

 

    <servlet>


        <servlet-name>springservlet-name>
        <servlet-class>org.springframework.web.servlet.DispatcherServletservlet-class>
        <init-param>
            <param-name>contextConfigLocationparam-name>
            <param-value>classpath:servletContext.xmlparam-value>
        init-param>

        <load-on-startup>1load-on-startup>
    servlet>
    <servlet-mapping>
        <servlet-name>springservlet-name>
        <url-pattern>*.dourl-pattern>
    servlet-mapping>

这个是用来处理所有servlet的，没有它就无法通过请求地址来调用相应的Controller。
这里我明确地指示了要加载类路径下的servletContext.xml，如果不指定，则会按照注释中所描述地那样自动加载spring-servlet.xml
无论是servletContext.xml还是applicationContext*.xml都可以按照......这样的形式来配置。
问题来了，有时候不注重对象初始化的分类，尤其是使用这样的包扫描形式统一初始化，
很容易造成满足条件的对象被初始化两次，那么在计划任务的时候被执行两次也就不奇怪了。其实说来说去，还是要提醒大家，不同的配置文件其作用是不一样的，
不要将所有的初始化操作都放到一个配置文件中，更不要重复配置。不仅浪费资源，还很容易导致莫名其妙的故障。

 

 

另外，有相关文章还提到过是Tomcat服务器的问题，修改conf目录下的server.xml。修改节点Host，将appBase属性由默认的“webapps”设置为空（""）即可，如下所示：

<Host name="localhost" appBase="" unpackWARs="true" autoDeploy="true"
    xmlValidation="false" xmlNamespaceAware="false">

    <Context docBase="/usr/local/apache-tomcat-6.0.29/webapps/semwinner"
        path="" reloadable="true">Context>
    <Context docBase="/usr/local/apache-tomcat-6.0.29/webapps/emarboxmanager"
        path="/admin" reloadable="true">Context>
Host>

但是本人尝试之后并没有起作用。可能不适用于我遇到的这个问题。写出上面解决方法的作者认为web应用程序默认都是放在webapps这个目录下的，如果不把“webapps“去掉，这里会调用一次quartz的任务调度，在接下来的“

第二种解决方法来自http://nkliuliu.iteye.com/blog/816335

 

 

下面提供我的解决办法：

修改前的web.xml文件中的配置

  
  	contextConfigLocation
  	classpath:applicationContext*.xml
  
  
  	org.springframework.web.context.ContextLoaderListener
  

上面的配置文件，让我的定时计划任务执行了2次，下面是修改后的web.xml中的配置

 

  
  	contextConfigLocation
  	classpath:applicationContext.xml
  
  
  	org.springframework.web.context.ContextLoaderListener
  

 

 

注意： 我只去掉了applicationContext后面的 * 号，明确指定了加载的配置文件。