如何优雅地关闭嵌入式Tomcat（不使用Spring）_技术教程

本文介绍如何在不使用Spring框架的情况下，优雅地关闭嵌入式Tomcat服务器。通过手动管理Servlet生命周期和Tomcat实例，确保资源得到正确释放，避免潜在的内存泄漏和程序异常。重点在于正确的Servlet上下文管理和Tomcat的停止顺序，以及解决Servlet中静态对象无法访问的问题。

在开发嵌入式Tomcat应用时，优雅地关闭Tomcat实例至关重要。这不仅可以防止数据丢失，还能确保资源得到正确释放，避免潜在的内存泄漏和程序异常。以下步骤详细介绍了如何在不使用Spring框架的情况下，优雅地关闭嵌入式Tomcat服务器。

1. Servlet的销毁顺序

Servlet的销毁顺序至关重要。在Servlet.destroy()方法中，应该按照以下顺序执行：

销毁连接器（Connectors）
等待一段时间（例如5秒）
销毁上下文（Context）
等待一段时间（例如5秒）
停止Tomcat服务器
等待一段时间（例如5秒）
销毁Tomcat实例

以下是一个示例代码片段，展示了如何在Servlet.destroy()方法中执行这些步骤：

@WebServlet(urlPatterns = {"/shutdown"})
public class ShutdownServlet extends HttpServlet {

    private static final long serialVersionUID = 1L;
    private Tomcat tomcat;

    public ShutdownServlet(Tomcat tomcat) {
        this.tomcat = tomcat;
    }

    @Override
    public void destroy() {
        try {
            // 销毁连接器
            tomcat.getConnector().destroy();
            System.out.println("Connectors destroyed.");
            Thread.sleep(5000);

            // 销毁上下文
            tomcat.getHost().removeChild(tomcat.getContext());
            System.out.println("Context destroyed.");
            Thread.sleep(5000);

            // 停止Tomcat
            tomcat.stop();
            System.out.println("Tomcat stopped.");
            Thread.sleep(5000);

            // 销毁Tomcat实例
            // tomcat.destroy();  //Tomcat 10+ 不需要手动destroy
            System.out.println("Tomcat destroyed.");

        } catch (LifecycleException | InterruptedException e) {
            e.printStackTrace();
        }
    }
}

2. 监听器（Listener）的配置

确保你的监听器（例如TS_TomcatListener）能够正确地接收到contextDestroyed事件。如果你的监听器没有被调用，可能是因为Servlet类通过注解附加到上下文时，无法正确读取静态对象。

3. 解决Servlet中静态对象无法访问的问题

在某些情况下，Servlet类通过注解附加到上下文时，可能无法正确读取静态对象。为了解决这个问题，可以在构建Servlet类时，将Tomcat对象传递给它，并手动将其映射到上下文中。

// 在创建Tomcat实例时，将Tomcat对象传递给Servlet
Tomcat tomcat = new Tomcat();
// ... 其他配置 ...

// 创建Servlet实例，并将Tomcat对象传递给它
ShutdownServlet shutdownServlet = new ShutdownServlet(tomcat);

// 将Servlet手动添加到上下文中
Context ctx = tomcat.addContext("/", new File(".").getAbsolutePath());
Tomcat.addServlet(ctx, "shutdownServlet", shutdownServlet);
ctx.addServletMappingDecoded("/shutdown", "shutdownServlet");

tomcat.start();

4. 完整示例

以下是一个完整的示例，展示了如何创建一个嵌入式Tomcat服务器，并优雅地关闭它：

import org.apache.catalina.Context;
import org.apache.catalina.LifecycleException;
import org.apache.catalina.startup.Tomcat;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;

public class EmbeddedTomcat {

    public static void main(String[] args) throws Exception {
        Tomcat tomcat = new Tomcat();
        tomcat.setPort(8080);
        tomcat.setBaseDir(".");

        // 创建Servlet实例，并将Tomcat对象传递给它
        ShutdownServlet shutdownServlet = new ShutdownServlet(tomcat);

        // 将Servlet手动添加到上下文中
        Context ctx = tomcat.addContext("/", new File(".").getAbsolutePath());
        Tomcat.addServlet(ctx, "shutdownServlet", shutdownServlet);
        ctx.addServletMappingDecoded("/shutdown", "shutdownServlet");

        // 添加一个简单的Servlet
        HelloServlet helloServlet = new HelloServlet();
        Tomcat.addServlet(ctx, "helloServlet", helloServlet);
        ctx.addServletMappingDecoded("/hello", "helloServlet");


        tomcat.start();
        tomcat.getServer().await();
    }

    @WebServlet(urlPatterns = {"/shutdown"})
    public static class ShutdownServlet extends HttpServlet {

        private static final long serialVersionUID = 1L;
        private Tomcat tomcat;

        public ShutdownServlet(Tomcat tomcat) {
            this.tomcat = tomcat;
        }

        @Override
        public void destroy() {
            try {
                // 销毁连接器
                tomcat.getConnector().destroy();
                System.out.println("Connectors destroyed.");
                Thread.sleep(5000);

                // 销毁上下文
                tomcat.getHost().removeChild(tomcat.getContext());
                System.out.println("Context destroyed.");
                Thread.sleep(5000);

                // 停止Tomcat
                tomcat.stop();
                System.out.println("Tomcat stopped.");
                Thread.sleep(5000);

                // 销毁Tomcat实例
                // tomcat.destroy();  //Tomcat 10+ 不需要手动destroy
                System.out.println("Tomcat destroyed.");

            } catch (LifecycleException | InterruptedException e) {
                e.printStackTrace();
            }
        }

        @Override
        protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
            resp.setContentType("text/html");
            PrintWriter out = resp.getWriter();
            out.println("Shutting down Tomcat...");
            out.close();
            //异步调用destroy方法，防止阻塞
            new Thread(() -> {
                destroy();
                System.exit(0); // 确保JVM退出
            }).start();

        }
    }

    @WebServlet(urlPatterns = {"/hello"})
    public static class HelloServlet extends HttpServlet {
        @Override
        protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
            resp.setContentType("text/html");
            PrintWriter out = resp.getWriter();
            out.println("Hello, Embedded Tomcat!");
            out.close();
        }
    }
}

使用方法：

将代码保存为EmbeddedTomcat.java。
编译代码：javac EmbeddedTomcat.java
运行代码：java EmbeddedTomcat
访问 http://localhost:8080/hello 确认Tomcat正常启动。
访问 http://localhost:8080/shutdown 触发优雅关闭。

注意事项:

Tomcat.destroy()方法在 Tomcat 10+ 版本中已经不需要手动调用，由容器自动管理。
在destroy()方法中，可以使用Thread.sleep()方法来模拟等待时间，确保资源得到充分释放。
在实际应用中，应该根据具体情况调整等待时间。
为了确保JVM退出，可以在ShutdownServlet的doGet方法中调用System.exit(0)。需要在一个新的线程中执行destroy()方法和System.exit(0)，防止阻塞请求处理线程。

总结

通过正确地管理Servlet生命周期和Tomcat实例，可以实现优雅地关闭嵌入式Tomcat服务器。这对于确保应用程序的稳定性和可靠性至关重要。记住关键步骤：正确的Servlet销毁顺序，解决静态对象访问问题，并确保Tomcat实例被正确停止和销毁。通过理解和应用这些技术，可以构建更加健壮和可靠的嵌入式Tomcat应用。