Spring 全家桶之 Spring Boot 2.6.4(八)- 嵌入式 Servlet 容器(Part A)

简介: Spring 全家桶之 Spring Boot 2.6.4(八)- 嵌入式 Servlet 容器(Part A)

一、修改Spring Boot 中内嵌Servlet容器的默认配置

Spring Boot提供了默认提供了内嵌的Tomcat,可以通过命令行运行jar包的方式运行Spring Boot应用,spring-boot-start-web依赖中包含了Tomcat依赖,最新版本为9.0.62。

f7e6067db52b462f9d015fef23d5cea6_tplv-k3u1fbpfcp-zoom-in-crop-mark_4536_0_0_0.png

以往通过Tomcat容器运行Spring应用时,可以通过修改Tomcat的一些配置文件来修改Tomcat的运行状态,比如说端口号等,那么Spring Boot内嵌的Tomcat要如何修改?

有两种方式修改内置Tomcat的配置,第一种是在application.properties中添加tomcat配置和server配置

4a82f4c0ec3a4148abaf932b2771bd3c_tplv-k3u1fbpfcp-zoom-in-crop-mark_4536_0_0_0.png

第二种方式是编写一个WebServerFactoryCustomizer来进行tomcat的配置,在SpringBoot1.x的时候使用的是EmbeddedServletContainerCustomizer到SpringBoot2.x后WebServerFactoryCustomizer替代了EmbeddedServletContainerCustomizer。

@Configuration
public class LilithMvcConfig implements WebMvcConfigurer {
    @Bean
    public WebServerFactoryCustomizer<ConfigurableWebServerFactory> customizer(){
        return factory -> {
            factory.setPort(8083);
        };
    }
}
复制代码

注释application.properties中的配置,重新启动该应用

ec50ba063fb340339eeceb4d794c794f_tplv-k3u1fbpfcp-zoom-in-crop-mark_4536_0_0_0.png

配置生效,tomcat在8083端口启动

这两种配置的优先级是怎样的?

在application.properties中配置

server.port=8081
server.servlet.context-path=/servlet
复制代码

保持WebServerFactoryCustomizer中配置的端口不变,重启应用

d73b55870d924bbdaf6b32908ac2dc0f_tplv-k3u1fbpfcp-zoom-in-crop-mark_4536_0_0_0.png

控制台输出端口号为8083,路径为/servlet,可以确定重写WebServerFactoryCustomizer配置Tomcat的优先级更高,并且和application.properties是互补的。

二、Spring Boot中注册Servlet、Filter、Listener

在Java Web项目中,我们书写的Servlet、Filter、Listener组件都可以通过web.xml将这些组件配置到Tomcat容器中,那么在Spring Boot项目中使用内置Tomcat并且没有web.xml的情况如何注册这些组件?

Spring Boot为Java Web三大组件提供了通过XxxRegistrationBean的方式进行注册

ServletRegistrationBean注册Servlet

创建一个HalloServelet类继承HttpServlet类,并重写doGet()和doPost()方法

public class HalloServlet extends HttpServlet {
    // 处理get请求
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        doPost(req,resp);
    }
    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        resp.getWriter().write("Hallo Servlet");
    }
}
复制代码

使用ServletRegisterBean,代替在web.xml中注册Servlet,在LilithMvcConfig中增加代码

// 注册Servlet
@Bean
public ServletRegistrationBean<HalloServlet> halloServletServletRegistrationBean(){
    ServletRegistrationBean registrationBean = new ServletRegistrationBean();
    registrationBean.setServlet(new HalloServlet());
    registrationBean.setUrlMappings(Collections.singleton("/hallo"));
    return registrationBean;
}
复制代码

重启应用,在浏览器访问/hallo

fca53eea533a4caba7a91a77a75685a3_tplv-k3u1fbpfcp-zoom-in-crop-mark_4536_0_0_0.png

浏览器能够正常显示内容,自定义的Servlet成功注册。

FilterRegistrationBean注册Filter

首先自定义一个LilithFilter类实现Filter接口,在打印日志后放行请求

public class LilithFilter implements Filter {
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        System.out.println("LilithFilter running");
        chain.doFilter(request,response);
    }
}
复制代码

在LilithMvcConfig配置类中通过FilterRegistrationBean注册自定义的LilithFilter,并在其中设置过滤器要拦截的请求路径

// 注册Filter
@Bean
public FilterRegistrationBean<LilithFilter> lilithFilterFilterRegistrationBean(){
    FilterRegistrationBean<LilithFilter> filterFilterRegistrationBean = new FilterRegistrationBean<>();
    filterFilterRegistrationBean.setFilter(new LilithFilter());
    // 设置拦截的请求路径
    filterFilterRegistrationBean.setUrlPatterns(Arrays.asList("/hallo"));
    return filterFilterRegistrationBean;
}
复制代码

重启应用,在浏览器输入 /hallo

image.png

控制台输出自定义的LilithFilter类中的日志信息,自定义的LilithFilter注册成功并生效

在controller包中新增一个HiController,增加一个hi()方法,请求映射路径为/hi

@Controller
public class HiController {
    @RequestMapping("/hi")
    @ResponseBody
    public String hi(){
        return "Hi Lilith!";
    }
}
复制代码

重启应用,浏览器访问/hi,看是否会拦截

image.png

控制台没有输出LilithFilter中设置的日志信息,说明没有被拦截,因为LilithFilter过滤器中没有设置拦截该请求,需要注意的是如果LilithFilter中没有设置拦截任何请求,默认拦截所有请求包括静态资源,但是不会jsp请求; /* 会拦截jsp请求。

ServletListenerRegistrationBean注册Listener

增加一个LilithListener类实现Listener接口,实现contextInitialized()方法和contextDestroyed()方法,并打印日志信

public class LilithListener implements ServletContextListener {
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        System.out.println("Web 应用启动了.......");
    }
    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        System.out.println("Web 应用销毁了.......");
    }
}
复制代码

在LilithMvcConfig配置类中通过ServletListenerRegistrationBean注册自定义的监听器LilithListener

@Bean
public ServletListenerRegistrationBean<LilithListener> servletListenerRegistrationBean(){
    ServletListenerRegistrationBean<LilithListener> servletListenerRegistrationBean = new ServletListenerRegistrationBean<>();
    servletListenerRegistrationBean.setListener(new LilithListener());
    return servletListenerRegistrationBean;
}
复制代码

重启应用,查看控制台输出的日志信息

image.png

应用启动和关闭时都输出了自定义监听器LilithListener中定义的内容,说明自定义的监听器生效

Spring MVC的前端控制器DispatcherServlet就是通过这种方式来注册的,首先定义了DispatcherServlet类

image.png

接着通过DispatcherServletRegistrationBean注册了DispatcherServlet

image.png


相关实践学习
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
相关文章
|
2月前
|
XML Java 测试技术
《深入理解Spring》:IoC容器核心原理与实战
Spring IoC通过控制反转与依赖注入实现对象间的解耦,由容器统一管理Bean的生命周期与依赖关系。支持XML、注解和Java配置三种方式,结合作用域、条件化配置与循环依赖处理等机制,提升应用的可维护性与可测试性,是现代Java开发的核心基石。
|
2月前
|
XML Java 应用服务中间件
【SpringBoot(一)】Spring的认知、容器功能讲解与自动装配原理的入门,带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章,讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门,还有其他常用的Springboot注解!如果想要了解SpringBoot,那么就进来看看吧!
443 2
|
XML Java 数据格式
京东一面:spring ioc容器本质是什么? ioc容器启动的步骤有哪些?
京东一面:spring ioc容器本质是什么? ioc容器启动的步骤有哪些?
|
7月前
|
XML Java 数据格式
Spring IoC容器的设计与实现
Spring 是一个功能强大且模块化的 Java 开发框架,其核心架构围绕 IoC 容器、AOP、数据访问与集成、Web 层支持等展开。其中,`BeanFactory` 和 `ApplicationContext` 是 Spring 容器的核心组件,分别定位为基础容器和高级容器,前者提供轻量级的 Bean 管理,后者扩展了事件发布、国际化等功能。
|
10月前
|
XML Java 数据格式
Spring容器的本质
本文主要讨论Spring容器最核心的机制,用最少的代码讲清楚Spring容器的本质。
|
9月前
|
Java 数据库 微服务
微服务——SpringBoot使用归纳——Spring Boot中的项目属性配置——指定项目配置文件
在实际项目中,开发环境和生产环境的配置往往不同。为简化配置切换,可通过创建 `application-dev.yml` 和 `application-pro.yml` 分别管理开发与生产环境配置,如设置不同端口(8001/8002)。在 `application.yml` 中使用 `spring.profiles.active` 指定加载的配置文件,实现环境快速切换。本节还介绍了通过配置类读取参数的方法,适用于微服务场景,提升代码可维护性。课程源码可从 [Gitee](https://gitee.com/eson15/springboot_study) 下载。
377 0
|
数据库 数据格式 XML
spring+springMVC+mybatis的整合 part9
行为日志的列表的分页显示 功能设定: 记录基本主机信息操作系统,IP地址,访问的浏览器内核,Session的Id还有操作时间 首先要设定要数据库字段,唯一的注意的地方是这边把记录行为日志的表做了个自增的ID。
1195 0
|
5月前
|
Java Spring 容器
SpringBoot自动配置的原理是什么?
Spring Boot自动配置核心在于@EnableAutoConfiguration注解,它通过@Import导入配置选择器,加载META-INF/spring.factories中定义的自动配置类。这些类根据@Conditional系列注解判断是否生效。但Spring Boot 3.0后已弃用spring.factories,改用新格式的.imports文件进行配置。
968 0
|
6月前
|
人工智能 Java 测试技术
Spring Boot 集成 JUnit 单元测试
本文介绍了在Spring Boot中使用JUnit 5进行单元测试的常用方法与技巧,包括添加依赖、编写测试类、使用@SpringBootTest参数、自动装配测试模块(如JSON、MVC、WebFlux、JDBC等),以及@MockBean和@SpyBean的应用。内容实用,适合Java开发者参考学习。
723 0
|
2月前
|
JavaScript Java Maven
【SpringBoot(二)】带你认识Yaml配置文件类型、SpringMVC的资源访问路径 和 静态资源配置的原理!
SpringBoot专栏第二章,从本章开始正式进入SpringBoot的WEB阶段开发,本章先带你认识yaml配置文件和资源的路径配置原理,以方便在后面的文章中打下基础
336 3