day11-SpringBoot中注入Servlet&Filter&Listener

SpringBoot中注入Servlet&Filter&Listener

1.基本介绍

文档：SpringBoot中注入Servlet&Filter&Listener

• 考虑到实际开发业务非常复杂和兼容问题，SpringBoot支持将Servlet、Filter、Listener注入spring容器中，成为Spring Bean
  
• 也就是说，SpringBoot开放了和原生WEB组件（Servlet、Filter、Listener）的兼容
  
• SpringBoot注入Servlet、Filter、Listener，有两种方式：
  
  
  
  • 通过注解方式注入
    
  • 使用RegistrationBean方式注入
    
  
  

2.通过注解方式注入

2.1@WebServlet

属性名对应标签描述name指定 Servlet 的 name 属性。  如果没有显式指定，则取值为该 Servlet 的完全限定名，即包名+类名value该属性等价于 urlPatterns 属性，两者不能同时指定。  如果同时指定，通常是忽略 value 的取值urlPatterns指定一组 Servlet 的 URL 匹配模式loadOnStartup指定 Servlet 的加载顺序initParams指定一组 Servlet 初始化参数asyncSupported声明 Servlet 是否支持异步操作模式description指定该 Servlet 的描述信息displayName指定该 Servlet 的显示名

例子--使用@WebServlet注入Servlet

（1）MyServlet.java

• 通过继承HttpServlet来开发原生的Servlet
  
• 使用@WebServlet，表示将其标识的对象注入到Spring容器中
  
• urlPatterns = {"servlet01","servlet02"} 对此servlet配置了映射路径
  
• 对于开发的原生的Servlet，需要使用@ServletComponentScan在SpringBoot主程序中，指定要扫描的原生Servlet，这样该Servlet才能注入容器
  

1. package com.li.thymeleaf.servlet;
3. import javax.servlet.ServletException;
4. import javax.servlet.annotation.WebServlet;
5. import javax.servlet.http.HttpServlet;
6. import javax.servlet.http.HttpServletRequest;
7. import javax.servlet.http.HttpServletResponse;
8. import java.io.IOException;
10. /**
11. * @author 李
12. * @version 1.0
13. */
14. @WebServlet(urlPatterns = {"/servlet01", "/servlet02"})
15. public class MyServlet extends HttpServlet {
16.     @Override
17.     protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
18.         resp.getWriter().write("Hello,MyServlet!");
19.     }
20. }

复制代码

（2）Application.java主程序

1. package com.li.thymeleaf;
3. import org.springframework.boot.SpringApplication;
4. import org.springframework.boot.autoconfigure.SpringBootApplication;
5. import org.springframework.boot.web.servlet.ServletComponentScan;
7. /**
8. * @author 李
9. * @version 1.0
10. */
11. //指定扫描Servlet
12. @ServletComponentScan(basePackages = "com.li.thymeleaf")
13. @SpringBootApplication
14. public class Application {
15.     public static void main(String[] args) {
16.         SpringApplication.run(Application.class,args);
17.     }
18. }

复制代码

（3）浏览器访问地址：http://localhost:8080/servlet01获者 http://localhost:8080/servlet02，返回如下：
注意：注入的Servlet不会被SpringBoot的拦截器拦截（因为原生Servlet和前端控制器DispatcherServlet是统一级别的，而拦截器在DispatcherServlet中）
2.2@WebFilter

属性名说   明description该过滤器的描述信息，等价于 标签。displayName该过滤器的显示名，通常配合工具使用，等价于  标签initParams指定一组过滤器初始化参数，等价于  标签。filterName指定过滤器的 name 属性，等价于 servletNames指定过滤器将应用于哪些 Servlet。取值是 @WebServlet 中的 name 属性的取值，或者是 web.xml 中  的取值value/urlPatterns过滤器的 URL 匹配模式，等价于标签dispatcherTypes指定过滤器的转发模式。具体取值包括： ASYNC、ERROR、FORWARD、INCLUDE、REQUEST。asyncSupported声明过滤器是否支持异步操作模式， 等价于标签

例子--使用@WebFilter注入Filter

• @WebFilter标识一个过滤器，并注入spring容器
  
• urlPatterns = {"/css/*", "/images/*"}表示请求/css/目录或者/images/目录下的资源时，请求会经过这个过滤器
  
• 需要在主程序中，指定要扫描的Filter，这样该Filter才能注入容器
  

1. package com.li.thymeleaf.filter;
3. import lombok.extern.slf4j.Slf4j;
5. import javax.servlet.*;
6. import javax.servlet.annotation.WebFilter;
7. import javax.servlet.http.HttpServletRequest;
8. import java.io.IOException;
10. /**
11. * @author 李
12. * @version 1.0
13. * 开发Filter并注入spring容器
14. */
15. @Slf4j
16. @WebFilter(urlPatterns = {"/css/*", "/images/*"})
17. public class MyFilter implements Filter {
18.     @Override
19.     public void init(FilterConfig filterConfig) throws ServletException {
20.         log.info("MyFilter的init()方法被执行...");
21.     }
23.     @Override
24.     public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
25.         log.info("MyFilter的doFilter()方法被执行...");
26.         HttpServletRequest httpServletRequest = (HttpServletRequest) request;
27.         log.info("过滤器处理的uri={}", httpServletRequest.getRequestURI());
28.         chain.doFilter(request, response);//放行
29.     }
31.     @Override
32.     public void destroy() {
33.         log.info("MyFilter的destroy()方法被执行...");
34.     }
35. }

复制代码

（2）在主程序中配置扫描该过滤器（略）
（3）在浏览器访问地址：http://localhost:8080/images/login.jpg，后台输出：

1. 2023-03-23 18:59:36.685  INFO 39228 --- [nio-8080-exec-6] com.li.thymeleaf.filter.MyFilter         : MyFilter的doFilter()方法被执行...
2. 2023-03-23 18:59:36.685  INFO 39228 --- [nio-8080-exec-6] com.li.thymeleaf.filter.MyFilter         : 过滤器处理的uri=/images/login.jpg

复制代码

有时候后台没有输出，可能是浏览器缓存问题

2.3@WebListener

（1）MyListener.java

1. package com.li.thymeleaf.listener;
3. import lombok.extern.slf4j.Slf4j;
5. import javax.servlet.ServletContextEvent;
6. import javax.servlet.ServletContextListener;
7. import javax.servlet.annotation.WebListener;
9. /**
10. * @author 李
11. * @version 1.0
12. */
13. @Slf4j
14. @WebListener
15. public class MyListener implements ServletContextListener {
16.     @Override
17.     public void contextInitialized(ServletContextEvent sce) {
18.         //可以加入项目初始化相关的业务
19.         log.info("MyListener-contextInitialized()-项目初始化OK~");
20.     }
22.     @Override
23.     public void contextDestroyed(ServletContextEvent sce) {
24.         //可以加入业务
25.         log.info("MyListener-contextDestroyed()-项目初销毁...");
26.     }
27. }

复制代码

（2）在主程序 Application.java配置扫描该监听器

1. package com.li.thymeleaf;
3. import org.springframework.boot.SpringApplication;
4. import org.springframework.boot.autoconfigure.SpringBootApplication;
5. import org.springframework.boot.web.servlet.ServletComponentScan;
6. import org.springframework.context.ConfigurableApplicationContext;
8. /**
9. * @author 李
10. * @version 1.0
11. */
12. //指定扫描监听器
13. @ServletComponentScan(basePackages = "com.li.thymeleaf")
14. @SpringBootApplication
15. public class Application {
16.     public static void main(String[] args) {
17.         ConfigurableApplicationContext ioc =
18.                 SpringApplication.run(Application.class, args);
19.         //监听器的contextDestroyed()方法在容器销毁时触发
20.         ioc.stop();
21.     }
22. }

复制代码

（3）启动项目，控制台输出：
3.使用RegistrationBean方式注入

RegistrationConfig.java：

1. package com.li.thymeleaf.config;
3. import com.li.thymeleaf.filter.MyFilter;
4. import com.li.thymeleaf.listener.MyListener;
5. import com.li.thymeleaf.servlet.MyServlet;
6. import org.springframework.boot.web.servlet.FilterRegistrationBean;
7. import org.springframework.boot.web.servlet.ServletListenerRegistrationBean;
8. import org.springframework.boot.web.servlet.ServletRegistrationBean;
9. import org.springframework.context.annotation.Bean;
10. import org.springframework.context.annotation.Configuration;
12. import java.util.Arrays;
14. /**
15. * @author 李
16. * @version 1.0
17. * RegistrationConfig是一个配置类，
18. * 默认为单实例模式 proxyBeanMethods=true
19. */
20. @Configuration
21. public class RegistrationConfig {
22.     //使用RegistrationBean方式注入Servlet
23.     @Bean
24.     public ServletRegistrationBean servlet_() {
25.         MyServlet myServlet = new MyServlet();
26.         //将myServlet关联到ServletRegistrationBean对象
27.         //可以指定多个映射url
28.         return new ServletRegistrationBean(myServlet, "/servlet01", "/servlet02");
29.     }
31.     //使用RegistrationBean方式注入Filter
32.     @Bean
33.     public FilterRegistrationBean filter_() {
34.         MyFilter myFilter = new MyFilter();//创建原生的Filter对象
35.         FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean(myFilter);
36.         //设置filter的urlPattern
37.         filterRegistrationBean.setUrlPatterns(Arrays.asList("/css/*", "/images/*"));
38.         return filterRegistrationBean;
39.     }
41.     //使用RegistrationBean方式注入Listener
42.     @Bean
43.     public ServletListenerRegistrationBean listener_() {
44.         MyListener myListener = new MyListener();//创建原生的Listener对象
45.         return new ServletListenerRegistrationBean(myListener);
46.     }
47. }

复制代码

使用RegistrationBean的方式注入，不必在主程序Application.java中配置扫描

运行程序，可以看到三个组件都被注入到容器中：
4.注意事项和细节

4.1请求自定义Servlet时，为什么不会到达拦截器？

原因分析：
注入的Servlet会存在Spring容器，DispatcherServlet也存在Spring容器。当多个Servlet都能处理到同一层路径时，存在精确优先原则/最长前缀匹配原则：**精准匹配 > 目录匹配 > 扩展名匹配 > /*  > / **
如下图：当浏览器请求路径为/servlet01 时，MyServlet的映射路径对与浏览器请求来说是精准匹配，因此此时MyServlet的映射路径优先级高于前端控制器的 /，请求路径会走tomcat流程，不会到达前端控制器，也就不会执行拦截器。

当然，在SpringBoot中，去调用@Controller目标方法，仍是按照DispatcherServlet分发匹配的机制

4.2DispatcherServlet在SpringBoot如何进行配置和注入

DispatcherServletAutoConfiguration 完成对 DispatcherServlet 的自动配置。
DispatcherServletAutoConfiguration 类，有一个内部类：

1. @Configuration(proxyBeanMethods = false)
2. @Conditional(DefaultDispatcherServletCondition.class)
3. @ConditionalOnClass(ServletRegistration.class)
4. @EnableConfigurationProperties(WebMvcProperties.class)
5. protected static class DispatcherServletConfiguration {
7.     @Bean(name = DEFAULT_DISPATCHER_SERVLET_BEAN_NAME)
8.     //创建了DispatcherServlet对象，并进行一系列设置并返回。
9.     public DispatcherServlet dispatcherServlet(WebMvcProperties webMvcProperties) {
10.         DispatcherServlet dispatcherServlet = new DispatcherServlet();
11.         dispatcherServlet.setDispatchOptionsRequest(webMvcProperties.isDispatchOptionsRequest());
12.         dispatcherServlet.setDispatchTraceRequest(webMvcProperties.isDispatchTraceRequest());
13.         dispatcherServlet.setThrowExceptionIfNoHandlerFound(webMvcProperties.isThrowExceptionIfNoHandlerFound());
14.         dispatcherServlet.setPublishEvents(webMvcProperties.isPublishRequestHandledEvents());
15.         dispatcherServlet.setEnableLoggingRequestDetails(webMvcProperties.isLogRequestDetails());
16.         return dispatcherServlet;
17.     }
19.     @Bean
20.     @ConditionalOnBean(MultipartResolver.class)
21.     @ConditionalOnMissingBean(name = DispatcherServlet.MULTIPART_RESOLVER_BEAN_NAME)
22.     public MultipartResolver multipartResolver(MultipartResolver resolver) {
23.         // Detect if the user has created a MultipartResolver but named it incorrectly
24.         return resolver;
25.     }
27. }

复制代码

然后通过如下方法，创建DispatcherServletRegistrationBean对象，并将创建的DispatcherServlet对象关联到这个DispatcherServletRegistrationBean对象中，将DispatcherServletRegistrationBean对象通过@Bean注入到容器中。

1. @Configuration(proxyBeanMethods = false)
2. @Conditional(DispatcherServletRegistrationCondition.class)
3. @ConditionalOnClass(ServletRegistration.class)
4. @EnableConfigurationProperties(WebMvcProperties.class)
5. @Import(DispatcherServletConfiguration.class)
6. protected static class DispatcherServletRegistrationConfiguration {
8.    @Bean(name = DEFAULT_DISPATCHER_SERVLET_REGISTRATION_BEAN_NAME)
9.    @ConditionalOnBean(value = DispatcherServlet.class, name = DEFAULT_DISPATCHER_SERVLET_BEAN_NAME)
10.    public DispatcherServletRegistrationBean dispatcherServletRegistration(DispatcherServlet dispatcherServlet,
11.          WebMvcProperties webMvcProperties, ObjectProvider<MultipartConfigElement> multipartConfig) {
12.       DispatcherServletRegistrationBean registration = new DispatcherServletRegistrationBean(dispatcherServlet,
13.             webMvcProperties.getServlet().getPath());//设置路径 /
14.       registration.setName(DEFAULT_DISPATCHER_SERVLET_BEAN_NAME);
15.       registration.setLoadOnStartup(webMvcProperties.getServlet().getLoadOnStartup());
16.       multipartConfig.ifAvailable(registration::setMultipartConfig);
17.       return registration;
18.    }
20. }

复制代码

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！