Servlet3.0的spi技术的使用功能依赖流程第一步在类路径下创建META-INF/service/javax.servlet.ServletContainerInitializer第二步实现接口ServletContainerInitializer

69 阅读 0 评论 46 点赞

我是靠谱客的博主繁荣硬币，最近开发中收集的这篇文章主要介绍Servlet3.0的spi技术的使用功能依赖流程第一步在类路径下创建META-INF/service/javax.servlet.ServletContainerInitializer第二步实现接口ServletContainerInitializer，觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

功能

不使用任何注解，自动的把Servlet加载，把监听器过滤器添加到服务器中

依赖

    <dependency>
      <groupId>javax.servlet</groupId>
      <artifactId>javax.servlet-api</artifactId>
      <version>4.0.1</version>
      <scope>provided</scope>
    </dependency>

流程

tomcat启动时去jar文件类路径下的META-INF/service/javax.servlet.ServletContainerInitializer读取内部的内容（要在服务器启动时要加载的类的全限定名），找到该类后如果该类实现了ServletContainerInitializer接口，则自动调用其onStartup()方法。

tomcat启动时加载类，servlet3.0之后通过spi提供服务接口给外部扩展使用
需要在类路径下创建META-INF/service/javax.servlet.ServletContainerInitializer
该文件中内容为自定义的类的全限定名com.entor.init.EntonServletContainerInitializer
如果需要扩展其他接口配置注解@HandlesTypes({接口.class})使用，会自动把该接口下的所有实现类注入到onStartup方法的set形参中

第一步在类路径下创建META-INF/service/javax.servlet.ServletContainerInitializer

在这里插入图片描述
注意文件内容写要启动的类的全限定名

第二步实现接口ServletContainerInitializer

tomcat在读取INF/service/javax.servlet.ServletContainerInitializer的内容时，找到我们要启动的类，如果我门的类实现了ServletContainerInitializer，则自动调用里边的onStartup()方法。

@HandlesTypes注解，里边放入接口的字节码内容，然后把该接口的实现类全部放入set中。

package com.entor.init;

import com.entor.app.Entor;
import com.entor.filter.EncodingFilter;
import com.entor.listener.MyListener;
import com.entor.servlet.UserServlet;

import javax.servlet.*;
import javax.servlet.annotation.HandlesTypes;
import java.util.EnumSet;
import java.util.Set;


//tomcat启动时加载类，servlet3.0之后通过spi提供服务接口给外部扩展使用
//需要在类路径下创建META-INF/service/javax.servlet.ServletContainerInitializer
//该文件中内容为自定义的类的全限定名com.entor.init.EntonServletContainerInitializer
//如果需要扩展其他接口配置注解@HandlesTypes({接口.class})使用，会自动把该接口下的所有实现类注入到onStartup方法的set形参中
@HandlesTypes({Entor.class})
public class EntonServletContainerInitializer implements ServletContainerInitializer {
    /**
     *
     * @param set @HandlesTypes({Entor.class})标注了的实现类
     * @param servletContext
     * @throws ServletException
     */
    @Override
    public void onStartup(Set<Class<?>> set, ServletContext servletContext) throws ServletException {
        System.out.println("服务器启动初始化操作");
        if (set!=null&&set.size()>0){
            set.stream().forEach(cls->{
                System.out.println(cls.getSimpleName());
                try {
                    Entor o = (Entor)cls.newInstance();
                    o.onStartup();
                } catch (InstantiationException e) {
                    e.printStackTrace();
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                }
            });
        }

        //注入Servlet
        ServletRegistration.Dynamic userServlet = servletContext.addServlet("UserServlet", UserServlet.class);
        userServlet.addMapping("/user");
        //注入Filter
        FilterRegistration.Dynamic encodingFilter = servletContext.addFilter("EncodingFilter", EncodingFilter.class);
        encodingFilter.addMappingForUrlPatterns(EnumSet.of(DispatcherType.REQUEST),true,"/*");
        //注入Listener
        servletContext.addListener(MyListener.class);
    }
}

加载的servlet

public class UserServlet extends HttpServlet {
    @Override
    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        System.out.println("service");
    }
}

注入的过滤器


public class EncodingFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("过滤器初始化");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        filterChain.doFilter(servletRequest,servletResponse);
        System.out.println("过滤器放行");
    }

    @Override
    public void destroy() {
        System.out.println("过滤器销毁");
    }
}

注入的监听器


public class MyListener implements ServletContextListener {

    @Override
    public void contextInitialized(ServletContextEvent sce) {
        System.out.println("监听器初始化");
    }

    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        System.out.println("监听器销毁");
    }
}