这这里首先说明下什么是java的SPI机制:
spi 的英文全称:Service Provider Interface 单从字面可以理解为Service提供者接口,正如从SPI的名字去理解SPI就是Service提供者接口;我对SPI的定义:提供给服务提供厂商与扩展框架功能的开发者使用的接口。通俗来讲:就是java 自从javaservlet3.0版本之后提供了一种接口用于和具体实现做分离,而各个服务提供商可以根据接口规范来实现自己的服务! 很多框架都使用了java的SPI机制,如java.sql.Driver的SPI实现(MySQL驱动、oracle驱动等)、common-logging的日志接口实现、dubbo的扩展实现等等框架
SPI的具体规范:
从java servlet3.0规范之后,有一个 共享库 / 运行时可插拔性 的特性,就是说在不更改原有代码的基础上,通过增加jar包的方式来增加服务,可以通过删除jar包的方式来删除服务! 那么,java 是怎么做的呢,
规范中有一个特殊的接口:ServletContainerInitializer 。具体的使用:框架提供的 ServletContainerInitializer 实现必须绑定在 jar 包 的 META-INF/services 目录中的一个叫做 javax.servlet.ServletContainerInitializer 的文件, 指ServletContainerInitializer 的实现。
也就是说,在META-INF/services 下的【javax.servlet.ServletContainerInitializer】(这个是完整的文件名,而且必须是这个文件名) 文件中指明是ServletContainerInitializer接口的具体限制的类路径,可以是com.test.ServletContainerInitializerImpi 一行文本!
这里的疑问是: 谁去读取这个文件去做制定的加载呢?
很简单,根据规范,这个是需要java 容器去实现的,比如说常用的tomcat,容器在启动的时候负责解析jar包,容器负责初始化出来一个实例, 然后去执行实现类的:onStartup 方法
这个在说下和此类配合使用的一个注解:
@HandlesTypes
在 ServletContainerInitializer 实现上的HandlesTypes 注解用于表示感兴趣的一些类,它们可能指定了 HandlesTypes 的 value 中的注解(类型、方法或自动级别的注解),或者是其类型的超类继承/实现了这些类之一。无论是否设置了 metadata-complete,HandlesTypes 注解将应用。
在任何 Servlet Listener 的事件被触发之前,当应用正在启动时,ServletContainerInitializer 的 onStartup 方法将被调用。
ServletContainerInitializer’s 的 onStartup 得到一个类的 Set,其或者继承/实现 initializer 表示感兴趣的类,或者它是使用指定在@HandlesTypes 注解中的任意类注解的。
具体使用:
最经典的使用,大家可以参考我的另一篇文章:spring boot 到底是怎么启动的?