自拍偷在线精品自拍偷,亚洲欧美中文日韩v在线观看不卡

Springboot注冊Servlet幾種方式你都知道？內(nèi)部實現(xiàn)原理解析

作者：FastCoder
開發(fā) 前端
本篇介紹在Springboot環(huán)境下Servlet如何被注冊到Servlet容器中。這動態(tài)注冊Servlet的相關(guān)API都是在Servlet3.0規(guī)范中才有的。

[[410292]]

環(huán)境：springboot2.3.9.RELEASE

1 Servlet注冊

方式1：

在配置類(啟動類)上添加@ServletComponentScan注解

  1. @SpringBootApplication 
  2. @ServletComponentScan 
  3. public class SpringBootComprehensiveApplication 
  4. } 

Servlet類上添加@WebServlet注解接口

  1. @WebServlet("/hello") 
  2. public class MyServlet extends HttpServlet { 
  3. }     

對應(yīng)的Filter， Linstener有：@WebFilter, @WebListener

方式2：

通過向IOC容器添加ServletRegistrationBean方式;該種方式可以在Servlet中注入其它Bean或者讀取application.properties配置信息等。對應(yīng)的filter, Listener有對應(yīng)的bean;FilterRegistrationBean,ServletListenerRegistrationBean

  1. @Bean 
  2. public ServletRegistrationBean<MyServlet> servlet() { 
  3.   ServletRegistrationBean<MyServlet> servlet = new ServletRegistrationBean<>(new MyServlet()) ; 
  4.   servlet.addUrlMappings("/hello") ;  
  5.   return servlet ; 
  6. } 

 方式3：

動態(tài)注冊Servlet

  1. @Component 
  2. public class DynamicRegServlet implements ServletContextInitializer { 
  3.  
  4.   @Override 
  5.   public void onStartup(ServletContext servletContext) throws ServletException { 
  6.     ServletRegistration initServlet = servletContext.addServlet("myServlet", MyServlet.class) ; 
  7.     initServlet.addMapping("/hello") ; 
  8.   } 
  9.  
  10. } 

 該種方式是利用的Servlet3.0開始才有的功能，通過SPI技術(shù)在容器啟動的時候做一些初始化工作，比如注冊Servlet等。在Servle規(guī)范中通過

ServletContainerInitializer實現(xiàn)該功能。

該Servlet規(guī)范的開發(fā)流程如下;

2、配置

ServletContainerInitializer

在src/META-INF/services下新建

javax.servlet.ServletContainerInitializer文件，文件內(nèi)容為ServletContainerInitializer接口的實現(xiàn)類(完整的包名+類名)如下：

  1. com.pack.container.config.CustomServletInitializer 

CustomServletInitializer類

  1. @HandlesTypes({ScoreWebInit.class}) 
  2. public class CustomServletInitializer implements ServletContainerInitializer { 
  3.   @Override 
  4.   public void onStartup(Set<Class<?>> c, ServletContext ctx) throws ServletException { 
  5.     c.forEach(web -> { 
  6.       try { 
  7.         ((ScoreWebInit)web.newInstance()).pay() ; 
  8.       } catch (InstantiationException e) { 
  9.         e.printStackTrace(); 
  10.       } catch (IllegalAccessException e) { 
  11.         e.printStackTrace(); 
  12.       } 
  13.     }); 
  14.     ServletRegistration.Dynamic reg = ctx.addServlet("MyServlet", com.pack.servlet.MyServlet.class) ; 
  15.     reg.setLoadOnStartup(1) ; 
  16.     reg.addMapping("/hello") ; 
  17.   } 
  18. } 

注意：@HandlesTypes該注解會把屬性value配置的值(ScoreWebInt.class)對應(yīng)的所有類都收集上然后在onStartup方法中的Set 集合中應(yīng)用。

在spring-web-xxxx.jar下就有通過該技術(shù)實現(xiàn)的相應(yīng)功能。

3 掃描Servlet實現(xiàn)原理

在方式1中的實現(xiàn)原理就是掃描類路徑下所有@WebServlet，@WebFilter，@WebListener。找到所有的類后再通過方式2的方式進行注冊。下面將核心源碼貼出

3.1 導(dǎo)入核心類

  1. // 該注解如果沒有配置basePackages或者basePackageClasses屬性，那么會讀取當(dāng)前添加@ServletComponentScan注解的類的包路徑進行掃描。 
  2. @Target(ElementType.TYPE) 
  3. @Retention(RetentionPolicy.RUNTIME) 
  4. @Documented 
  5. @Import(ServletComponentScanRegistrar.class) 
  6. public @interface ServletComponentScan { 
  7. } 
  8. // 注冊BeanDefinition 
  9. class ServletComponentScanRegistrar implements ImportBeanDefinitionRegistrar{ 
  10.   public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) { 
  11.     Set<String> packagesToScan = getPackagesToScan(importingClassMetadata); 
  12.     if (registry.containsBeanDefinition(BEAN_NAME)) { 
  13.       updatePostProcessor(registry, packagesToScan); 
  14.     } else { 
  15.       // 當(dāng)前容器中沒有對應(yīng)的Bean時執(zhí)行該方法   
  16.       addPostProcessor(registry, packagesToScan); 
  17.     } 
  18.   } 
  19. } 

3.2 注冊BeanFactory 處理器

ServletComponentScanRegistrar最核心的功能就是注冊BeanFactoryPostProcessor

  1. class ServletComponentScanRegistrar implements ImportBeanDefinitionRegistrar{ 
  2.   private void addPostProcessor(BeanDefinitionRegistry registry, Set<String> packagesToScan) { 
  3.     GenericBeanDefinition beanDefinition = new GenericBeanDefinition(); 
  4.     beanDefinition.setBeanClass(ServletComponentRegisteringPostProcessor.class); 
  5.     beanDefinition.getConstructorArgumentValues().addGenericArgumentValue(packagesToScan); 
  6.     beanDefinition.setRole(BeanDefinition.ROLE_INFRASTRUCTURE); 
  7.     registry.registerBeanDefinition(BEAN_NAME, beanDefinition); 
  8.   } 
  9. } 

3.3 實例化掃描組件

進入

ServletComponentRegisteringPostProcessor類中首先這個類有個static代碼塊

  1. class ServletComponentRegisteringPostProcessor implements BeanFactoryPostProcessor, ApplicationContextAware { 
  2.   private static final List<ServletComponentHandler> HANDLERS; 
  3.   static { 
  4.     List<ServletComponentHandler> servletComponentHandlers = new ArrayList<>(); 
  5.     servletComponentHandlers.add(new WebServletHandler()); 
  6.     servletComponentHandlers.add(new WebFilterHandler()); 
  7.     servletComponentHandlers.add(new WebListenerHandler()); 
  8.     HANDLERS = Collections.unmodifiableList(servletComponentHandlers); 
  9.   } 
  10. }     

這段代碼分別是添加相應(yīng)Servlet, Filter, Listener的處理句柄，分別處理@WebServlet，@WebFilter，@WebListener 注解。

查看WebServletHandler

  1. class WebServletHandler extends ServletComponentHandler { 
  2.   WebServletHandler() { 
  3.     super(WebServlet.class); 
  4.   } 
  5.   // 看到該方法也就十分清楚了最終找到所有的Class以后，通過ServletRegistrationBean進行注冊為Bean 
  6.   @Override 
  7.   public void doHandle(Map<String, Object> attributes, AnnotatedBeanDefinition beanDefinition,BeanDefinitionRegistry registry) { 
  8.     BeanDefinitionBuilder builder = BeanDefinitionBuilder.rootBeanDefinition(ServletRegistrationBean.class); 
  9.     builder.addPropertyValue("asyncSupported", attributes.get("asyncSupported")); 
  10.     builder.addPropertyValue("initParameters", extractInitParameters(attributes)); 
  11.     builder.addPropertyValue("loadOnStartup", attributes.get("loadOnStartup")); 
  12.     String name = determineName(attributes, beanDefinition); 
  13.     builder.addPropertyValue("name", name); 
  14.     builder.addPropertyValue("servlet", beanDefinition); 
  15.     builder.addPropertyValue("urlMappings", extractUrlPatterns(attributes)); 
  16.     builder.addPropertyValue("multipartConfig", determineMultipartConfig(beanDefinition)); 
  17.     registry.registerBeanDefinition(name, builder.getBeanDefinition()); 
  18.   } 
  19.   // other code 
  20. }     
  21. // 父類ServletComponentHandler;在父類總添加相應(yīng)的過濾器（分別查找相應(yīng)注解的類,@WebServlet等。） 
  22. abstract class ServletComponentHandler { 
  23.   private final Class<? extends Annotation> annotationType; 
  24.   private final TypeFilter typeFilter; 
  25.   protected ServletComponentHandler(Class<? extends Annotation> annotationType) { 
  26.     this.typeFilter = new AnnotationTypeFilter(annotationType); 
  27.     this.annotationType = annotationType; 
  28.   } 
  29. } 

 接下來執(zhí)行BeanFactoryPostProcessor對應(yīng)的回調(diào)方法了

  1. class ServletComponentRegisteringPostProcessor implements BeanFactoryPostProcessor, ApplicationContextAware { 
  2.   @Override 
  3.   public void postProcessBeanFactory(ConfigurableListableBeanFactory beanFactory) throws BeansException { 
  4.     if (isRunningInEmbeddedWebServer()) { 
  5.       ClassPathScanningCandidateComponentProvider componentProvider = createComponentProvider(); 
  6.       for (String packageToScan : this.packagesToScan) { 
  7.         scanPackage(componentProvider, packageToScan); 
  8.       } 
  9.     } 
  10.   } 
  11. } 

createComponentProvider方法進行創(chuàng)建掃描相應(yīng)符合條件的Bean掃描類

  1. private ClassPathScanningCandidateComponentProvider createComponentProvider() { 
  2.   ClassPathScanningCandidateComponentProvider componentProvider = new ClassPathScanningCandidateComponentProvider(false); 
  3.   componentProvider.setEnvironment(this.applicationContext.getEnvironment()); 
  4.   componentProvider.setResourceLoader(this.applicationContext); 
  5.   for (ServletComponentHandler handler : HANDLERS) { 
  6.     componentProvider.addIncludeFilter(handler.getTypeFilter()); 
  7.   } 
  8.   return componentProvider; 
  9. } 

在該方法中為當(dāng)前的

ClassPathScanningCandidateComponentProvider類掃描設(shè)置過濾器;過濾器在上面的static靜態(tài)代碼塊中已經(jīng)設(shè)置了WebServletHandler，WebFilterHandler，WebListenerHandler在父類中分別創(chuàng)建不同注解的new AnnotationTypeFilter(annotationType)過濾類。

創(chuàng)建完類掃描類以后開始掃描通過該類掃描相應(yīng)包(路徑)下的所有類文件 檢查是否有對應(yīng)的注解。

3.4 查找及注冊Bean

  1. class ServletComponentRegisteringPostProcessor implements BeanFactoryPostProcessor, ApplicationContextAware { 
  2.   private void scanPackage(ClassPathScanningCandidateComponentProvider componentProvider, String packageToScan) { 
  3.     for (BeanDefinition candidate : componentProvider.findCandidateComponents(packageToScan)) { 
  4.       if (candidate instanceof AnnotatedBeanDefinition) { 
  5.         for (ServletComponentHandler handler : HANDLERS) { 
  6.           handler.handle(((AnnotatedBeanDefinition) candidate), (BeanDefinitionRegistry) this.applicationContext); 
  7.         } 
  8.       } 
  9.     } 
  10.   } 
  11. } 

findCandidateComponents方法查找候選的(符合條件)的類并實例化為BeanDefinition對象。

方法執(zhí)行鏈findCandidateComponents ---》scanCandidateComponents

在scanCandidateComponents方法中查找符合條件的類，然后實例化為BeanDefinition

  1. public class ClassPathScanningCandidateComponentProvider implements EnvironmentCapable, ResourceLoaderAware { 
  2.   private Set<BeanDefinition> scanCandidateComponents(String basePackage) { 
  3.     Set<BeanDefinition> candidates = new LinkedHashSet<>(); 
  4.     MetadataReader metadataReader = getMetadataReaderFactory().getMetadataReader(resource); 
  5.     if (isCandidateComponent(metadataReader)) { 
  6.       ScannedGenericBeanDefinition sbd = new ScannedGenericBeanDefinition(metadataReader); 
  7.       sbd.setSource(resource); 
  8.       if (isCandidateComponent(sbd)) { 
  9.         candidates.add(sbd); 
  10.       } 
  11.     } 
  12.     return candidates; 
  13.   } 
  14.   protected boolean isCandidateComponent(MetadataReader metadataReader) throws IOException { 
  15.     for (TypeFilter tf : this.excludeFilters) { 
  16.       if (tf.match(metadataReader, getMetadataReaderFactory())) { 
  17.         return false; 
  18.       } 
  19.     } 
  20.     for (TypeFilter tf : this.includeFilters) { 
  21.       if (tf.match(metadataReader, getMetadataReaderFactory())) { 
  22.         return isConditionMatch(metadataReader); 
  23.       } 
  24.     } 
  25.     return false; 
  26.   } 
  27. } 

在第二個for開始匹配所有的類是否有相關(guān)的注解。如果匹配上就相應(yīng)的創(chuàng)建BeanDefinition對象放入集合Set中。

查找到所有的類以后分別調(diào)用相應(yīng)的Web*Handler(ServletComponentHandler)進行注冊Bean。

返回到上面的scanPackage方法中執(zhí)行handler.handle方法。

  1. abstract class ServletComponentHandler { 
  2.   void handle(AnnotatedBeanDefinition beanDefinition, BeanDefinitionRegistry registry) { 
  3.     Map<String, Object> attributes = beanDefinition.getMetadata().getAnnotationAttributes(this.annotationType.getName()); 
  4.     if (attributes != null) { 
  5.       doHandle(attributes, beanDefinition, registry); 
  6.     } 
  7.   } 
  8. } 

doHandle方法分別在子類(WebServletHandler，WebFilterHandler，WebListenerHandler)中實現(xiàn)，如上面已經(jīng)提到的WebServletHandler類的doHandler方法。

到這里我們知道了注解的方式最終也是被注冊為ServletRegistrationBean 實例。那這個ServletRegistrationBean又是如何被容器(Tomcat)所感知的呢?

3.5 Tomcat注冊Servlet

在Web容器下 BeanFactory使用的是

AnnotationConfigServletWebServerApplicationContext

Spring IOC容器核心方法是refresh方法

  1. public abstract class AbstractApplicationContext extends DefaultResourceLoader implements ConfigurableApplicationContext { 
  2.   public void refresh() throws BeansException, IllegalStateException { 
  3.     synchronized (this.startupShutdownMonitor) { 
  4.       try { 
  5.         // Initialize other special beans in specific context subclasses. 
  6.         onRefresh(); 
  7.       } catch (BeansException ex) { 
  8.         throw ex; 
  9.       } finally { 
  10.         resetCommonCaches(); 
  11.       } 
  12.     } 
  13.   } 
  14. }     

這里只留了onRefresh方法，進入該方法：

onRefresh會進入到子類的方法

  1. public class ServletWebServerApplicationContext extends GenericWebApplicationContext implements ConfigurableWebServerApplicationContext { 
  2.   protected void onRefresh() { 
  3.     super.onRefresh(); 
  4.     try { 
  5.       createWebServer(); 
  6.     } catch (Throwable ex) { 
  7.       throw new ApplicationContextException("Unable to start web server", ex); 
  8.     } 
  9.   } 
  10. }     

 進入createWebServer方法

  1. public class ServletWebServerApplicationContext extends GenericWebApplicationContext implements ConfigurableWebServerApplicationContext { 
  2.   private void createWebServer() { 
  3.     WebServer webServer = this.webServer; 
  4.     ServletContext servletContext = getServletContext(); 
  5.     if (webServer == null && servletContext == null) { 
  6.       ServletWebServerFactory factory = getWebServerFactory(); 
  7.       this.webServer = factory.getWebServer(getSelfInitializer()); 
  8.       getBeanFactory().registerSingleton("webServerGracefulShutdown",new WebServerGracefulShutdownLifecycle(this.webServer)); 
  9.       getBeanFactory().registerSingleton("webServerStartStop", new WebServerStartStopLifecycle(this, this.webServer)); 
  10.     } else if (servletContext != null) { 
  11.       try { 
  12.         getSelfInitializer().onStartup(servletContext); 
  13.       } catch (ServletException ex) { 
  14.         throw new ApplicationContextException("Cannot initialize servlet context", ex); 
  15.       } 
  16.     } 
  17.     initPropertySources(); 
  18.   } 
  19. }  

這里會進入factory.getWebServer(getSelfInitializer())方法執(zhí)行

進入getSelfInitializer()方法

  1. public class ServletWebServerApplicationContext extends GenericWebApplicationContext implements ConfigurableWebServerApplicationContext { 
  2.   private org.springframework.boot.web.servlet.ServletContextInitializer getSelfInitializer() { 
  3.     return this::selfInitialize; 
  4.   } 
  5.  
  6.   private void selfInitialize(ServletContext servletContext) throws ServletException { 
  7.     prepareWebApplicationContext(servletContext); 
  8.     registerApplicationScope(servletContext); 
  9.     WebApplicationContextUtils.registerEnvironmentBeans(getBeanFactory(), servletContext); 
  10.     for (ServletContextInitializer beans : getServletContextInitializerBeans()) { 
  11.       beans.onStartup(servletContext); 
  12.     } 
  13.   } 
  14. } 

這里的for循環(huán)是遍歷當(dāng)前容器中所有ServletContextInitializer類型的Bean。ServletRegistrationBean就是繼承ServletContextInitializer

到這里分別調(diào)用ServletContextInitializer的onStartup方法，進入onStartup方法：

  1. public abstract class RegistrationBean implements ServletContextInitializer, Ordered { 
  2.   @Override 
  3.   public final void onStartup(ServletContext servletContext) throws ServletException { 
  4.     String description = getDescription(); 
  5.     if (!isEnabled()) { 
  6.       logger.info(StringUtils.capitalize(description) + " was not registered (disabled)"); 
  7.       return; 
  8.     } 
  9.     register(description, servletContext); 
  10.   } 
  11.   // 在子類中實現(xiàn)   
  12.   protected abstract void register(String description, ServletContext servletContext);   
  13. } 

進入子類DynamicRegistrationBean

  1. public abstract class DynamicRegistrationBean<D extends Registration.Dynamic> extends RegistrationBean { 
  2.   @Override 
  3.   protected final void register(String description, ServletContext servletContext) { 
  4.     D registration = addRegistration(description, servletContext); 
  5.     if (registration == null) { 
  6.       logger.info(StringUtils.capitalize(description) + " was not registered (possibly already registered?)"); 
  7.       return; 
  8.     } 
  9.     // 配置Servlet Mapping相關(guān)的信息（在子類ServletRegistrationBean中實現(xiàn)的）   
  10.     configure(registration); 
  11.   } 
  12.   // 子類中實現(xiàn) 
  13.   protected abstract D addRegistration(String description, ServletContext servletContext); 
  14. } 

 進入子類ServletRegistrationBean

  1. public class ServletRegistrationBean<T extends Servlet> extends DynamicRegistrationBean<ServletRegistration.Dynamic> { 
  2.   @Override 
  3.   protected ServletRegistration.Dynamic addRegistration(String description, ServletContext servletContext) { 
  4.     String name = getServletName(); 
  5.     return servletContext.addServlet(name, this.servlet); 
  6.   } 
  7. } 

 到這里就是通過ServletContext來動態(tài)注冊Servlet(Servilet3.0)。

這里返回了

ServletRegistration.Dynamic對象會繼續(xù)執(zhí)行configure方法配置urlMapping等信息。

  1. public class ServletRegistrationBean<T extends Servlet> extends DynamicRegistrationBean<ServletRegistration.Dynamic> { 
  2.   @Override 
  3.   protected void configure(ServletRegistration.Dynamic registration) { 
  4.     super.configure(registration); 
  5.     String[] urlMapping = StringUtils.toStringArray(this.urlMappings); 
  6.     if (urlMapping.length == 0 && this.alwaysMapUrl) { 
  7.       urlMapping = DEFAULT_MAPPINGS; 
  8.     } 
  9.     if (!ObjectUtils.isEmpty(urlMapping)) { 
  10.       registration.addMapping(urlMapping); 
  11.     } 
  12.     registration.setLoadOnStartup(this.loadOnStartup); 
  13.     if (this.multipartConfig != null) { 
  14.       registration.setMultipartConfig(this.multipartConfig); 
  15.     } 
  16.   } 
  17. } 

到此在Springboot環(huán)境下Servlet如何被注冊到Servlet容器中就已經(jīng)清晰了。這動態(tài)注冊Servlet的相關(guān)API都是在Servlet3.0規(guī)范中才有的。

 

責(zé)任編輯：姜華 來源： 今日頭條
SpringbootServlet容器
相關(guān)推薦

2024-05-10 07:44:23

C#進程程序

2021-05-07 16:19:36

異步編程Java線程

2024-02-26 08:04:38

ReactReact.js場景

2025-01-21 10:04:40

Java并發(fā)阻塞隊列

2022-05-27 06:57:50

Python循環(huán)方式生成器

2024-02-05 12:08:07

線程方式管理

2021-08-05 07:28:25

Java實現(xiàn)方式

2023-04-28 12:37:59

Spring@Bean使用方式

2023-04-23 09:50:50

@BeanSpring

2023-06-08 08:06:07

error錯誤頁原理

2018-02-08 09:04:58

Nginx404頁面方法

2020-09-07 08:00:48

2019-07-23 15:56:56

Spring Boot部署servlet

2023-10-30 11:53:37

繼承JS父類

2019-07-23 17:52:59

Spring BootJava開發(fā)

2023-02-28 09:07:18

ChatGPTAI

2023-10-30 09:35:01

注冊中心微服務(wù)

2024-04-24 11:24:43

C#數(shù)據(jù)去重

2024-06-12 08:05:06

2024-11-04 09:39:08

Java?接口Thread?類
點贊
收藏

51CTO技術(shù)棧公眾號