SpringBoot: 集成Servlet、Filter和Listener实践

简介

使用 Spring Boot 开发项目之后，就基本上告别 Servlet、Filter 和 Listener 了。但是有时在整合一些第三方框架时，可能还是不得不使用 Servlet。Spring Boot 中对于整合这些基本的 Web 组件也提供了很好的支持。

SpringBoot 整合 Servlet 有两种方式：1. 通过注解扫描完成 Servlet 组件的注册；2. 通过方法完成 Servlet 组件的注册；下面分别讲解俩种注解方式。

一、通过注解实现

1. 定义组件

1）下面代码代码定义一个基本的 Servlet 组件，并使用 @WebServlet 注解进行标注。

@WebServlet("/my")
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 {
        System.out.println("name>>>" + req.getParameter("name"));
    }
}

（2）下面代码代码定义一个基本的 Filter 组件，并使用 @WebFilter 注解进行标注。

@WebFilter("/*")
public class MyFilter implements Filter {
 
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("MyFilter>>>init");
    }
 
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse,
                         FilterChain filterChain) throws IOException, ServletException {
        System.out.println("MyFilter>>>doFilter");
        filterChain.doFilter(servletRequest, servletResponse);
    }
 
    @Override
    public void destroy() {
        System.out.println("MyFilter>>>destroy");
    }
}

（3）下面代码代码定义一个基本的 Listener 组件，并使用 @WebListener 注解进行标注。

@WebListener
public class MyListener implements ServletRequestListener {
 
    @Override
    public void requestInitialized(ServletRequestEvent sre) {
        System.out.println("MyListener>>>requestInitialized");
    }
 
    @Override
    public void requestDestroyed(ServletRequestEvent sre) {
        System.out.println("MyListener>>>requestDestroyed");
    }
}

2. 项目配置

我们需要在项目入口类上添加 @ServletComponentScan 注解，实现对 Servlet、Filter 和 Listener 的扫描。这样我们定义的 Servlet、Filter、Listener 就可以直接通过 @WebServlet、@WebFilter、@WebListener 注解自动注册。

@SpringBootApplication
@ServletComponentScan
public class DemoApplication {
    public static void main(String[] args) {
        ConfigurableApplicationContext context
                = SpringApplication.run(DemoApplication.class, args);
    }
}

3. 测试运行

（1）我们通过浏览器访问如下地址： http://localhost:8080/my?name=hangge
（2）可看到控制台输出的日志如下：

二、通过方法完成 Servlet 组件的注册

1.定义组件

package com.example.combine.servlet.sbservlet;

import java.io.IOException;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

/**
 * 
 * @author servlet整合springboot方式2
 *
 */

// 这种方式无须在servlet这个类中添加@WebServlet这个注释声明
public class ServletDemo2 extends HttpServlet {

    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        // TODO Auto-generated method stub
        super.doGet(req, resp);
        System.out.println("这是第二种整合的方式");
    }

}

2. 项目配置

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
public class App1 {

    public static void main(String[] args) {
        // TODO Auto-generated method stub
        SpringApplication.run(App1.class, args);
    }

    // 添加如下的方法
    // 实现在启动类中注册servlet的方法
    @Bean // 添加@Bean的注释
    public ServletRegistrationBean getServlet() {
        // 通过ServletRegistrationBean完成对servlet的注册
        ServletRegistrationBean bean = new ServletRegistrationBean(new ServletDemo2());
        bean.addUrlMappings("/second"); // 该方法完成的是对urlPattern的配置
        return bean; // 将对象返回
    }

}