Java 过滤器和拦截器

赵哥窟

发布于 2022-06-26 09:11:38

8330

发布于 2022-06-26 09:11:38

文章被收录于专栏：日常技术分享

过滤器

概念：滤器位于客户端和web应用程序之间，用于检查和修改两者之间流过的请求；在请求到达Servlet/JSP之前，过滤器截获请求；

作用：在客户端的请求访问后端资源之前，拦截这些请求（添加处理）。

Filter接口是过滤器类必须实现的接口，该接口中有三个方法：

init(FilterConfig filterConfig) 该方法是对filter对象进行初始化的方法，仅在容器初始化filter对象结束后被调用一次，参数FilterConfig可以获得filter的初始化参数；

doFilter(ServletRequest request,ServletResponse response,FilterChain chain) 该方法是filter进行过滤操作的方法，是最重要的方法。过滤器实现类必须实现该方法，方法体中可以对request和response进行预处理。其中FilterChain可以将处理后的request和response对象传递到过滤链上的下一个资源。

destroy() 该方法在容器销毁对象前被调用。

过滤器的简单使用,先写一个过滤器的类

mport lombok.extern.slf4j.Slf4j;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@WebFilter(filterName="myFilter",urlPatterns="/*")
@Slf4j
public class MyFilter implements Filter {
    @Override
    public void init(FilterConfig arg0) {
       log.info("初始化过滤器!");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
            throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        log.info("请求地址:"+request.getRequestURI());
        // 交给下一个过滤器或servlet处理
        filterChain.doFilter(servletRequest,servletResponse);

        //HttpServletResponse response = (HttpServletResponse) servletResponse;
        //response.sendRedirect("http://baidu.com");//重定向
    }

    @Override
    public void destroy() {
        log.info("销毁过滤器!");
    }
}

在Application里面引入

@ServletComponentScan

拦截器

编写一个简单的拦截器处理类，请求的拦截是通过HandlerInterceptor 来实现，看到HandlerInterceptor 接口中也定义了三个方法。 preHandle() 这个方法将在请求处理之前进行调用。注意：如果该方法的返回值为false ,将视为当前请求结束，不仅自身的拦截器会失效，还会导致其他的拦截器也不再执行。 postHandle() 只有在 preHandle() 方法返回值为true 时才会执行。会在Controller 中的方法调用之后，DispatcherServlet 返回渲染视图之前被调用。有意思的是：postHandle() 方法被调用的顺序跟 preHandle() 是相反的，先声明的拦截器 preHandle() 方法先执行，而postHandle()方法反而会后执行。 afterCompletion() 只有在 preHandle() 方法返回值为true 时才会执行。在整个请求结束之后， DispatcherServlet 渲染了对应的视图之后执行。

import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

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

@Slf4j
@Component
public class AuthorInterceptor implements HandlerInterceptor {
    /**
     * 目标方法执行前
     * 该方法在控制器处理请求方法前执行，其返回值表示是否中断后续操作
     * 返回 true 表示继续向下执行，返回 false 表示中断后续操作
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        return true;
    }
    /**
     * 目标方法执行后
     * 该方法在控制器处理请求方法调用之后、解析视图之前执行
     * 可以通过此方法对请求域中的模型和视图做进一步修改
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.info("postHandle执行{}", modelAndView);
    }
    /**
     * 页面渲染后
     * 该方法在视图渲染结束后执行
     * 可以通过此方法实现资源清理、记录日志信息等工作
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.info("afterCompletion执行异常{}", ex);
    }
}

将自定义好的拦截器处理类进行注册，并通过addPathPatterns、excludePathPatterns等属性设置需要拦截或需要排除的 URL。

import com.tansun.springcloud.project.b.web.interceptor.AuthorInterceptor;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import javax.annotation.Resource;

@Configuration
public class InterceptorConfig implements WebMvcConfigurer {
    @Resource
    private AuthorInterceptor authorInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //注册自己的拦截器,并设置拦截的请求路径
        //addPathPatterns为拦截此请求路径的请求
        //excludePathPatterns为不拦截此路径的请求
        //addPathPatterns拦截的路径
        String[] addPathPatterns = {
                "/order/**"
        };
        //excludePathPatterns排除的路径
        String[] excludePathPatterns = {
                ""
        };
        registry.addInterceptor(authorInterceptor).addPathPatterns(addPathPatterns).excludePathPatterns(excludePathPatterns);
    }
}

过滤器和拦截器的区别

1.实现原理不同 过滤器和拦截器底层实现方式大不相同，过滤器是基于函数回调的，拦截器则是基于Java的反射机制（动态代理）实现的。这里重点说下过滤器！在我们自定义的过滤器中都会实现一个 doFilter()方法，这个方法有一个FilterChain 参数，而实际上它是一个回调接口。ApplicationFilterChain是它的实现类，这个实现类内部也有一个 doFilter() 方法就是回调方法。

2.使用范围不同 我们看到过滤器实现的是 javax.servlet.Filter 接口，而这个接口是在Servlet规范中定义的，也就是说过滤器Filter 的使用要依赖于Tomcat等容器，导致它只能在web程序中使用。

而拦截器(Interceptor) 它是一个Spring组件，并由Spring容器管理，并不依赖Tomcat等容器，是可以单独使用的。不仅能应用在web程序中，也可以用于Application、Swing等程序中。

3 触发时机不同