java web 使用Executors 后。tomcat shutdown不能退出java vm 解决办法

原文地址

最近研究embeded tomcat，特别是关于tomcat启动和关闭的模块。通过查看相应的源代码， 我们知道tomcat的关闭是通过往相应的关闭端口发送指定的关闭指令来达到关闭tomcat的目的。但是有的时候，通过shutdown.bat或 shutdown.sh却不能有效地关闭tomcat，网上也有很多人提出这个问题。通过相关资料，最后问题出现线程上。 

首先看java虚拟机退出的条件，如下所示： 
a，调用了 Runtime 类的 exit 方法，并且安全管理器允许退出操作发生。 
b，非守护线程的所有线程都已停止运行，无论是通过从对 run 方法的调用中返回，还是通过抛出一个传播到 run 方法之外的异常。 

如上所示，第一条是通过exit退出，第二条指出了一个正常程序退出的条件，就是所有的非守护线程都已经停止运行。我们看相应embed tomcat的启动代码，如下所示： 

Java代码   

1. tomcat.start();   
2. tomcat.getServer().await();  

[java]  view plain  copy

1. tomcat.start();  
2. tomcat.getServer().await();  

最后一条有效的运行命令即是await，通过调用shutdown命令时，这个await就会成功的返回。按照常理来说，整个程序即会成功的完成。但是程序有时候并没有成功的结束，原因就在于程序中还存在着非守护进程。 

对于tomcat来说，tomcat程序中开启的所有进程都是守护进程，所以tomcat自身可以保证程序的正常结束。当await结束时，tomcat所就正常的结束了，包括相应的监听端口等，都已经成功结束。然而，由于项目程序中仍然还有其它线程在运行，所以导致java虚拟机并没有成功的退出。 

在我们的项目中，很多时候都运用到了线程。比如，异步调用等。不过，幸运的是，这些线程往往都是守护线程，原因就在于tomcat在运行我们的项目时，对于每一个请求，tomcat是使用了守护线程来进行相应的请求调用，这个保证在以下代码： 

Java代码   

1. // Start poller threads   
2.             pollers = new Poller[pollerThreadCount];   
3.             for (int i = 0; i < pollerThreadCount; i++) {   
4.                 pollers[i] = new Poller(false);   
5.                 pollers[i].init();   
6.                 Thread pollerThread = new Thread(pollers[i], getName() + "-Poller-" + i);   
7.                 pollerThread.setPriority(threadPriority);   
8.                 pollerThread.setDaemon(true);   
9.                 pollerThread.start();   
10.             }  

[java]  view plain  copy

1. // Start poller threads  
2.             pollers = new Poller[pollerThreadCount];  
3.             for (int i = 0; i < pollerThreadCount; i++) {  
4.                 pollers[i] = new Poller(false);  
5.                 pollers[i].init();  
6.                 Thread pollerThread = new Thread(pollers[i], getName() + "-Poller-" + i);  
7.                 pollerThread.setPriority(threadPriority);  
8.                 pollerThread.setDaemon(true);  
9.                 pollerThread.start();  
10.             }  

所以，一般情况下，在我们的项目代码中使用new Thread建立的线程都是守护线程，原因就是新建线程默认上使用建立线程时的当前线程所处的守护状态。tomcat的请求处理线程为守护线程，所以我们一般情况下建立的线程也是守护线程。然而，Executors除外。 

使用Executors建立后台线程并执行一些多线程操作时，Executors会使用相对应的threadFactory来对 runnable建立新的thread，所以使用默认的threadFactory时就会出问题。默认的ThreadFactory强制性的将新创建的线程设置为非守护状态，如下所示： 

Java代码   

1. public Thread newThread(Runnable r) {   
2.             Thread t = new Thread(group, r,   
3.                                   namePrefix + threadNumber.getAndIncrement(),   
4.                                   0);   
5.             if (t.isDaemon())   
6.                 t.setDaemon(false);   
7.             if (t.getPriority() != Thread.NORM_PRIORITY)   
8.                 t.setPriority(Thread.NORM_PRIORITY);   
9.             return t;   
10.         }  

[java]  view plain  copy

1. public Thread newThread(Runnable r) {  
2.             Thread t = new Thread(group, r,  
3.                                   namePrefix + threadNumber.getAndIncrement(),  
4.                                   0);  
5.             if (t.isDaemon())  
6.                 t.setDaemon(false);  
7.             if (t.getPriority() != Thread.NORM_PRIORITY)  
8.                 t.setPriority(Thread.NORM_PRIORITY);  
9.             return t;  
10.         }  

所以，一般情况下，我们使用executors创建多线程时，就会使用默认的threadFactory（即调用只有一个参数的工厂方法），而创建出来的线程就是非守护的。而相应的程序就永远不会退出，如采用Executors创建定时调度任务时，这个调试任务永远不会退出。解决的办法就是重写相对应的 threadFactory，如下所示： 
new ThreadFactory() { 
        public Thread newThread(Runnable r) { 
            Thread s = Executors.defaultThreadFactory().newThread(r); 
            s.setDaemon(true); 
            return s; 
        } 
    } 

同理，对于java web项目中的线程程序，一定要记住将相应的线程标记为守护线程（尽管它默认就是守护的）。而对于使用Executors，一定要记住传递相应的threadFactory实现，以重写相应的newThread方法，将线程标记为守护线程。 

以上的结论对于普通的java项目同样有效，为了正常的结束相应的程序，一定要正确的使用相应的线程，以避免java程序不能退出的问题。

第二种解决方案

建一个监听类，该类实现ServletContextListener接口中的contextInitiialized（）方法和contextDestroyed（）方法。然后在tomcat中注册该监听类，开启或关闭tomcat时，都将先执行该监听类

1、举例：新建监听类CgmIndexListener

package com.saas.cgm;


import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
//若使用ServletContextListener接口，可能需添加javax.servlet-5.1.12.jar或其它库
public class CgmIndexListener implements ServletContextListener{   
private static ExecutorService exec = Executors.newCachedThreadPool();//线程池
   //关闭tomcat前关闭线程 
public void contextDestroyed(ServletContextEvent arg0) {   
   exec.shutdownNow();;   
}   
  //开启tomcat前执行线程
public contextInitiialized(ServletContextEvent arg0) {   
  RamIndexWriter ramIndexWriter = new RamIndexWriter();//新建一个线程
  exec.execute(ramIndexWriter);
}

2、注册该监听类： 在tomcat安装目录下的conf文件夹内的web.xml文件中添加：

<listener>
            <listener-class>com.saas.cgm.CgmIndexListener</listener-class>
    </listener>

3、 此时，关闭tomcat时，tomcat首先关闭线程池exec中的ramIndexWriter 线程，当没有子线程在运行时，java.exe进程也就能被顺利关闭了