谈java SPI机制、spring-mvc启动及servlet3.0

96
进击de大黄
2016.09.23 08:29* 字数 1890

主要回顾了java的类加载机制,servlet3.0新特性,java的spi机制,以及spring-mvc的初始化和加载过程。

SpringMVC初始化

之前我使用spring和springMVC的时候都是在web.xml里面定义一个listener org.springframework.web.context.ContextLoaderListener用来初始化spring和一个servlet org.springframework.web.servlet.DispatcherServlet用来初始化springMVC。

我看了下DispatcherServlet的源码初始化流程,如下图DispatcherServlet初始化的时候,会创建一个WebApplicationInitializer。左边三者是一个继承关系。


WebApplicationContext和ApplicationContext有什么不同呢?
前者实现了后者,我们可以配置多个servlet对应不同的mapping,每个servlet会对应一个WebApplicationContext(wac),但是ApplicationContext(ac)只有一个,wac之间可以共享ac里面配置的bean,如共享数据源,缓存等,而且如果不需要这些配置,ac也不是必须的。ac和wc是一个parent-child的层级关系。

随着servlet3.0的到来,web.xml也不是必须的了,我们可以定义一个WebApplicationInitializer来初始化一个WebApplicationContext,下面我讲讲WebApplicationInitializer的加载机制
看下面介绍的<a href="#ServletContext的性能增强"">servlet3对ServletContext的增强</a>可以知道,javaee容器在启动的时候会通过spi机制来寻找javax.servlet.ServletContainerInitializer的实现类,在spring-web jar包,如下图所示

@HandlesTypes(WebApplicationInitializer.class)
public class SpringServletContainerInitializer implements ServletContainerInitializer {

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

        List<WebApplicationInitializer> initializers = new LinkedList<WebApplicationInitializer>();

        if (webAppInitializerClasses != null) {
            for (Class<?> waiClass : webAppInitializerClasses) {
                // Be defensive: Some servlet containers provide us with invalid classes,
                // no matter what @HandlesTypes says...
                if (!waiClass.isInterface() && !Modifier.isAbstract(waiClass.getModifiers()) &&
                        WebApplicationInitializer.class.isAssignableFrom(waiClass)) {
                    try {
                        initializers.add((WebApplicationInitializer) waiClass.newInstance());
                    }
...
}

SpringServletContainerInitializer的onStartup()方法里面有如下一段注释

Because this class declares @HandlesTypes(WebApplicationInitializer.class), Servlet 3.0+ containers will automatically scan the classpath for implementations of Spring's WebApplicationInitializer interface and provide the set of all such types to the webAppInitializerClasses parameter of this method.

因为这个类@HandlesTypes注解的是WebApplicationInitializer.class,Servlet3.0容器会自动的扫描classpath下面WebApplicationInitializer接口的实现类,并提供给SpringServletContainerInitializer的onStartup()方法

SPI机制

SPI的全名是Service Provider Interface,在java.util.ServiceLoader里面有比较详细的介绍。
如jdk提供了java.sql.Driver接口,我们将oracle的驱动包丢入classpath
驱动包目录结构如下,在/META-INF/services/java.sql.Driver文件中有一行内容,
oracle.jdbc.Driver


如下代码jdk提供了服务实现的一个工具类,java.util.ServiceLoader,所以通过这种方式就没必要写Class.forName("oracle.jdbc.OracleDriver")来加载驱动了

ServiceLoader<Driver> d= ServiceLoader.load(Driver.class);
        Iterator<Driver> it = d.iterator();
        while(it.hasNext()){
            Driver dd =it.next();
            System.out.println(dd.toString());//oracle.jdbc.OracleDriver@498e2a42
        }

查看ServiceLoader源码可知,他使用的类加载器是线程上下文类加载器

public static <S> ServiceLoader<S> load(Class<S> service) {
        ClassLoader cl = Thread.currentThread().getContextClassLoader();
        return ServiceLoader.load(service, cl);
    }

服务的提供者,提供了服务的接口实现之后,在jar包的META-INF/services/下面创建一个以服务接口命名的文件,文件内容是提供着实现的接口实现类。

API 和 SPI的区别

API(Application Programming Interface )。在java中,我们使用java提供的很多类、类的方法、数据结构来编写我们的应用程序,最终完成我们需求的程序功能,这里的类、方法、数据结构即是jdk提供的api。api的意义,其实就是这些提供给你完成某项功能的类、接口或者方法。
而SPI(Service Provider Interface)是指一些提供给你继承、扩展,完成自定义功能的类、接口或者方法。

Servlet3.0新特性

目前servlet4还正在开发过程中,目前最新的应该就是3了,最新的spring也用到了很多servlet3.0的特性,所以很有必要了解一下。
新特性概述:

  • 异步处理支持,之前是servlet一直阻塞直到业务完成,现在可以将耗时任务委派给另外一个线程处理,自己不生成相应的情况下返回到容器
  • 新增注解,简化servlet、filter、listener,所以可以无需配置web.xml
  • 可插件支持,类似于开发应用时,将jar包放入classpath

异步处理支持

在web.xml配置<async-supported>true</async-supported>或者在注解里面添加asyncSupported = true

新增注解支持

@WebServlet
声明一个类为servlet,注解在部署时被容器自动处理
WebInitParam
通常配合@WebServlet和@WebFilter使用,类似于web.xml里面的<init-param>标签,指定初始化参数
WebFilter
声明一个类为过滤器
WebListener
声明一个类为监听器,该类必须实现如下最少一个接口

  • ServletContextListener
  • ServletContextAttributeListener
  • ServletRequestListener
  • ServletRequestAttributeListener
  • HttpSessionListener
  • HttpSessionAttributeListener

@MultipartConfig
该注解主要是为了辅助 Servlet 3.0 中 HttpServletRequest 提供的对上传文件的支持。

可插性支持

以配置servlet为例,有三种方式

  1. 最原始的在web.xml里面配置servlet
  2. 使用servlet3.0的@WebServlet注解
  3. 利用可插性,将类继承HttpServlet,然后打成jar包,在jar包的META-INF里面放置一个 web-fragment文件,在文件中声明Servlet配置

我觉得spring可能就是利用了可插性,等有时间验证一下。

ServletContext的性能增强

支持运行时,动态的部署servlet、过滤器、监听器,通过ServletContext的方法实现。
ServletContainerInitializer 也是 Servlet 3.0 新增的一个接口,容器在启动时使用SPI来发现 ServletContainerInitializer 的实现类,并且容器将 WEB-INF/lib 目录下 JAR 包中的类都交给该类的 onStartup() 方法处理,我们通常需要在该实现类上使用 @HandlesTypes 注解来指定希望被处理的类,过滤掉不希望给 onStartup() 处理的类。

Implementations of this interface must be declared by a JAR file resource located inside the META-INF/services directory and named for the fully qualified class name of this interface
这个接口的实现必须打包在一个jar文件里面,并且需要在META-INF/services/通过spi来定义

类加载器

Java源程序经过java编译器编译之后转换成Java字节码,类加载器负责读取Java字节码转换成java.lang.Class类的一个实例,通过实例的new Instance()方法可以创建出该类的一个对象。
系统提供的类加载器

  • 引导类加载器(bootstrap class loader):它用来加载 Java 的核心库,是用原生代码来实现的,并不继承自 java.lang.ClassLoader。
  • 扩展类加载器(extensions class loader):它用来加载 Java 的扩展库。Java 虚拟机的实现会提供一个扩展库目录。该类加载器在此目录里面查找并加载 Java 类。
  • 系统类加载器(system class loader):它根据 Java 应用的类路径(CLASSPATH)来加载 Java 类。一般来说,Java 应用的类都是由它来完成加载的。可以通过 ClassLoader.getSystemClassLoader()来获取它。

加载类的过程
每个java类维护着一个指向它的类加载器的引用,可以通过getClassLoader()来获取。
下面是类加载器的层级关系


Java虚拟机判定两个类相同,不仅要看类的全名是否相同,还要看加载类的类加载器是否相同。
ClassLoaderloadClass()方法里面有下面的代码,类加载器首先代理给父加载器来尝试加载。所以,真正完成类加载的类加载器(defining loader)可能和启动这个加载过程的类加载器(initiating loader)不是同一个。真正完成类加载工作是通过defineClass实现,启动类加载过程是通过loadClass实现。一个类的定义加载器是它引用的其他类的初始加载器。

// 根据名称来加载类
protected Class<?> loadClass(String name, boolean resolve)
        throws ClassNotFoundException {
...
   try {
    if (parent != null) {
    c = parent.loadClass(name, false);
    } else {
    c = findBootstrapClassOrNull(name);
    }
  } catch (ClassNotFoundException e) {
   // ClassNotFoundException thrown if class not found
   // from the non-null parent class loader
  }
...
}

// 根据类的字节码加载类
protected final Class<?> defineClass(String name, byte[] b, int off, int len,
                                         ProtectionDomain protectionDomain)
        throws ClassFormatError{}  

线程上下文类加载器
Thread.currentThread().getContextClassLoader()
context class loader,java应用运行的初始线程上下文加载器是系统类加载器,在线程中运行的代码可以通过此类加载器加载。
例子
SPI机制核心库提供了JDBC的接口,由引导类加载器加载,而JDBC的SPI实现类通常定义在第三方驱动包一般由系统类加载器加载,引导类加载器通过代理无法加载驱动包。所以这种情况就可以通过线程上下文类加载器来加载。

类加载器与web应用

对于运行在 Java EE的web应用来说,每个web应用都会有一个对应的类加载器实例,该类加载器也使用代理模式,不同的是它会首先尝试加载某个类,如果找不到再代理给父类加载器。与一般类加载器相反,这是Servlet规范推荐做法,目的是使Web应用自己的类优先级高于Web容器提供的类。

参考

What is the difference between ApplicationContext and WebApplicationContext in Spring MVC?
WebApplicationInitializer API
深入探讨java类加载器
Servlet 3.0 新特性详解

转自 http://hrps.me/2016/09/22/java-spi-and-servlet-3-spring/

日记本
Web note ad 1