ServletContainerInitializer 与 ServletContextListener

Question

我正在尝试使用 servletContainerInitializer 注册一个 servlet，但它似乎不起作用，也许这是我的代码（请查看它），但我开始想知道 ServletContainerInitializer 和 ServletContextListener 之间的区别，因为以下代码在用作 ServletContextListener 时运行良好。

来自 servlet 3.0 规范：

4.4

配置方法（动态添加servlet）：

...或来自ServletContainerInitializer 实现的onStartup 方法...

ServletContainerInitializer:

package com.marmoush.javaexamples.nullhaus.servlet;

import java.util.Set;
import javax.servlet.ServletContainerInitializer;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletRegistration;

public class MyInit implements ServletContainerInitializer {
    public void onStartup(Set<Class<?>> c, ServletContext ctx) throws ServletException {
        System.out.println("hello");
        ServletRegistration reg = ctx.addServlet("q31","com.marmoush.javaexamples.nullhaus.servlet.Q31");
        reg.addMapping("/q31/*");
    }
}

我正在尝试自动注册的 servlet：

package com.marmoush.javaexamples.nullhaus.servlet;

import java.io.IOException;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class Q31 extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        resp.getWriter().println("hello world");
    }
}

来自 nullhaus java 示例网站“仅编辑类名”的原始代码也不起作用！

package com.marmoush.javaexamples.nullhaus.servlet;

import java.util.Set;

import javax.servlet.Servlet;
import javax.servlet.ServletContainerInitializer;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.ServletRegistration;

public class MyInit implements ServletContainerInitializer {
    public void onStartup(Set<Class<?>> c, ServletContext ctx) throws ServletException {
        try {
            Class klass = Class.forName("com.marmoush.javaexamples.nullhaus.servlet.Q31");
            Class<Q31> clazz = (Class<Q31>) klass;
            Servlet s = ctx.createServlet(clazz);
            ServletRegistration.Dynamic d = ctx.addServlet("q31", s);
            d.addMapping("/baz/*");
        } catch (ClassNotFoundException e) {
            e.printStackTrace();
        }
    }
}

Answer 1

ServletContainerInitializer 实现旨在捆绑在一个 JAR 文件中，该文件又被放入 webapp 的 /WEB-INF/lib 中。 JAR 文件本身应该有一个/META-INF/services/javax.servlet.ServletContainerInitializer 文件，其中包含JAR 中ServletContainerInitializer 实现的FQN。请注意，因此不应将此文件放在 webapp 本身中！

这允许 webapp 模块开发人员让他们的 JAR 文件挂钩 webapp 的启动和关闭周期。确实，他们也可以为此使用ServletContextListener 和@WebListener，但如果webapp 自己的web.xml 文件在metadata-complete="true" 中设置了metadata-complete="true" 属性<web-app> 这意味着webapp 应该'不扫描 JAR 中的注释（这样可以节省启动时间）。

ServletContainerInitializer 在您的特定情况中不起作用，这仅意味着您实际上并没有开发模块 JAR 文件，而只是您自己的 Web 应用程序不可或缺的一部分。在这种情况下，ServletContainerInitializer 对您来说无用，您应该改用 ServletContextListener。

@WebListener
public class Config implements ServletContextListener {

    @Override
    public void contextInitialized(ServletContextEvent event) {
        // Do stuff during server startup.
    }

    @Override
    public void contextDestroyed(ServletContextEvent event) {
        // Do stuff during server shutdown.
    }

}

另见：

• Map servlet programmatically instead of using web.xml or annotations
• Splitting up shared code and web.xml from WAR project to common JAR project
• Using special auto start servlet to initialize on startup and share application data
• what is the equivalence of contextDestroyed() in ServletContainerInitializer?

Answer 2

检查您是否正确配置了 ServletContainerInitializer。 ServletContainerInitializer 类名应该在一个文件中配置：

META-INF/services/javax.servlet.ServletContainerInitializer

文件应该只包含类名。对于您的 Ex，它应该如下所示：

com.marmoush.javaexamples.nullhaus.servlet.MyInit

文件 (META-INF/services/javax.servlet.ServletContainerInitializer) 可以捆绑在 WEB-INF/lib 中的库 JAR 中。

这是任何解释的example。