使用ServletContextListener+线程实现Javaweb的实时后台任务和定时任务

柔光的暖阳◎ 2022-01-12 00:19 163阅读 0赞

# （一）关于ServletContextListener #

在 Servlet API 中有一个 ServletContextListener 接口，它能够监听 ServletContext 对象的生命周期，实际上就是监听 Web 应用的生命周期。

当Servlet 容器启动或终止Web 应用时，会触发ServletContextEvent 事件，该事件由ServletContextListener 来处理。在 ServletContextListener 接口中定义了处理ServletContextEvent 事件的两个方法，只要定义类实现方法即可。

核心方法使用代码如下：

/**
     * 当Servlet 容器启动Web 应用时调用该方法。在调用完该方法之后，容器再对Filter 初始化，
     * 并且对那些在Web 应用启动时就需要被初始化的Servlet 进行初始化。
     */
    contextInitialized(ServletContextEvent sce) 
    
    /**
     * 当Servlet 容器终止Web 应用时调用该方法。在调用该方法之前，容器会先销毁所有的Servlet 和Filter 过滤器。
     */
    contextDestroyed(ServletContextEvent sce)

# （二）实现定时任务（使用Timer） #

Timer是jdk中提供的一个定时器工具，使用的时候会在主线程之外起一个单独的线程执行指定的计划任务，可以指定执行一次或者反复执行多次。注意，Timer不能初始化两次，一个对象放一个Timer，否则会报初始化错误。下边看例子代码：

（1）继承ServletContextListener类实现ServletContextEvent 处理的两个方法。创建InvoiceListener  。

package com.css.listener;
    
    import java.util.Timer;
    import javax.servlet.ServletContextEvent;
    import javax.servlet.ServletContextListener;
    import com.css.thirdparty.pool.SuNingGetInvoiceThreadPool;
    import com.css.util.CheckSuNingInvoiceTimerBean;
    import com.css.util.CheckSuNingReturnOrderInvoiceTimerBean;
    
    
    public class InvoiceListener implements ServletContextListener{
    
    	private Timer checkSuNingInvoiceTimer = null;//提取开票成功的任务
    	private Timer checkSuNingReturnOrderInvoiceTimer = null;//提取退货的任务
    	
    	public void contextDestroyed(ServletContextEvent arg0) {
    		checkSuNingInvoiceTimer.cancel();
    		checkSuNingReturnOrderInvoiceTimer.cancel();
    	}
    
    	public void contextInitialized(ServletContextEvent arg0) {
    		//（2）定时任务，隔一段时间执行的。
    		checkSuNingInvoiceTimer = new Timer();
    		checkSuNingInvoiceTimer.schedule(new CheckSuNingInvoiceTimerBean(), 0, 2*60*1000);//2分钟一次
    		//checkSuNingInvoiceTimer.schedule(new CheckSuNingInvoiceTimerBean(), 0, 2*60*60*1000);//
    		//时间是以毫秒来算的，一天等于24小时，一小时等于60分钟，一分钟等于60秒，一秒等于1000毫秒。 （1000 * 60 为一分钟） *60 = 1小时 ，2小时做一次
    		
    		//（2）定时任务，隔一段时间执行的。
    		checkSuNingReturnOrderInvoiceTimer = new Timer();
    		checkSuNingReturnOrderInvoiceTimer.schedule(new CheckSuNingReturnOrderInvoiceTimerBean(), 0, 3*60*1000);//2分钟一次
    		//checkSuNingInvoiceTimer.schedule(new CheckSuNingReturnOrderInvoiceTimerBean(), 0, 2*60*60*1000);//
    		//时间是以毫秒来算的，一天等于24小时，一小时等于60分钟，一分钟等于60秒，一秒等于1000毫秒。 （1000 * 60 为一分钟） *60 = 1小时 ，2小时做一次
    		
    	}
    
    }

（2）创建线需要执行的方法CheckSuNingInvoiceTimerBean 和 CheckSuNingReturnOrderInvoiceTimerBean

import java.util.TimerTask;
    
    import org.apache.commons.logging.Log;
    import org.apache.commons.logging.LogFactory;
    
    import com.css.eshop.thirdparty.services.ISuNingService;
    
    public class CheckSuNingInvoiceTimerBean  extends TimerTask {
    	private static boolean isRunning = false;
    		
    	protected Log logger = LogFactory.getLog(this.getClass().getName());
    	
    	@Override
    	public void run() {
    		if(!isRunning){
    			isRunning=true;
    			
    			try {
    //LoadStaticReferenceTables.getSystemParm("sn_get_inv") ，为自己写的类，从数据库中提取表中的key为sn_get_inv的值，可以根据自己需要从数据库中获取值
    				if("Y".equals("这里写你需要判断的条件，可以从数据库提取判断是否执行线程，例如LoadStaticReferenceTables.getSystemParm("sn_get_inv")")){//如果为Y则，执行
    					logger.info("------------------提取发票开票成功任务开始  start------------------");
    					ISuNingService suNingService = SpringContextUtil.getBean(ISuNingService.class); 
    					//suNingService.insertSuNingVoice();//插入发票，提取开票成功的发票，这里可以写你自己的逻辑
    					logger.info("------------------提取发票开票成功任务结束 end------------------ ");
    				}
    			} catch(Exception e){
    				logger.error("CheckSuNingInvoiceTimerBean error : ",e);
    				e.printStackTrace();
    			}
    			isRunning=false;
    		} else { 
    			logger.info( "Last CheckSuNingInvoiceTimerBean job does not stop!!!"); 
            }
    	}
    }

import java.util.TimerTask;
    
    import org.apache.commons.logging.Log;
    import org.apache.commons.logging.LogFactory;
    
    import com.css.eshop.thirdparty.services.ISuNingService;
    
    public class CheckSuNingReturnOrderInvoiceTimerBean  extends TimerTask {
    	private static boolean isRunning = false;
    	
    	protected Log logger = LogFactory.getLog(this.getClass().getName());
    	
    	@Override
    	public void run() {
    		if(!isRunning){
    			isRunning=true;
    			try {
    			//同上，写自己的判断，也可以不加入判断	if("Y".equals(LoadStaticReferenceTables.getSystemParm("sn_get_return_inv"))){//如果为Y则，执行
    					logger.info("提取退货冲红发票任务开始 start------------------");
    					ISuNingService suNingService = SpringContextUtil.getBean(ISuNingService.class); 
    					//suNingService.insertSuNingVoiceReturnOfGoods();//执行任务,提取退货发票，这里可以写你自己的逻辑
    					logger.info("提取退货冲红发票任务结束 end------------------ ");
    				}
    			} catch(Exception e){
    				logger.error("CheckSuNingReturnOrderInvoiceTimerBean error : ",e);
    				e.printStackTrace();
    			}
    			isRunning=false;
    		} else { 
    			logger.info( "Last CheckSuNingReturnOrderInvoiceTimerBean job does not stop!!!"); 
            }
    		
    	}
    
    }

（3）到web.xml中去配置监听类

<listener>
      <listener-class>com.css.eshop.listener.InvoiceListener </listener-class>
    </listener>

（4）执行程序，则自动运行后台任务拉，看效果。同时，定时任务中的时间可以根据数据库更改实现，初始化的时候就会读取。而是否执行你想要的逻辑，也能通过前端去执行

一个两分钟执行一次，一个三分钟执行一次。![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2NDExODc0_size_16_color_FFFFFF_t_70][]

通过前台控制是否执行任务。也就是（2）中的判断条件。

![20190621110728219.png][]

# （三）实验不定时任务（一直重复执行的任务） #

（1）实现监听类InvoiceListener  ：

import java.util.Timer;
    import javax.servlet.ServletContextEvent;
    import javax.servlet.ServletContextListener;
    import com.css.eshop.thirdparty.pool.SuNingGetInvoiceThreadPool;
    import com.css.eshop.util.CheckSuNingInvoiceTimerBean;
    import com.css.eshop.util.CheckSuNingReturnOrderInvoiceTimerBean;
    
    
    public class InvoiceListener  implements ServletContextListener{
    
    	private SuNingGetInvoiceThreadPool pool=null;
    	
    	
    	public void contextDestroyed(ServletContextEvent arg0) {
    		if(pool!=null){
    			pool.destroy();
    		}
    	
    	}
    
    	public void contextInitialized(ServletContextEvent arg0) {
    		
    		//（1）随时执行，没有定时的
    		System.out.println("进入SuNingInvoiceListener");
    		pool=SuNingGetInvoiceThreadPool.INSTANCE;
    		pool.create(3);//创建worker	
    	}
    }

（2）通过枚举实现，创建类SuNingGetInvoiceThreadPool ：（最安全的方法）

下例中枚举类型在编译之后是一个继承了java.lang.Enum类的普通类SingleTon，INSTANCE最终是public static final SingleTon类型的对象，本质上是饿汉模式，但是可防止反序列化，所以 比饿汉模式更好。

import com.css.eshop.thirdparty.workers.SuNingGetInvoiceWorker;
    
    public enum SuNingGetInvoiceThreadPool {
    
    	//实际上，下例中枚举类型在编译之后是一个继承了java.lang.Enum类的普通类SingleTon，INSTANCE最终是public static final SingleTon类型的对象，本质上是饿汉模式，但是可防止反序列化，所以 比饿汉模式更好。
    	INSTANCE;
    	
    	private SuNingGetInvoiceWorker[]  suNingGetInvoiceWorker;
    	
    
    	/**
        * 创建线程池
        */
    	public void create(int active){
    		suNingGetInvoiceWorker=new SuNingGetInvoiceWorker[active];
    		for(int i=0;i<suNingGetInvoiceWorker.length;i++){
    			System.out.println("创建worker:suNingGetInvoiceWorker_A"+ i);
    			suNingGetInvoiceWorker[i]=new SuNingGetInvoiceWorker("suNingGetInvoiceWorker_A"+i);
    			suNingGetInvoiceWorker[i].start();
    		}
    	}
    	
    	/**
    	    * 销毁线程池
    	    */
    	public synchronized void destroy() {
    	    for (int i = 0; i < suNingGetInvoiceWorker.length; i++) {
    	       suNingGetInvoiceWorker[i].stopWorker();
    	       suNingGetInvoiceWorker[i] = null;
    	    }
    	}
    }

（3）处理执行的方法，实现 SuNingGetInvoiceWorker类：

import org.apache.commons.logging.Log;
    import org.apache.commons.logging.LogFactory;
    import com.css.eshop.model.Staff;
    import com.css.eshop.thirdparty.services.ISuNingService;
    import com.css.eshop.util.LoadStaticReferenceTables;
    import com.css.eshop.util.SpringContextUtil;
    
    public class SuNingGetInvoiceWorker extends Thread  {
    
    	private boolean isRunning = true;//是否开启
    	protected Log logger = LogFactory.getLog(this.getClass().getName());
    	private String id;
    	private Staff staff;
    	
    
    	public SuNingGetInvoiceWorker(){
    		super();
    	}
    	
    	public SuNingGetInvoiceWorker(String id){
    		super();
    		this.id = id;
    	}
    	
    	public void stopWorker(){
    		isRunning=false;
    	}
    	
    	public void run() {
    		while(isRunning){
    			try{
    				processAutoAddSuNingInvoiceTask();
    			} catch(Exception e){
    				logger.error(id+"  auto apprv processAutoAddSuNingInvoiceTask  error : ",e);
    			}
    		}
    	}
    	
    	public void processAutoAddSuNingInvoiceTask() throws Exception{
    		if("Y".equals(LoadStaticReferenceTables.getSystemParm("suning_get_Invoice"))){//如果为Y则，执行。也就是读取你数据库的方法，也可以自己设置判断是否执行的条件
    			
    			ISuNingService ISuNingService = SpringContextUtil.getBean(ISuNingService.class); 
    			logger.info("-----------------com.css.eshop.thirdparty.workers.SuNingGetInvoiceWorker  开始执行-----------------");
    			ISuNingService.insertSuNingVoice();//插入发票，自己处理的方法
    			logger.info("-----------------com.css.eshop.thirdparty.workers.SuNingGetInvoiceWorker  开始完毕-----------------");
    		}
    	}
    }

（4）配置web.xml

<listener>
      <listener-class>com.css.eshop.listener.InvoiceListener </listener-class>
    </listener>

启动执行，完成收工。当然还有另一种方法，就是使用quartz在前端设置是否开启删除。看下一篇文章。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM2NDExODc0_size_16_color_FFFFFF_t_70]: /images/20220109/62f19ccd67f94486bc22345fe760ad70.png
[20190621110728219.png]: /images/20220109/ede77b419f16456ea9c4647818c09eab.png