springmvc中filter的详解及应用案例

一、Filter介绍

Filter可认为是Servlet的一种“变种”，它主要用于对用户请求(HttpServletRequest)进行预处理,也可以对服务器响应(HttpServletResponse)进行后处理，是个典型的处理链。
　 它与Servlet的区别在于：它不能直接向用户生成响应。完整的流程是：Filter对用户请求进行预处理，接着将请求交给Servlet进行处理并生成响应，最后Filter再对服务器响应进行后处理。

Filter的用处

在HttpServletRequest到达Servlet之前，拦截客户的HttpServletRequest。
　　根据需要检查HttpServletRequest，也可以修改HttpServletRequest头和数据。
　　在HttpServletResponse到达客户端之前，拦截HttpServletResponse。
　　根据需要检查HttpServletResponse,也可以修改HttpServletResponse头和数据。

Filter的种类

用户授权的Filter：Filter负责检查用户请求，根据请求过滤用户非法请求。
　　日志Filter：详细记录某些特殊的用户请求。
　　负责解码的Filter：包括对非标准编码的请求解码。
　　Filter可拦截多个请求或响应；一个请求或响应也可被多个请求拦截。
init():在服务器启动后，会创建Filter对象，然后调用init方法。只执行一次。用于加载资源

Filter接口方法

init()：初始化方法，只会执行一次。
doFilter()：每一次请求被拦截资源时，会执行。执行多次
destroy()：在服务器关闭后，Filter对象被销毁。如果服务器是正常关闭，则会执行,只执行一次。用于释放资源

二、使用Filter的两种方式

1、通过@WebFilter

@ServletComponentScan：启动类配置
@WebFilter：自定义Filter配置

package com.demo.filter;

import com.alibaba.fastjson.JSONObject;
import com.demo.config.RequestWrapper;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.annotation.WebInitParam;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.util.Enumeration;
import java.util.Properties;

@WebFilter(value = "/*",initParams = {@WebInitParam(name = "ERR_URL",value = "login.html")},filterName = "myFilter")
public class MyFilter implements Filter {
    private static final Logger logger = LoggerFactory.getLogger(MyFilter.class);

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        Enumeration<String> initParameterNames = filterConfig.getInitParameterNames();
        Properties properties = new Properties();
        while (initParameterNames.hasMoreElements()){
            String name = initParameterNames.nextElement();
            String value = filterConfig.getInitParameter(name);
            properties.setProperty(name,value);
        }

    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        HttpServletRequest httpServletRequest=(HttpServletRequest)request;
        RequestWrapper requestWrapper = new RequestWrapper(httpServletRequest);
        StringBuffer requestUrl = ((HttpServletRequest) requestWrapper).getRequestURL().append(StringUtils.isBlank(requestWrapper.getQueryString()) ? "" : requestWrapper.getQueryString());
        ServletInputStream inputStream = requestWrapper.getInputStream();
        String requestJson= IOUtils.toString(inputStream, StandardCharsets.UTF_8);
        logger.info("请求地址：，请求参数：{}",requestUrl, JSONObject.parseObject(requestJson));
        chain.doFilter(requestWrapper,response);
    }

    @Override
    public void destroy() {

    }
}

2、在配置类中使用FilterRegistrationBean注入bean

    @Bean("myFilter")
    public FilterRegistrationBean myFilter(){
        FilterRegistrationBean filterRegistrationBean = new FilterRegistrationBean();
        filterRegistrationBean.setFilter(new MyFilter());
        String errUrl="login.html";
        filterRegistrationBean.addUrlPatterns("/*");
        filterRegistrationBean.addInitParameter("ERR_URL",errUrl);
        filterRegistrationBean.setName("WebAccessAuthorizeFilterMvc");
        return filterRegistrationBean;
    }

三、使用注解注入Filter原理

1、@ServletComponentScan注解

查看声明可知：@Import({ServletComponentScanRegistrar.class})
会注入ServletComponentScanRegistrar这个bean到spring容器中，会注入ServletComponentRegisteringPostProcessor的bean定义，这个bean定义关联当前包以及下级包。
ServletComponentRegisteringPostProcessor
它是一个BeanFactoryPostProcessor，在bean初始化前进行属性修改，在加载类的时候会注入三个处理器实例：WebServletHandler、WebFilterHandler、WebListenerHandler，分别用于处理Servlet、Filter、Listener的bean。
然后遍历包，找到符合条件的Bean，如果是Servlet，生成ServletRegistrationBean定义；如果是Filter，生成FilterRegistrationBean；如果是Listener，生成ServletListenerRegistrationBean。
后面实例化时，通过注入对应的Servlet、Filter、Listener生成对应的Bean。

    public void doHandle(Map<String, Object> attributes, ScannedGenericBeanDefinition beanDefinition, BeanDefinitionRegistry registry) {
        BeanDefinitionBuilder builder = BeanDefinitionBuilder.rootBeanDefinition(FilterRegistrationBean.class);
        builder.addPropertyValue("asyncSupported", attributes.get("asyncSupported"));
        builder.addPropertyValue("dispatcherTypes", this.extractDispatcherTypes(attributes));
        builder.addPropertyValue("filter", beanDefinition);
        builder.addPropertyValue("initParameters", this.extractInitParameters(attributes));
        String name = this.determineName(attributes, beanDefinition);
        builder.addPropertyValue("name", name);
        builder.addPropertyValue("servletNames", attributes.get("servletNames"));
        builder.addPropertyValue("urlPatterns", this.extractUrlPatterns(attributes));
        registry.registerBeanDefinition(name, builder.getBeanDefinition());
    }