SpringBoot中Filter bean如何添加到Servlet容器

 更新时间:2023年08月04日 15:06:32   作者:yagefuma  
这篇文章主要介绍了SpringBoot中Filter bean是怎么被添加到Servlet容器中的,本文分步骤结合实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下

对于Spring Boot的IOC容器——ServletWebServerApplicationContext,其中的Filter bean,每个Filter bean都会被独立的注册成为Servlet的Filter。大概的注册过程分成2步:

  • IOC容器——ServletWebServerApplicationContext将Filter接口的实现类封装成FilterRegistrationBean,放到ServletContextInitializerBeans实例的成员变量initializers变量(LinkedMultiValueMap)中
  • Spring 容器(ServletWebServerApplicationContext)从ServletContextInitializerBeans实例的成员变量initializers变量(LinkedMultiValueMap),中获取所有的ServletContextInitializer实现类,调用它们的onStartUp函数,FilterRegistrationBean的onStartup函数就是在调用ServletContext的addFilter函数向Servlet添加Filter

1. IOC容器——ServletWebServerApplicationContext将Filter接口的实现类封装成FilterRegistrationBean,放到ServletContextInitializerBeans实例的成员变量initializers变量(LinkedMultiValueMap)中

1.Spring容器——ServletWebServerApplicationContext的refresh()函数被调用。

protected void onRefresh() {
    super.onRefresh();    
    try {
       createWebServer();    
       }
    catch (Throwable ex) {
       throw new ApplicationContextException("Unable to start web server", ex);   
    }
}

2.ServletWebServerApplicationContext的createWebServer()函数,

  • 在函数中会调用getSelfInitializer()函数获取所有的ServletContextInitializer实例,
  • 而获取所有的ServletContextInitializer实例的过程中,会查找所有实现了Filter接口的bean,并注册成FilterRegistrationBean(实现了ServletContextInitializer接口,所以也属于ServletContextInitializer实例),
  • 然后把FilterRegistrationBean放到initializers变量(LinkedMultiValueMap)中
private void createWebServer() {
    WebServer webServer = this.webServer;    
    ServletContext servletContext = getServletContext();    
    if (webServer == null && servletContext == null) {
       StartupStep createWebServer = this.getApplicationStartup().start("spring.boot.webserver.create");       
       ServletWebServerFactory factory = getWebServerFactory();       
       createWebServer.tag("factory", factory.getClass().toString());  
       //  getSelfInitializer()函数中获取所有ServletContextInitializer实例,调用onStartup方法完成注册
       this.webServer = factory.getWebServer(getSelfInitializer());
       ......
}
private org.springframework.boot.web.servlet.ServletContextInitializer getSelfInitializer() {
    return this::selfInitialize;
    }
private void selfInitialize(ServletContext servletContext) throws ServletException {
    prepareWebApplicationContext(servletContext);    
    registerApplicationScope(servletContext);    
    WebApplicationContextUtils.registerEnvironmentBeans(getBeanFactory(), servletContext);  
    //   获取所有ServletContextInitializer实例,调用onStartup方法
    for (ServletContextInitializer beans : getServletContextInitializerBeans()) {
       beans.onStartup(servletContext);   
        }
}
// 传入BeanFactory,new 一个ServletContextInitializerBeans对象,这个对象实现了Collection接口,是一个集合,
// 集合内的元素是需要内置在Servlet Context上的ServletContextInitializer bean
protected Collection<ServletContextInitializer> getServletContextInitializerBeans() {
    return new ServletContextInitializerBeans(getBeanFactory());
    }

3.ServletContextInitializerBeans的构建

public ServletContextInitializerBeans(ListableBeanFactory beanFactory,       Class<? extends ServletContextInitializer>... initializerTypes) {
    this.initializers = new LinkedMultiValueMap<>();    
    this.initializerTypes = (initializerTypes.length != 0) ? Arrays.asList(initializerTypes)
          : Collections.singletonList(ServletContextInitializer.class);    
     // 找直接定义为ServletContextInitializer的bean(比如FilterRegistrationBean),DelegatingFilterProxyRegistrationBean等,
     // 添加到initializers中
    addServletContextInitializerBeans(beanFactory);    
     // 找实现了Filter接口的bean,将他们封装成ServletContextInitializer bean(对于Filter的实现类也就是封装成FilterRegistrationBean),
     // 添加到initializers中
    addAdaptableBeans(beanFactory);   
    //排序  
    List<ServletContextInitializer> sortedInitializers = this.initializers.values().stream()
          .flatMap((value) -> value.stream().sorted(AnnotationAwareOrderComparator.INSTANCE))
          .collect(Collectors.toList());    
          this.sortedList = Collections.unmodifiableList(sortedInitializers);    
          logMappings(this.initializers);
}
protected void addAdaptableBeans(ListableBeanFactory beanFactory) {
    MultipartConfigElement multipartConfig = getMultipartConfig(beanFactory);    
    // 获取实现了Servlet接口的bean
    addAsRegistrationBean(beanFactory, Servlet.class, new ServletRegistrationBeanAdapter(multipartConfig)); 
    // 查找所有实现了Filter接口的bean,并注册成FilterRegistrationBean,
    // 然后把FilterRegistrationBean放到initializers变量(LinkedMultiValueMap)中
    addAsRegistrationBean(beanFactory, Filter.class, new FilterRegistrationBeanAdapter());    
    for (Class<?> listenerType : ServletListenerRegistrationBean.getSupportedTypes()) {
       addAsRegistrationBean(beanFactory, EventListener.class, (Class<EventListener>) listenerType,             
                 new ServletListenerRegistrationBeanAdapter());    
       }
}

所以我们可以看到ServletContextInitializerBeans构造函数是怎么构造一个包含
ServletContextInitializer bean集合的:

  • 直接定义为ServletContextInitializer的bean(比如FilterRegistrationBean)
  • DelegatingFilterProxyRegistrationBean等,添加到initializers中
    找实现了Filter接口的bean,将他们封装成ServletContextInitializer bean(对于Filter的实现类也就是封装成FilterRegistrationBean),添加到initializers中
  • 排序然后一并返回

所以ServletContextInitializerBeans实例表示的是:一个从ListableBeanFactory bean容器中获得的ServletContextInitializer实例的集合。这个集合中的每个元素来自容器中定义的每个如下类型的bean :

  • 实现了ServletContextInitializer接口的bean
  • 具体可能以ServletRegistrationBean/FilterRegistrationBean/EventListenerRegistrationBean的形式存在。这些 bean 设计的目的是用来注册相应的 Servlet/Filter/EventListener bean 到 ServletContext

- **实现了Servlet/Filter/EventListener接口的 bean**

这些 bean直接以实现裸的Servlet/Filter/EventListener接口的 bean的形式存在,但是Springboot会将它们封装成相应的 RegistrationBean(也是ServletContextInitializer ),然后也注册到ServletContext。

也就是说,Spring帮我们将实现裸的Servlet/Filter/EventListener接口的 bean,封装成ServletRegistrationBean/FilterRegistrationBean/EventListenerRegistrationBean。

2. Spring 容器(ServletWebServerApplicationContext)从ServletContextInitializerBeans实例的成员变量initializers变量(LinkedMultiValueMap),中获取所有的ServletContextInitializer实现类,调用它们的startUp函数,FilterRegistrationBean的onStartup函数就是在调用ServletContext的addFilter函数向Servlet添加Filter

1.还是要回到上面1.2中的createWebServer()函数中,这次我们不看getSelfInitializer(),而是看factory.getWebServer(...)函数。

private void createWebServer() {
    WebServer webServer = this.webServer;    
    ServletContext servletContext = getServletContext();    
    if (webServer == null && servletContext == null) {
       StartupStep createWebServer = this.getApplicationStartup().start("spring.boot.webserver.create");       
       ServletWebServerFactory factory = getWebServerFactory();       
       createWebServer.tag("factory", factory.getClass().toString());  
       //  getSelfInitializer()函数中获取所有ServletContextInitializer实例,调用onStartup方法完成注册
       this.webServer = factory.getWebServer(getSelfInitializer());
       ......
}

2.TomcatServletWebServerFactory的getWebServer(...)函数

public WebServer getWebServer(ServletContextInitializer... initializers) {
    if (this.disableMBeanRegistry) {
       Registry.disableRegistry();    
    }
    ......
    // 将前面获取到的所有ServletContextInitializer实例作为参数,传下去
    prepareContext(tomcat.getHost(), initializers);    
    return getTomcatWebServer(tomcat);
 }

3.TomcatServletWebServerFactory的prepareContext(...)

protected void prepareContext(Host host, ServletContextInitializer[] initializers) {
    ......
    // 合并一下
    ServletContextInitializer[] initializersToUse = mergeInitializers(initializers);    
    host.addChild(context);   
    // 将前面获取到的所有ServletContextInitializer实例作为参数,传下去 
    configureContext(context, initializersToUse);    
    postProcessContext(context);}

4.tomcatServletWebServerFactory的configureContext(...),创建了TomcatStarter,并将TomcatStarter绑定到Tomcat上,这样Tomcat启动时就会回调TomcatStarter的onStartup函数。

protected void configureContext(Context context, ServletContextInitializer[] initializers) {
    // 将前面获取到的所有ServletContextInitializer实例作为参数,传下去 
    TomcatStarter starter = new TomcatStarter(initializers);
    // 下面这一系列操作是将TomcatStarter绑定到Tomcat上,这样TomcatStarter就会在Tomcat启动时被回调
    if (context instanceof TomcatEmbeddedContext) {
    TomcatEmbeddedContext embeddedContext = (TomcatEmbeddedContext) context;    
    embeddedContext.setStarter(starter);    
    embeddedContext.setFailCtxIfServletStartFails(true);
    }
    context.addServletContainerInitializer(starter, NO_CLASSES);
    ......
}

5.TomcatStarter的startUp函数被调用的时候,就会变量所有的ServletContextInitializer实例的onStartup函数,

public void onStartup(Set<Class<?>> classes, ServletContext servletContext) throws ServletException {
    try {
       for (ServletContextInitializer initializer : this.initializers) {
          initializer.onStartup(servletContext);       
          }
    }
    catch (Exception ex) {
       this.startUpException = ex;       
       // Prevent Tomcat from logging and re-throwing when we know we can       
       // deal with it in the main thread, but log for information here.      
       if (logger.isErrorEnabled()) {
          logger.error("Error starting Tomcat context. Exception: " + ex.getClass().getName() + ". Message: "                + ex.getMessage());       
          }
    }
}

6.回顾第一章:“Filter接口的实现类封装成FilterRegistrationBean”,而FilterRegistrationBean又是ServletContextInitializer接口的实现类,所以上面第5步,也会回调FilterRegistrationBean的onStartup函数,

//FilterRegistrationBean
public final void onStartup(ServletContext servletContext) throws ServletException {
    String description = getDescription();    
    if (!isEnabled()) {
       logger.info(StringUtils.capitalize(description) + " was not registered (disabled)");       return;    
       }
    // 这里
    register(description, servletContext);
}

7.DynamicRegistrationBean.class

protected final void register(String description, ServletContext servletContext) {
    //这里
    D registration = addRegistration(description, servletContext);    
    if (registration == null) {
       logger.info(StringUtils.capitalize(description) + " was not registered (possibly already registered?)");       
       return;    
       }
    configure(registration);
    }

8.AbstractFilterRegistrationBean.class, 看到没,最终还是用ServletContext的addFilter函数,向Servlet容器中添加Filter。

protected Dynamic addRegistration(String description, ServletContext servletContext) {
    // getFilter()在FilterRegistrationBean中被实现,返回的就是那个Filter接口的实现类。
    Filter filter = getFilter();   
    // 将Filter接口的实现类添加到Servlet容器中 
    return servletContext.addFilter(getOrDeduceName(filter), filter);
  }

参考资料

到此这篇关于SpringBoot中Filter bean是怎么被添加到Servlet容器中的的文章就介绍到这了,更多相关SpringBoot Filter bean添加到Servlet容器内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Java算法练习题,每天进步一点点(1)

    Java算法练习题,每天进步一点点(1)

    方法下面小编就为大家带来一篇Java算法的一道练习题(分享)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧,希望可以帮到你
    2021-07-07
  • 使用Spring底层组件实现Aware接口

    使用Spring底层组件实现Aware接口

    这篇文章主要介绍了使用Spring底层组件实现Aware接口,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2023-07-07
  • Java日常练习题,每天进步一点点(59)

    Java日常练习题,每天进步一点点(59)

    下面小编就为大家带来一篇Java基础的几道练习题(分享)。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧,希望可以帮到你
    2021-08-08
  • springboot项目docker分层构建的配置方式

    springboot项目docker分层构建的配置方式

    在使用dockerfile构建springboot项目时,速度较慢,用时比较长,为了加快构建docker镜像的速度,采用分层构建的方式,这篇文章主要介绍了springboot项目docker分层构建,需要的朋友可以参考下
    2024-03-03
  • 基于JVM-jinfo的使用方式

    基于JVM-jinfo的使用方式

    这篇文章主要介绍了JVM-jinfo的使用方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-10-10
  • Java基于解释器模式实现定义一种简单的语言功能示例

    Java基于解释器模式实现定义一种简单的语言功能示例

    这篇文章主要介绍了Java基于解释器模式实现定义一种简单的语言功能,简单描述了解释器模式的概念、功能及Java使用解释器模式定义一种简单语言的相关实现与使用技巧,需要的朋友可以参考下
    2018-05-05
  • 浅谈synchronized方法对非synchronized方法的影响

    浅谈synchronized方法对非synchronized方法的影响

    下面小编就为大家带来一篇浅谈synchronized方法对非synchronized方法的影响。小编觉得挺不错的,现在就分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-10-10
  • Spring AOP实现功能权限校验功能的示例代码

    Spring AOP实现功能权限校验功能的示例代码

    本篇文章主要介绍了Spring AOP实现功能权限校验功能的示例代码,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2017-12-12
  • Spring如何通过注解存储和读取对象详解

    Spring如何通过注解存储和读取对象详解

    在Spring中,要想更简单的存储和读取对象的核心是使用注解,这篇文章主要给大家介绍了关于Spring如何通过注解存储和读取对象的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2022-07-07
  • Java中Arrays.asList()方法详解及实例

    Java中Arrays.asList()方法详解及实例

    这篇文章主要介绍了Java中Arrays.asList()方法将数组作为列表时的一些差异的相关资料,需要的朋友可以参考下
    2017-06-06

最新评论