Tomcat中的可插拔以及SCI的實現原理
常用計算機的朋友一定記得， U盤，硬盤等設備流行的時候，當時對于這項技術的介紹是熱插拔。
這個介紹最主要的是想說明這些外接設備的便利性，同時也說明他們的無侵入性。
在 Servlet 3.x 的時候，也增加了這種可插拔的能力，讓我們在項目組織上，可以接近于設備的接入。
例如在 Servlet 3 之前只能在web.xml中聲明 Servlet、Filter 等， 在 Servlet 3 之后，除了 @WebFilter 這種注解的方式外
還可以在單獨的fragement 打包文件，在web-fragement.xml 聲明的組件，容器啟動時就會掃描到。
當然，也可以在運行時動態的添加Servlet/Filter，即Servlet 3.x中的 Dynamic Servlet。
除此之外，對于 SCI 的實現，提供的也是這種能力。通過對標準接口的實現，在特定階段觸發動作執行。
比如我們前面說到的 Spring Boot 的應用，其以 Jar 的方式啟動，來啟動容器，提供服務的實現，就是通過SCI的方式來觸發的。Tomcat 是怎樣處理 SpringBoot應用的?
甚至容器自行的一些組件,如JSP Container的實現，也使用 SCI 的能力來進行實現。
我們本次主要來分析 Tomcat 通過 SCI 實現的這種可插拔性(pluggability)。
首先，什么是 SCI?
全稱 ServletContainerInitializer，是一個用于接收Web 應用在啟動階段通知的接口，再根據通知進行一些編程式的處理，比如動態注冊Servlet、Filter等。
如何使用?
SCI 的使用也比較容易，將實現 ServletContainerInitializer 接口的類增加 HandlesTypes ，注解內指定的一系列類，接口，注解的 class 集合， 會在啟動階段 class 掃描的時候，將與這些 class 相關的 文件都掃描出來，做為 SCI 的onStartup方法參數傳遞。
這一類實現了 SCI 的接口，如果做為獨立的包發布，在打包時，會在 JAR 文件的 META-INF/services/javax.servlet.ServletContainerInitializer 文件中進行注冊。 容器在啟動時，就會掃描所有帶有這些注冊信息的類進行解析，啟動時會調用其 onStartup方法。
這就是可插拔性? 類加載***個表示不服。“我還可以熱替換啊!” 這里是有區別的， 熱替換，類加載，都是根據限定的名稱去加載，并沒有相關的標準去加載未知的內容，而這里SCI則根據約定的標準，掃描META-INF中包含注冊信息的 class 并在啟動階段調用其onStartup，這就是區別啊。
百聞不如一見，光說不練假把式，我們來看除了前面說的 Spring Boot 外，誰還在用SCI。
我們先來看在 Tomcat 關于 WebSocket的實現。
- @HandlesTypes({ServerEndpoint.class, ServerApplicationConfig.class,
- Endpoint.class})
- public class WsSci implements ServletContainerInitiali
這里的HandlesTypes里指明了實現 WebSocket需要關注的幾個類，將通過注解方式聲明WebSocket和通過編程方式聲明都包含了進來。
在應用啟動時，觸發onStartup方法執行，然后初始化WebSocket相關的內容，解析注解等
- public void onStartup(Set<Class<?>> clazzes, ServletContext ctx)
- throws ServletException {
- WsServerContainer sc = init(ctx, true);
- if (clazzes == null || clazzes.size() == 0) {
- return;
- }
- // Group the discovered classes by type
- Set<ServerApplicationConfig> serverApplicationConfigs = new HashSet<>();
- Set<Class<? extends Endpoint>> scannedEndpointClazzes = new HashSet<>();
- Set<Class<?>> scannedPojoEndpoints = new HashSet<>();
這里注意，由于WebSocket并不是為特定應用提供的，而是做為容器的基礎能力提供，并且其是在 Tomcat_home/lib 目錄內，因此，每個應用在啟動時，都會觸發 WebSocket，來解析其是否包含了對于 WebSocket的引用，從而為其提供支持。
這一條流程是如何串連的呢?我們前面的文章曾分析過應用的部署，提到過HostConfig, ContextConfig這些類。 應用在啟動時startup事件會觸發 ContextConfig 這個Listener 的執行，此時會掃描應用包含的JAR文件，解析web-fragement.xml等， 這其中也包含對于SCI實現的解析。
- // Step 11. Apply the ServletContainerInitializer config to the
- // context
- if (ok) {
- for (Map.Entry<ServletContainerInitializer,
- Set<Class<?>>> entry :
- initializerClassMap.entrySet()) {
- if (entry.getValue().isEmpty()) {
- context.addServletContainerInitializer(
- entry.getKey(), null);
- } else {
- context.addServletContainerInitializer(
- entry.getKey(), entry.getValue());
- }
- }
- }
這里解析出來的類會添加到Context中，在應用啟動階段，會調用每個SCI實現的onStartup方法
- // Call ServletContainerInitializers
- for (Map.Entry<ServletContainerInitializer, Set<Class<?>>> entry :
- initializers.entrySet()) {
- try {
- entry.getKey().onStartup(entry.getValue(),
- getServletContext());
- } catch (ServletException e) {
- log.error(sm.getString("standardContext.sciFail"), e);
- ok = false;
- break;
- }
- }
SpringBoot 也是這樣被點燃的
- public void onStartup(ServletContext servletContext) throws ServletException {
- this.logger = LogFactory.getLog(this.getClass());
- WebApplicationContext rootAppContext = this.createRootApplicationContext(servletContext);
- if(rootAppContext != null) {
- servletContext.addListener(new ContextLoaderListener(rootAppContext) {
- public void contextInitialized(ServletContextEvent event) {
- }
- });
- } else {
- this.logger.debug("No ContextLoaderListener registered, as createRootApplicationContext() did not return an application context");
- }
- }
而且 JSP 的容器也開始使用這種方式進行工廠的初始化，以便于后面繼續使用。
- /**
- * Initializer for the Jasper JSP Engine.
- */
- public class JasperInitializer implements ServletContain
那這個Jasper 的SCI，難道就為了初始化一個工廠嗎?這和 Servlet 3.x之前也沒啥區別是吧?
別急，我們繼續看其onStartup方法
- public void onStartup(Set<Class<?>> types, ServletContext context) throws ServletException {
- ...
- // scan the application for TLDs
- TldScanner scanner = newTldScanner(context, true, validate, blockExternal);
- try {
- scanner.scan();
- } catch (IOException | SAXException e) {
- throw new ServletException(e);
- }
原來將 TLD文件的掃描移到了這里， WebContainer 只需要處理web.xml 和 web-fragement.xml的處理即可， JSP 的工作就交給他來做嘛，各司其職，挺好的。用 spec 的話來形容，是更好的分離了 Web Container 和 JSP Container職責。
【本文為51CTO專欄作者“侯樹成”的原創稿件，轉載請通過作者微信公眾號『Tomcat那些事兒』獲取授權】
