一、ServletContainerInitializer

1、来到 jcp 官网:https://www.jcp.org/en/home/index

2、搜索 servlet,然后下载文档

3、重点看 8.2.4 Shared libraries / runtimes pluggability 章节

重点是这一段:

翻译如下:

1、Servlet 容器启动会扫描,当前应用里面每一个 jar 包的 ServletContainerInitializer 的实现

2、提供 ServletContainerInitializer 的实现类; 必须绑定在,META-INF/services/javax.servlet.ServletContainerInitializer

文件的内容就是 ServletContainerInitializer 实现类的全类名;

4、下面这一段也很关键

大意是我们可以给 ServletContainerInitializer 的实现类添加 @HandlesTypes 注解

在其 onStartup 方法上便可以得到我们感兴趣的类;

5、总结

容器在启动应用的时候,会扫描当前应用每一个 jar 包里面 META-INF/services/javax.servlet.ServletContainerInitializer

指定的实现类,启动并运行这个实现类的方法;传入感兴趣的类型;

二、案例

创建一个 ServletContainerInitializer 的子类,并在 META-INF/services/javax.servlet.ServletContainerInitializer 文件中声明子类的全类名,然后重写子类的 onStartUp() 方法。

声明子类 MyServletContainerInitializer

//容器启动的时候会将@HandlesTypes 指定的这个类型下面的子类(实现类,子接口等)传递过来;
//传入感兴趣的类型;
@HandlesTypes(value={HelloService.class})
public class MyServletContainerInitializer implements ServletContainerInitializer 
{

    /**
     * 应用启动的时候,会运行onStartup方法;
     *
     * Set<Class<?>> arg0:感兴趣的类型的所有子类型;
     * ServletContext arg1:代表当前Web应用的ServletContext;一个Web应用一个ServletContext;
     */

    @Override
    public void onStartup(Set<Class<?>> c, ServletContext ctx) throws ServletException {

        System.out.println("感兴趣的类型:");
        for (Class<?> clazz : c) {
            System.out.println(clazz);
        }
    }

}

基于 Maven 项目:

pom.xml 打包的方式:

    <build>
        <resources>
            <resource>
                <directory>src/main/resources</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                    <include>**/*</include>
                </includes>
                <filtering>true</filtering>
            </resource>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.properties</include>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>

测试运行,可以把 HelloService 的子类都打印出来。

三、ServletContext 注册三大组件

注册组件:

(1)使用 ServletContext 注册 Web 组件(Servlet、Filter、Listener);

(2)使用编码的方式,在项目启动的时候给 ServletContext 里面添加组件;

必须在项目启动的时候来添加:

① ServletContainerInitializer 得到的 ServletContext;

② ServletContextListener 得到的 ServletContext;

示例:

//容器启动的时候会将@HandlesTypes 指定的这个类型下面的子类(实现类,子接口等)传递过来;
//传入感兴趣的类型;
@HandlesTypes(value={HelloService.class})
public class MyServletContainerInitializer implements ServletContainerInitializer 
{

    /**
     * 应用启动的时候,会运行onStartup方法;
     *
     * Set<Class<?>> arg0:感兴趣的类型的所有子类型;
     * ServletContext arg1:代表当前Web应用的ServletContext;一个Web应用一个ServletContext;
     *
     * 1)、使用ServletContext注册Web组件(Servlet、Filter、Listener)
     * 2)、使用编码的方式,在项目启动的时候给ServletContext里面添加组件;
     *         必须在项目启动的时候来添加;
     *         1)、ServletContainerInitializer得到的ServletContext;
     *         2)、ServletContextListener得到的ServletContext;
     */

    @Override
    public void onStartup(Set<Class<?>> c, ServletContext ctx) throws ServletException {

        System.out.println("感兴趣的类型:");
        for (Class<?> clazz : c) {
            System.out.println(clazz);
        }

        System.out.println("开始给ServletContext添加组件");

        //添加 servlet 组件
        ServletRegistration.Dynamic servlet = ctx.addServlet("userServlet"new UserServlet());
        //配置servlet的映射信息
        servlet.addMapping("/user");

        //注册Filter  FilterRegistration
        FilterRegistration.Dynamic filter = ctx.addFilter("userFilter", UserFilter.class);
        //配置Filter的映射信息
        filter.addMappingForUrlPatterns(EnumSet.of(DispatcherType.REQUEST), true"/*");

        //注册Listener
        ctx.addListener(UserListener.class);
    }

}

扩展:spring-webmvc 包里面中 spring 启动 web 容器 onStartup 创建 mvc 子容器中也是同样的处理结构

posted on 2021-11-23 14:43  格物致知_Tony  阅读(253)  评论(0编辑  收藏  举报