spring boot2.X定制Servlet容器(通过配置类)

  • Spring boot默认使用tomcat作为嵌入式的servlet容器.
@Configuration
public class TomcatCustomizer {
    @Bean
    public ConfigurableServletWebServerFactory configurableServletWebServerFactory(){
        TomcatServletWebServerFactory factory = new TomcatServletWebServerFactory();
        factory.setPort(8081);
        return factory;
    }
}



注册Servlet三大组件(Servlet、Filter、Listener)

Spring Boot默认启动嵌入式Servlet容器来启动web应用,但是没有web.xml的目录结构。因此注册三大组件是通过RegistrRegistrationBean的方式来实现的。


首先建立项目文件结构如下:

【spring boot笔记】11.(Web 开发)Servlet容器

  • 创建MyServerConfig服务器配置类用于创建新的组件对象(该配置类已提前配置好嵌入式servlet服务器)
  • 创建MyFilter MyListener MyServlet以具体实现Servlet的三大类



配置MyServlet:

MyServlet的代码如下所示:

package com.learning.learning07.servlet;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

public class MyServlet extends HttpServlet {
    @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("Hello MySerlet");
    }
}

代码的功能是向客户端返回字符串"Hello MyServlet".


现在在MyServerConfig配置类中创建一个自定义的Servlet对象:

@Bean
    public ServletRegistrationBean myServlet(){
        ServletRegistrationBean<Servlet> registrationBean = new ServletRegistrationBean<>(new MyServlet(),"/myServlet");
        return registrationBean;
    }

然后在浏览器中输入:localhost:[本地端口号]/myServlet,可以看到:
【spring boot笔记】11.(Web 开发)Servlet容器

配置MyFilter:

MyFilter的代码如下所示:

package com.learning.learning07.filter;

import javax.servlet.*;
import java.io.IOException;

// 此处implement的是javax.servlet下的filter
public class MyFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void destroy() {

    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("MyFilter process...");
        filterChain.doFilter(servletRequest,servletResponse);
    }
}

这里当过滤器识别了特定的url地址后会在控制台显示"MyFilter process…"


在MyServerConfig配置类中创建自定义的过滤器对象,代码为:

 // 使用filter过滤路径localhost:8081/myServlet
    @Bean
    public FilterRegistrationBean myFilter(){
        FilterRegistrationBean registrationBean=new FilterRegistrationBean<>();
        registrationBean.setFilter(new MyFilter());
        registrationBean.setUrlPatterns(Arrays.asList("/myServlet"));
        return registrationBean;
    }

这个创建的过滤器对象识别的是localhost:8081/myServlet的地址。在浏览器端打开这个地址可以在idea控制台看到:
【spring boot笔记】11.(Web 开发)Servlet容器

实现MyListener:

MyListener的代码如下所示:

package com.learning.learning07.listen;

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;

public class MyListener implements ServletContextListener {
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        System.out.println("启动监听");
    }

    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        System.out.println("当前web项目销毁");
    }
}

代码实现的功能是启动项目会在控制台显示"启动监听",退出运行程序时会在控制台显示"当前web项目销毁".
在配置类中添加该自定义对象,代码为:

    @Bean
    public ServletListenerRegistrationBean myListener(){
        ServletListenerRegistrationBean<MyListener> registrationBean=new ServletListenerRegistrationBean<>(new MyListener());
        return registrationBean;
    }

启动项目时可以看到:
【spring boot笔记】11.(Web 开发)Servlet容器
退出项目时可以看到:
【spring boot笔记】11.(Web 开发)Servlet容器

相关文章: