【1】XML配置形式

也就是在过滤器中使用Spring容器中的bean。

我们使用过滤器一般是这么配置的:

<filter>  
  <filter-name>sysVisitFilter</filter-name>  
  <filter-class>com.hh.core.filter.SysVisitFilter</filter-class> 
</filter>  
<filter-mapping>
  <filter-name>sysVisitFilter</filter-name>
  <url-pattern>/*</url-pattern>
</filter-mapping>

这样的配置无法在过滤器中使用spring bean,因为filter比bean先加载。

也就是spring会先加载filter指定的类到container中,这样filter中注入的spring bean就为null了。


正确配置如下:

<filter>  
  <filter-name>sysVisitFilter</filter-name>  
  <filter-class>org.springframework.web.filter.DelegatingFilterProxy</filter-class> 
  <init-param>  
   <param-name>targetFilterLifecycle</param-name>  
   <param-value>true</param-value>  
  </init-param>  
</filter>  
<filter-mapping>
  <filter-name>sysVisitFilter</filter-name>
  <url-pattern>/*</url-pattern>
</filter-mapping>

Spring 配置文件中配置该bean:

<bean id="sysVisitFilter" class="com.hh.core.filter.SysVisitFilter"></bean>

DelegatingFilterProxy类遵循filter-name-bean的原则,会根据web.xml中filter-name的值查找到spring配置文件中id与filter-name相同的值,然后把接受到的处理信息传递给相对应的类处理。

另外关于targetFilterLifecycle,查看DelegatingFilterProxy源码部分如下:

 // 设置是否反射调用目标过滤器的init和destroy方法,默认为false-目标bean依赖spring应用上下文管理生命周期
 // 如果设置为true意味着servlet容器将会控制目标Filter的生命周期,使用代理委派相应的调用
 
public void setTargetFilterLifecycle(boolean targetFilterLifecycle) {
	this.targetFilterLifecycle = targetFilterLifecycle;
}


测试结果如下:

这里写图片描述


【2】SpringBoot2.0中使用代码注册Filter

SysVisitFilter 示例如下:

public class SysVisitFilter implements Filter {

    private static final Logger log = LoggerFactory.getLogger(SysVisitFilter.class);

    @Autowired
    ISysVisitLogService sysVisitLogService;

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        log.debug("SysVisitFilter is to be inited...");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        String param = httpRequest.getParameter("param");
        String mobileNum = httpRequest.getParameter("mobileNum");
        String remoteIP = IpUtils.getRealRemoteIP(httpRequest);
        try {
            if(ToolUtils.isNotEmpty(param)){
                param = AesUtils.decryptBase64(param, DataInterfaceUtil.aesKey);
                log.debug("the param is :"+param);
                Map<String, Object> mapFromParam = ToolUtils.getMapFromParam(param);
                mobileNum = (String) mapFromParam.get("mobileNum");
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
        StringBuffer url = httpRequest.getRequestURL();
        SysVisitLog sysVisitLog = new SysVisitLog();
        sysVisitLog.setMobileNum(mobileNum);
        sysVisitLog.setUrl(url.toString());
        sysVisitLog.setRemoteIp(remoteIP);
        sysVisitLog.setCreateTime(new Date());
        sysVisitLogService.insertVisitLog(sysVisitLog);
        log.debug("即将要插入的访问日志 :"+sysVisitLog);
        chain.doFilter(request,response);
    }

    @Override
    public void destroy() {


    }
}

MyFilterConfig 编码注册如下:

@Configuration
public class MyFilterConfig {

    @Bean(name="sysVisitFilter")
    public SysVisitFilter sysVisitFilter(){
        return new SysVisitFilter();
    }

    @Bean
    public FilterRegistrationBean sysVisitFilterBean() {
        FilterRegistrationBean registrationBean = new FilterRegistrationBean();
        registrationBean.setFilter(new DelegatingFilterProxy("sysVisitFilter"));
        registrationBean.addInitParameter("targetFilterLifecycle","true");
        registrationBean.addUrlPatterns("/*");
        registrationBean.addInitParameter("exclusions", "*.js,*.gif,*.jpg,*.png,*.css,*.ico");
        registrationBean.setDispatcherTypes(DispatcherType.REQUEST);
        // 这里这里这里
        registrationBean.setEnabled(false);
        return registrationBean;
    }
}

需要额外注意下面这行代码:

 registrationBean.setEnabled(false);

如果没有该代码,系统中的过滤器链如下图:

这里写图片描述

delegatingFilterProxysysVisitFilter同时存在,会发生什么现象?你的请求会在sysVisitFilter被拦截两次!!!


如果添加上该行代码,系统中的过滤器链如下图:

 registrationBean.setEnabled(false);

这里写图片描述

sysVisitFilter不但能正常使用,而且还能获取到Spring容器中的Bean!!!

更多详情可以查看DelegatingFilterProxy 源码了解。

Logo

权威|前沿|技术|干货|国内首个API全生命周期开发者社区

更多推荐