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实时生图绘板
相关文章
|
7月前
|
XML Java 应用服务中间件
【SpringBoot(一)】Spring的认知、容器功能讲解与自动装配原理的入门,带你熟悉Springboot中基本的注解使用
SpringBoot专栏开篇第一章,讲述认识SpringBoot、Bean容器功能的讲解、自动装配原理的入门,还有其他常用的Springboot注解!如果想要了解SpringBoot,那么就进来看看吧!
714 2
|
前端开发 Java Docker
使用Docker容器化部署Spring Boot应用程序
使用Docker容器化部署Spring Boot应用程序
|
Java Docker 微服务
利用Docker容器化部署Spring Boot应用
利用Docker容器化部署Spring Boot应用
374 0
|
前端开发 Java 应用服务中间件
Spring Boot 2.x 嵌入式 Servlet 容器
Spring Boot使用内嵌Tomcat,默认端口8080,可通过`application.properties`配置端口、上下文路径等。配置方式有两种:1) 直接在配置文件中添加`server.port`和`server.servlet.context-path`;2) 创建`WebServerFactoryCustomizer` Bean来自定义配置,如设置端口`factory.setPort(8083)`,这种方式优先级更高。
474 0
|
XML Java 应用服务中间件
springboot定制嵌入式的servlet
SpringBoot允许定制嵌入式Servlet容器,如修改配置或更换默认的Tomcat。配置可通过`application.properties`设置`server.port`和`server.tomcat.*`属性。此外,可创建`EmbeddedServletContainerCustomizer` Bean来自定义容器,例如改变端口。要替换默认的Tomcat,需排除`spring-boot-starter-tomcat`依赖,并引入`spring-boot-starter-jetty`。
285 0
|
缓存 安全 Java
Java服务器端技术:Servlet与JSP的集成与扩展
Java服务器端技术:Servlet与JSP的集成与扩展
266 3
|
存储 Java 关系型数据库
基于Servlet和JSP的Java Web应用开发指南
基于Servlet和JSP的Java Web应用开发指南
604 1
|
存储 缓存 前端开发
Servlet与JSP在Java Web应用中的性能调优策略
Servlet与JSP在Java Web应用中的性能调优策略
281 1
|
前端开发 安全 Java
在Java服务器端开发的浩瀚宇宙中,Servlet与JSP犹如两颗璀璨的明星,它们联袂登场,共同编织出动态网站的绚丽篇章。
在Java服务器端开发的浩瀚宇宙中,Servlet与JSP犹如两颗璀璨的明星,它们联袂登场,共同编织出动态网站的绚丽篇章。
214 1
|
自然语言处理 前端开发 Java
Servlet与JSP:Java Web开发的基石技术详解
【6月更文挑战第23天】Java Web的Servlet与JSP是动态网页的核心。Servlet是服务器端的Java应用,处理HTTP请求并响应;JSP则是结合HTML与Java代码的页面,用于动态内容生成。Servlet通过生命周期方法如`init()`、`service()`和`destroy()`工作,而JSP在执行时编译成Servlet。两者在MVC架构中分工,Servlet处理逻辑,JSP展示数据。尽管有Spring MVC等框架,Servlet和JSP仍是理解Web开发基础的关键。
434 12