Servlet、Filter 、Interceptor 和 Listener

ens
586 阅读7分钟

一、整体关系图

image.png

image.png

二、概念

Servlet 与 Filter

filter过滤器是在Java Servlet规范2.3中定义的，在Java Servlet规范2.3出来之前，是没有filter这个角色的。

filter这个角色是用来：在请求到达servlet之前，先截获请求，对请求先做一些预处理(例如编码转换，权限验证)。处理完后在把请求转发给 servlet或把不符合某些规则的请求丢弃掉，不再转发给servlet了。当servlet处理好请求后，返回响应给浏览器时，filter拦截响 应，对响应做一些处理之后，再返回给浏览器。由此可见，filter这个角色的职责就是：帮servlet做一些前期预处理工作(先于servlet处理 request)和善后工作(后于servlet处理response)的辅助角色，它就像servlet的助手一样，但它并不是必须的，因为在之前没有 filter的时候，servlet也能很好地工作。只是如果有filter的帮助的话，servlet就能更专注处理一些核心的业务。

20171010195254608.png

多个filter可以协同工作，它们之间采用了职责链的设计模式来协同工作。一个filter处理完后，调用下一个filter来处理，每个filter 负责处理不同的工作，而这些filter之间可以根据需要灵活组合。filter的先后顺序按filter在web.xml中配置的先后顺序。

filter需要servlet容器(tomcat)的支持，能运行filter的servlet容器必须实现在Java Servlet规范2.3版中定义的功能。servlet容器是对javax.servlet.Filter这个接口进行编程的，所以你自己写的 filter必须直接或间接的实现了javax.servlet.Filter这个接口，否则servlet容器不能跟你定义的filter进行交互(因 为在编程实现容器时，就把javax.servlet.Filter这个接口编进容器代码中了，容器只能调用javax.servlet.Filter接 口的实现类）。

Interceptor

1. 定义

它依赖于web框架，在SpringMVC中就是依赖于SpringMVC框架。在实现上，基于Java的反射机制，属于面向切面编程（AOP）的一种运用，就是在service或者一个Action方法前，调用一个方法，或者在Action方法后，调用一个方法，比如动态代理就是拦截器的简单实现，在调用方法前打印出字符串（或者做其它业务逻辑的操作），也可以在调用方法后打印出字符串，甚至在抛出异常的时候做业务逻辑的操作。由于拦截器是基于web框架的调用，因此可以使用Spring的依赖注入（DI）进行一些业务操作，同时一个拦截器实例在一个controller生命周期之内可以多次调用。但是缺点是只能对controller请求进行拦截，对其他的一些比如直接访问静态资源的请求则没办法进行拦截处理。

2. Filter 和 Interceptor的区别

  • Filter是基于函数回调的，而Interceptor则是基于Java反射的。
  • Filter依赖于Servlet容器，而Interceptor不依赖于Servlet容器。
  • Filter对几乎所有的请求起作用，而Interceptor只能对action请求起作用。
  • Interceptor可以访问Action的上下文，值栈里的对象，而Filter不能。
  • 在action的生命周期里，Interceptor可以被多次调用，而Filter只能在容器初始化时调用一次。
  • 拦截器可以获取IOC容器中的各个bean，而过滤器就不行，这点很重要，在拦截器里注入一个service，可以调用业务逻辑。拦截器可以获取ioc中的service bean实现业务逻辑。

最简单明了的区别就是:
过滤器可以修改request，而拦截器不能
过滤器需要在servlet容器中实现，拦截器可以适用于javaEE，javaSE等各种环境
拦截器可以调用IOC容器中的各种依赖，而过滤器不能
过滤器只能在请求的前后使用，而拦截器可以详细到每个方法

总的来说:
过滤器就是筛选出你要的东西，比如requeset中你要的那部分
拦截器在做安全方面用的比较多，比如终止一些流程\

过滤器（Filter）：可以拿到原始的http请求，但是拿不到你请求的控制器和请求控制器中的方法的信息。
拦截器（Interceptor）：可以拿到你请求的控制器和方法，却拿不到请求方法的参数。
切片（Aspect）:  可以拿到方法的参数，但是却拿不到http请求和响应的对象\

image.png

Listener

listener是对事件进行监听和处理的角色，它采用观察者模式，只有当在这个listener上注册了的事件
发生时，listener才会执行事件处理方法。这些事件举例：上下文(context)加载事件；session创建或销毁事件；容器、session或请求的属性设置或移除事件等。

servlet2.4规范中提供了8个listener接口，可以将其分为三类，分别如下：
第一类：与servletContext(Application)有关的listner接口。
包括：ServletContextListener、ServletContextAttributeListener
第二类：与HttpSession有关的Listner接口。
包括：HttpSessionListner、 HttpSessionAttributeListener、HttpSessionBindingListener、HttpSessionActivationListener；
第三类：与ServletRequest有关的Listener接口
包括：ServletRequestListner、ServletRequestAttributeListener

三、在 spring boot 中的使用

spring boot 使用 Servlet

两种方式：

1、使用spring boot提供的ServletRegistrationBean 注册Servlet

2、使用原生servlet注解定义Servlet

两种方式的本质都是一样的，都是去ServletRegistrationBean 注册自定义Servlet

方式1:

①、先定义Servlet：

public class MyServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        System.out.println(">>>>>>>>>>doGet()<<<<<<<<<<<");
        doPost(req, resp);
    }
 
    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        System.out.println(">>>>>>>>>>doPost()<<<<<<<<<<<");
        resp.setContentType("text/html;charset=utf-8");
        PrintWriter out = resp.getWriter();
        out.write("自定义 Servlet");
    }
}

②、注册 Servlet

将 Servelt 注册成 Bean。在上文创建的 WebConfig 类中添加如下代码：

@Configuration
public class WebConfig {
@Bean
public ServletRegistrationBean servletRegistrationBean() {
    return new ServletRegistrationBean(new MyServlet(), "/mv");//匹配要处理的url
} 
 
}

结果如下：

image.png

方式2： 1）启动类里面增加 @ServletComponentScan，进行扫描
2）新建一个Servlet类，extends HttpServlet ，并实现对应的接口
3）@WebServlet标记一个类为servlet，被spring进行扫描

@Component
@WebServlet(urlPatterns = "/map", description = "Servlet的说明")
public class MyServlet2 extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        System.out.println(">>>>>>>>>>doGet()<<<<<<<<<<<");
        doPost(req, resp);
    }
 
    @Override
    protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        System.out.println(">>>>>>>>>>doPost()<<<<<<<<<<<");
        resp.setContentType("text/html;charset=utf-8");
        PrintWriter out = resp.getWriter();
        out.println("<html>");
        out.println("<head>");
        out.println("<title>Hello World</title>");
        out.println("</head>");
        out.println("<body>");
        out.println("<h1>大家好，我的名字叫Servlet</h1>");
        out.println("</body>");
        out.println("</html>");
    }
}

image.png

spring boot 使用 Filter

两种方式：

1、使用spring boot提供的FilterRegistrationBean注册Filter

2、使用原生servlet注解定义Filter

两种方式的本质都是一样的，都是去FilterRegistrationBean注册自定义Filter

方式1:

①、先定义Filter：

public class MyFilter implements Filter {
 
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("=======初始化过滤器MyFilter =========");
    }
 
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain filterChain) throws IOException, ServletException {
        long start = System.currentTimeMillis();
        filterChain.doFilter(request, response);
        System.out.println("filter 耗时：" + (System.currentTimeMillis() - start));
    }
 
    @Override
    public void destroy() {
        System.out.println("=======销毁过滤器MyFilter =========");
    }
 
}

②、注册自定义Filter

@Configuration
public class WebConfig{
    @Bean
    public FilterRegistrationBean registrationBean() {
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean(new MyFilter());
        filterRegistrationBean.addUrlPatterns("/mv");
        return filterRegistrationBean;
    }
}

方式2：

1）启动类里面增加 @ServletComponentScan，进行扫描

2）新建一个Filter类，implements Filter，并实现对应的接口

3） @WebFilter 标记一个类为filter，被spring进行扫描

@WebFilter(filterName = "myFilter2", urlPatterns = "/map")
public class MyFilter2 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("过滤器初始化");
    }
 
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("执行过滤操作");
        filterChain.doFilter(servletRequest, servletResponse);
    }
 
    @Override
    public void destroy() {
        System.out.println("过滤器销毁");
    }
}
 
    return registrationBean;
 
}

spring boot 使用 Interceptor

1、创建我们自己的拦截器类并实现 HandlerInterceptor 接口。

2、创建一个Java类继承WebMvcConfigurerAdapter，并重写 addInterceptors 方法。

3、实例化我们自定义的拦截器，然后将对像手动添加到拦截器链中（在addInterceptors方法中添加）。

①、定义拦截器：

public class MyInterceptor implements HandlerInterceptor {
  
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {        
        System.out.println("========preHandle=========");
        System.out.println(((HandlerMethod)handler).getBean().getClass().getName());
        System.out.println(((HandlerMethod)handler).getMethod().getName());
        
        request.setAttribute("startTime", System.currentTimeMillis());
     
        return true;
 
    }
    
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)
            throws Exception {
        System.out.println("========postHandle=========");
        Long start = (Long) request.getAttribute("startTime");
        System.out.println("耗时:"+(System.currentTimeMillis() - start));
    }
 
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception exception)
            throws Exception {
        System.out.println("========afterCompletion=========");
        Long start = (Long) request.getAttribute("startTime");
        System.out.println("耗时:"+(System.currentTimeMillis() - start));     
        System.out.println(exception);
    }
}

②、注册拦截器

编写拦截器后，我们还需要将其注册到拦截器链中，如下配置：

@Configuration
public class WebConfig extends WebMvcConfigurerAdapter{
 
    @Autowired
    private TimeInterceptor timeInterceptor;
  
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(timeInterceptor);
    }
 
}

请求一个 controller ，结果如下：

image.png

最后说明下，我们上面用到的 WebMvcConfigurerAdapter 并非只是注册添加拦截器使用，其顾名思义是做Web配置用的，它还可以有很多其他作用，通过下面截图便可以大概了解，具体每个方法都是干什么用的，留给大家自己研究（其实都大同小异也很简单）。  

最后强调一点：只有经过DispatcherServlet 的请求，才会走拦截器链，我们自定义的Servlet 请求是不会被拦截的，比如我们自定义的Servlet地址 http://localhost:8080/myservlet 是不会被拦截器拦截的。不管是属于哪个Servlet 只要符合过滤器的过滤规则，过滤器都会拦截。

spring boot 使用 Listener

同样也是两种方式
方式1：
①、编写监听器

public class MyHttpSessionListener implements HttpSessionListener {
 
    @Override
    public void sessionCreated(HttpSessionEvent se) {
        System.out.println("Session 被创建");
    }
 
    @Override
    public void sessionDestroyed(HttpSessionEvent se) {
        System.out.println("ServletContex初始化");
    }
}

②、注册监听器

注册监听器为 Bean，在 WebConfig 配置类中添加如下代码：

@Bean
public ServletListenerRegistrationBean<MyHttpSessionListener> listenerRegistrationBean() {
    return new ServletListenerRegistrationBean<>(new MyHttpSessionListener());
}

方式2：

@WebListener //使用注解方式注册
public class MyServletContextListener implements ServletContextListener {
    @Override
    public void contextInitialized(ServletContextEvent servletContextEvent) {
        System.out.println("ServletContex初始化");
        System.out.println(servletContextEvent.getServletContext().getServerInfo());
    }
 
    @Override
    public void contextDestroyed(ServletContextEvent servletContextEvent) {
        System.out.println("ServletContex销毁");
    }
}

参考

Spring Boot 的Servlet、Filter 、 Listener和Interceptor
Interceptor、Filter、Servlet的区别 - china_coding
Servlet、Filter、Listener、Interceptor - sikewang

avatar
文章
阅读
粉丝