SPI 笔记

SPI

---

基本用法

类路径 /META-INF/services/ 文件夹下，创建文件名为接口全限定名的文件，文件中填写接口的实现类。

通过 ServiceLoader 能够进行加载

Tomcat

基本用法

1. 创建 classpath:/META-INF/services/javax.servlet.ServletContainerInitializer 文件

2. 编写 ServletContainerInitializer 实现类，并用 @HandlesTypes 注解

@HandlesTypes(value = {Fruit.class})
public class FruitInitializer implements ServletContainerInitializer {
	@Override
	public void onStartup(Set<Class<?>> c, ServletContext ctx) throws ServletException {
	}
}

说明：@HandlesTypes 的 value 指 Tomcat 会收集所有的 Fruit 实现类并形成 Set，之后会传入 onStartup() 方法进行调用

Spring

spring-web 包中 /META-INF/services/javax.servlet.ServletContainerInitializer 仅有一行 org.springframework.web.SpringServletContainerInitializer

查看 SpringServletContainerInitializer，注解告诉我们它收集 WebApplicationInitializer 的实现类并调用 onStartup()

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

区别几个 Initializer：

• ServletContainerInitializer

Tomcat 为 SPI 提供的。

• SpringServletContainerInitializer

spring-web 提供，是 ServletContainerInitializer 的子类，收集 WebApplicationInitializer 实现类。

• WebApplicationInitializer

SpringServletContainerInitializer 收集的接口

• ServletContextInitializer

用于内嵌 Tomcat 容器的接口