SpringBoot原生组件注入实现两种方式介绍
更新时间：2022年10月20日 16:15:53 作者：刘婉晴
SpringBoot是Spring全家桶的成员之一，基于约定优于配置的思想（即有约定默认值，在不配置的情况下会使用默认值，在配置文件下配置的话会使用配置的值）。SpringBoot是一种整合Spring技术栈的方式(或者说是框架)，同时也是简化Spring的一种快速开发的脚手架
原生组件注入SpringBoot，即注册 Servlet 、Filter、Listener 进入 SpringBoot
一、使用 Servlet API
使用 Servlet API 可以实现原生组件注入，通过在自定义 Servlet 前加入 @WebServlet 注释，并且在 SpringBoot 启动类前加入 @ServletComponentScan 注释，可实现注册 Servlet
代码示例：
1、实现自定义 MyServlet
自定义 Servlet 类：
@WebServlet(urlPatterns = "/my") // 加入 @WebServlet 注释
public class MyServlet extends HttpServlet { // 注意要继承 HttpServlet 类
@Override // 重写 DoGet 方法
protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
resp.getWriter().println("haha");
}
}
项目启动类：
@ServletComponentScan(basePackages = "com.wanqing.admin") //扫描那个包中有servlet
@SpringBootApplication
public class DemoAdminApplication {
public static void main(String[] args) {
SpringApplication.run(DemoAdminApplication.class, args);
}
}
2、实现自定义 MyFilter
@Slf4j
@WebFilter(urlPatterns = {"/css/*", "/images/*"}) // 拦截静态资源
public class MyFilter implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
Filter.super.init(filterConfig);
log.info("MyFilter初始化完成");
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
log.info("MyFilter工作");
filterChain.doFilter(servletRequest, servletResponse);
}
@Override
public void destroy() {
Filter.super.destroy();
log.info("MyFilter销毁");
}
}3、实现自定义 MyServletContextListener
@WebListener
@Slf4j
public class MyServletContextListener implements ServletContextListener {
@Override
public void contextInitialized(ServletContextEvent sce) {
log.info("MyServletContextListener 监听到项目初始化完成");
}
@Override
public void contextDestroyed(ServletContextEvent sce) {
log.info("MyServletContextListener 监听到项目销毁");
}
}二、使用 RegistrationBean 的方式注入原生组件
通过编写 MyRegistConfig 配置类，返回 RegistrationBean 的方式实现组件的注入，与上一种方式的区别在于，这种方式不需要给 自定义 Servlet 类写 @WebServlet 注释。
注意点：要记得使用 @Bean 注释将 ServletRegistrationBean 注册到容器中。
代码示例：
自定义 MyRegistConfig 配置类，注册 myServlet 组件，返回 ServletRegistrationBean 对象 （对象参数为自定义的 myServlet 对象实例）
myFilter 及myListener 的实现方式同理
@Configuration
public class MyRegistConfig {
@Bean
public ServletRegistrationBean myServlet(){
MyServlet myServlet = new MyServlet();
return new ServletRegistrationBean(myServlet, "/my","/my02");
}
@Bean
public FilterRegistrationBean myFilter(){
MyFilter filter = new MyFilter();
//return new FilterRegistrationBean(filter, myServlet()); // 拦截myServlet()的路径
FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean(filter);
filterRegistrationBean.addUrlPatterns("/my","/css/*");
return filterRegistrationBean;
}
@Bean
public ServletListenerRegistrationBean myListener(){
MyServletContextListener myServletContextListener = new MyServletContextListener();
return new ServletListenerRegistrationBean(myServletContextListener);
}
}拓展：为什么拦截器不拦截 我们自定义的 MyServlet 请求？
分析 DispatcherServlet 如何注册进入容器中，从 DispatcherServletAutoConfiguration 类开始
容器中自动配置了 DispatcherServlet 组件，其属性绑定到 WebMvcProperties 中，对应的配置文件是 spring.mvc
@Bean(name = DEFAULT_DISPATCHER_SERVLET_BEAN_NAME) // 注册 DispatcherServlet 组件
public DispatcherServlet dispatcherServlet(WebMvcProperties webMvcProperties) {
DispatcherServlet dispatcherServlet = new DispatcherServlet();
dispatcherServlet.setDispatchOptionsRequest(webMvcProperties.isDispatchOptionsRequest());
dispatcherServlet.setDispatchTraceRequest(webMvcProperties.isDispatchTraceRequest());
dispatcherServlet.setThrowExceptionIfNoHandlerFound(webMvcProperties.isThrowExceptionIfNoHandlerFound());
dispatcherServlet.setPublishEvents(webMvcProperties.isPublishRequestHandledEvents());
dispatcherServlet.setEnableLoggingRequestDetails(webMvcProperties.isLogRequestDetails());
return dispatcherServlet;
}
通过 ServletRegistrationBean < DispatcherServlet > 机制（DispatcherServletRegistrationBean.class）将 DispatcherServlet 原生的 Servlet 组件配置进来
@Bean(name = DEFAULT_DISPATCHER_SERVLET_REGISTRATION_BEAN_NAME)
@ConditionalOnBean(value = DispatcherServlet.class, name = DEFAULT_DISPATCHER_SERVLET_BEAN_NAME)
public DispatcherServletRegistrationBean dispatcherServletRegistration(DispatcherServlet dispatcherServlet,
WebMvcProperties webMvcProperties, ObjectProvider<MultipartConfigElement> multipartConfig) {
DispatcherServletRegistrationBean registration = new DispatcherServletRegistrationBean(dispatcherServlet,
webMvcProperties.getServlet().getPath()); // 拿到默认映射路径为 / 路径
registration.setName(DEFAULT_DISPATCHER_SERVLET_BEAN_NAME);
registration.setLoadOnStartup(webMvcProperties.getServlet().getLoadOnStartup());
multipartConfig.ifAvailable(registration::setMultipartConfig);
return registration;
}拿到默认映射路径 /
WebMvcProperties.class 中配置
使用 Tomcat 做原生 Servlet 开发，如果多个 Servlet 都能处理到同一层路径，是精确优先原则，例如：
A：/my/
B: /my/1
发送 /my/1 请求 B处理，而发送 /my/2 请求 A 处理
结论 ： 来到 /my 不经过 / —— 精确匹配 /my 直接经 Tomcat 写出响应，不经过 SpringMVC 的一系列流程，因此不被拦截器拦截，如下图所示：
到此这篇关于SpringBoot原生组件注入实现两种方式介绍的文章就介绍到这了,更多相关SpringBoot原生组件注入内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！
相关文章
最近在学习java9，所以将学习中遇到的一些知识点分享给大家，下面这篇文章主要给大家介绍了java9学习系列之在docker中如何运行java9的相关资料，文中通过示例代码介绍的非常详细，需要的朋友可以参考下。2017-09-09
消费者端限流的主要目的是控制消费者每次从 RabbitMQ 中获取的消息数量,从而实现消息处理的流量控制,这篇文章主要介绍了RabbitMQ如何实现消费端限流,需要的朋友可以参考下2024-03-03
远程过程调用主要分为：服务提供者，服务消费者，通过连接对方服务器进行请求交互，来实现调用效果，这篇文章主要介绍了springboot3整合远程调用,需要的朋友可以参考下2023-06-06
这篇文章主要介绍了Java中map内部存储方式解析的相关内容，涉及其实现方式，以及对存储方式作了简单的比较，具有一定参考价值，需要的朋友可了解下。2017-10-10
这篇文章主要为大家详细介绍了Java代码实现简单酒店管理系统，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下2022-06-06
在现代应用程序中,查询缓存的使用已经变得越来越普遍,它不仅能够显著提高系统的性能,还能提升用户体验,在这篇文章中,我们将探讨缓存的基本概念、重要性以及如何使用Spring Cache和Redis实现查询数据缓存,需要的朋友可以参考下2024-07-07
这篇文章主要为大家详细介绍了Java在编写算法时如何加快读写数据速度,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下2024-03-03
这篇文章主要为大家介绍了RocketMQ 源码分析Broker消息刷盘服务示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪2023-05-05
这篇文章主要介绍了SpringBoot将项目打成war包步骤解析,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下2020-03-03
这篇文章主要介绍了java的split方法使用示例,需要的朋友可以参考下2014-04-04
最新评论