Spring Boot 定义过滤器、监听器、拦截器

一、自定义过滤器

创建一个过滤器，实现javax.servlet.Filter接口，并重写其中的init、doFilter、destory方法。

package com.example.filter;
 
import java.io.IOException;
 
import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;
import javax.servlet.annotation.WebFilter;
/**
 * 实现javax.servlet.Filter,覆盖其三个方法
 * @author Administrator
 *
 */
@WebFilter(filterName="customFilter",urlPatterns="/*")
public class CustomFilter implements Filter{
 
    @Override
    public void destroy() {
        System.out.println("CustomFilter过滤器销毁");
        
    }
 
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        System.out.println("CustomFilter指定过滤器操作......");
        //执行操作后必须doFilter
        chain.doFilter(request, response);
    }
 
    @Override
    public void init(FilterConfig arg0) throws ServletException {
        System.out.println("CustomFilter初始化......");
    }
 }
    
 

 

二、自定义监听器

创建一个过滤器，实现ServletContextListener接口

package com.example.listener;
 
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;
 
/**
 * 实现ServletContextListener，覆盖其两个方法
 * @author Administrator
 *
 */
@WebListener
public class CustomListener implements ServletContextListener{
 
    @Override
    public void contextDestroyed(ServletContextEvent servletContext) {
        System.out.println("servletContext销毁......");
        
    }
 
    @Override
    public void contextInitialized(ServletContextEvent servletContext) {
        System.out.println("servletContext初始化......");
    }
 
}

 

创建一个session监听器，监听session的创建和销毁

package com.example.listener;
 
import javax.servlet.annotation.WebListener;
import javax.servlet.http.HttpSessionEvent;
import javax.servlet.http.HttpSessionListener;
 
/**
 * 实现HttpSessionListener接口，监视session的动态
 * @author Administrator
 *
 */
@WebListener
public class SessionListener implements HttpSessionListener{
 
    @Override
    public void sessionCreated(HttpSessionEvent session) {
        System.out.println("session创建成功......");
        
    }
 
    @Override
    public void sessionDestroyed(HttpSessionEvent session) {
        System.out.println("session销毁......");
        
    }
} 

 

三、自定义拦截器

步骤：

1、创建自己的拦截器实现HandlerInterceptor接口

2、创建自己的拦截器链，继承WebMvcConfigurerAdapter类，重写addInterceptors方法。

3、实例化自己的拦截器，并加入到拦截器链中。

拦截器一：

package com.example.Interceptor;
 
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
 
public class CustomInterceptor implements HandlerInterceptor {
 
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object object,
            Exception exception) throws Exception {
        //在整个请求结束之后被调用，也就是在DispatcherServlet 渲染了对应的视图之后执行（主要是用于进行资源清理工作）
        System.out.println("3. 整个请求结束之后被调用......CustomInterceptor1......");
    }
 
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object object, ModelAndView view)
            throws Exception {
        // 请求处理之后进行调用，但是在视图被渲染之前
        System.out.println("2. 请求处理之后进行调用，但是在视图被渲染之前......CustomInterceptor1......");
    }
 
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object object) throws Exception {
        // 在请求处理之前进行调用
        System.out.println("1. 在请求处理之前进行调用......CustomInterceptor1......");
        // 只有返回true才会继续向下执行，返回false取消当前请求
        return true;
    }
 
}

 

拦截器二：

package com.example.Interceptor;
 
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
 
public class CustomInterceptor2 implements HandlerInterceptor {
 
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object object,
            Exception exception) throws Exception {
        //在整个请求结束之后被调用，也就是在DispatcherServlet 渲染了对应的视图之后执行（主要是用于进行资源清理工作）
        System.out.println("3. 整个请求结束之后被调用......CustomInterceptor2......");
    }
 
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object object, ModelAndView view)
            throws Exception {
        // 请求处理之后进行调用，但是在视图被渲染之前
        System.out.println("2. 请求处理之后进行调用，但是在视图被渲染之前......CustomInterceptor2......");
    }
 
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object object) throws Exception {
        // 在请求处理之前进行调用
        System.out.println("1. 在请求处理之前进行调用......CustomInterceptor2......");
        // 只有返回true才会继续向下执行，返回false取消当前请求
        return true;
    }
 
}

 

自定义拦截器链并加入自定义的拦截器

package com.example.adapter;
 
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
 
import com.example.Interceptor.CustomInterceptor;
import com.example.Interceptor.CustomInterceptor2;
 
/**
 * 继承WebMvcConfigurerAdapter，复写addInterceptors方法
 * @author Administrator
 *
 */
@Configuration
public class WebAdapter extends WebMvcConfigurerAdapter{
 
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //众多的拦截器组成了一个拦截器链
        /**
         * 主要方法说明：
         * addPathPatterns 用于添加拦截规则
         * excludePathPatterns 用户排除拦截
         */
        registry.addInterceptor(new CustomInterceptor()).addPathPatterns("/*");
        registry.addInterceptor(new CustomInterceptor2()).addPathPatterns("/*");
        super.addInterceptors(registry);
    }
}

 总结:

1.过滤器：所谓过滤器顾名思义是用来过滤的，在java web中，你传入的request,response提前过滤掉一些信息，或者提前设置一些参数，然后再传入servlet或者struts的action进行业务逻辑，比如过滤掉非法url（不是login.do的地址请求，如果用户没有登陆都过滤掉）,或者在传入servlet或者struts的action前统一设置字符集，或者去除掉一些非法字符（聊天室经常用到的，一些骂人的话）。filter 流程是线性的， url传来之后，检查之后，可保持原来的流程继续向下执行，被下一个filter, servlet接收等.

　　Servlet中的过滤器Filter是实现了javax.servlet.Filter接口的服务器端程序，主要的用途是过滤字符编码、做一些业务逻辑判断等。其工作原理是，只要你在web.xml文件配置好要拦截的客户端请求，它都会帮你拦截到请求，此时你就可以对请求或响应(Request、Response)统一设置编码，简化操作；同时还可进行逻辑判断，如用户是否已经登陆、有没有权限访问该页面等等工作。它是随你的web应用启动而启动的，只初始化一次，以后就可以拦截相关请求，只有当你的web应用停止或重新部署的时候才销毁，

2.监听器：这个东西在c/s模式里面经常用到，他会对特定的事件产生产生一个处理。监听在很多模式下用到。比如说观察者模式，就是一个监听来的。又比如struts可以用监听来启动。Servlet监听器用于监听一些重要事件的发生，监听器对象可以在事情发生前、发生后可以做一些必要的处理。

　　现在来说说Servlet的监听器Listener，它是实现了javax.servlet.ServletContextListener 接口的服务器端程序，它也是随web应用的启动而启动，只初始化一次，随web应用的停止而销毁。主要作用是： 做一些初始化的内容添加工作、设置一些基本的内容、比如一些参数或者是一些固定的对象等等

3.java的拦截器 主要是用在插件上，扩展件上比如 hivernate spring struts2等 有点类似面向切片的技术，在用之前先要在配置文件即xml文件里声明一段的那个东西。

　　拦截器是在面向切面编程中应用的，就是在你的service或者一个方法前调用一个方法，或者在方法后调用一个方法。是基于JAVA的反射机制。拦截器不是在web.xml，比如struts在struts.xml中配置

转载至：https://blog.csdn.net/linabc123000/article/details/69245148