Servlet容器、过滤器和监听器

一、Servlet容器

Servlet是在javax.serlvet包中定义的一个接口。在开发springboot应用程序时，使用controller基本能解决大部分的功能需求，但有时也需要servlet，比如实现拦截器和监听功能。

springboot核心控制器DispatcherServlet会处理所有的请求。如果自定义的Servlet则需要进行注册，以便DispatcherServlet核心控制器知道它的作用，以及处理请求的url-pattern

---

实例：用Servlet处理请求

1、注册Servlet类

@WebServlet(urlPatterns = "/ServletDemo02/*")
public class ServletDemo02 extends HttpServlet{
    /**
     * Description:
     * 重写doGet方法,父类的HttpServlet的doGet方法是空的，没有实现任何代码，子类需要重写此方法。
     *客户使用GET方式请求Servlet时，Web容器调用doGet方法处理请求。
     */
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        System.out.println("doGet");
        resp.getWriter().print("Servlet ServletDemo02");
    }
}

2、开启Servlet支持

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

 @WebServlet 标识一个Servlet

@ServletComponentScan：扫描该注解指定包下的所有Servlet

在运行后访问  /ServletDemo02/* 会调用doGET方法

 

二、过滤器

Filter也称为过滤器，是处于客户端和服务端之间的一条过滤网。它是servlet的技术之一。Web开发人员通过Filter技术管理Web服务器的所有资源，例如对JSP，静态文件等进行拦截，从而控制权限。

Filter的创建和销毁由Web服务器负责，Web应用程序启动时，Web服务器将创建Filter的实例对象,并读取其init方法，读取Web.xml配置，完成对象的初始化，从而为后续的拦截做好准备。Filter创建后会驻留内存中，当Web服务器停止才会被销毁。

过滤器Filter的使用

在springboot使用过滤器很简单，自定义一个过滤器，实现Filter接口，其中urlPatterns是路径的拦截

@webFilter是将一个类声明为一个过滤器

/**
 * AyUser过滤器
 * 通过注解的方式自动注册filter
 */

@WebFilter(filterName = "ayUserFilter", urlPatterns = "/*")
public class AyUserFilter implements Filter {
    private Logger myLogger = LogManager.getLogger(this.getClass());

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        myLogger.info("----------------->>> ayUserFilter init" );
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        myLogger.info("----------------->>> ayUserFilter doFilter" );
        filterChain.doFilter(servletRequest,servletResponse);
    }

    @Override
    public void destroy() {
        myLogger.info("----------------->>> ayUserFilter destroy" );
    }
}

接着我们在入口类，添加注解@ServletComponentScan，使用该注解后，Servlet，Filter、Listener可直接通过@WebServlet、@WebFilter、@WebListenter注解被扫描和自动注册，无需其他代码

/**
 * SpringBoot入口类
 */
@ServletComponentScan
@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

}

我们启动项目时，Web容器会初始化过滤器，并调用init()方法，可以在控制台看到打印信息

当用户调用任何路径，都会调用doFilter方法

这就是一个简单的过滤器配置。

 

三、监听器

监听器也叫Listener，是servlet的监听器，它也是servlet的技术之一，可以监听Web中的某些对象、信息的创建、销毁、增加、修改、删除等动作。然后做出相应的响应处理。当对象的状态发生变化时，服务器会自动调用监听器对象中的方法，常用于统计在线人数、信息的初始化、统计网站的访问量等。

根据监听对象可以把监听器分为3类：

1. ServletContext(对应application)：Application在整个Web服务器中只有一个，在Web服务器关闭时销毁。
2. HttpSession(对应session)：Session对应每个会话，在会话建立时创建、一端关闭会话时销毁。
3. ServletRequest(对应request)：Requestion对象是客户端发送请求时创建的(一同创建的还有Response)，用于封装请求数据，再一次请求处理完毕时销毁。

根据监听的事件，可以把监听器分为3类：

1. 监听对象的创建与销毁。如ServletContextListener
2. 监听对象域中的属性的增加和删除。如HttpSessionListener和ServletRequestListener
3. 监听绑定到Session上的某个对象的状态。如ServletContextAttributeListener、HttpSessionAttributeListener、ServletRequestAttributeListener等

监听器的使用

在springboot中使用Listener监听器和Filter基本一样，我们来自定义一个监听器，具体代码如下

正如前文所述，我们自定义了一个监听器，它实现了ServletContextListener的接口，同时我们进行注解@WebListener，这样就会被部署称为监听器。

ServletContextListener类：它能够监听ServletContext对象的生命周期，实际上就是监听Web应用的生命周期。当Servlet容器启动或终止时，会触发ServletContextEvent事件，该事件有ServletContextListener类来处理。ServletContextListener接口中有两个方法

package com.example.common.listener;


import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;

/**
 * 自定义监听器
 */
@WebListener
public class AyUserListener implements ServletContextListener {
    private Logger myLogger = LogManager.getLogger(this.getClass());

    /**
     * Web容器启动时调用该方法
     * @param sce
     */
    public void contextInitialized(ServletContextEvent sce) {
        myLogger.info("--------->>>ServletContext init");
    }

    /**
     * Web容器终止时调用发该方法
     * @param sce
     */
    public void contextDestroyed(ServletContextEvent sce) {
        myLogger.info("--------->>>ServletContext destroyed");
    }
}

在入口添加注解@ServletComponentScan 开启扫描

/**
 * SpringBoot入口类
 */
@ServletComponentScan
@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

}

下面我们启动项目，Web容器会初始化AyUserListener 对象，并调用contextInitialized方法，用日志打印到控制台

这样一个简单的监听器就被部署成功了