Springboot使用Filter的便捷方法（无需配置文件或者配置类）

Springboot使用Filter的便捷方法（无需配置文件或者配置类）

以LogFilter为例

创建自己的Filter

    public class LogFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
    }

    @Override
    public void destroy() {
    }
}

• 创建自己的Filter类，实现 javax.servlet.Filter 类，其中有三个方法，init是初始化Filter时调用的，destroy是销毁Filter时调用的，doFilter则是访问相应url时调用的。

接下来在此类上加上注解标识此filter的调用顺序和过滤url

@Order(1)
@WebFilter(filterName = "LogFilter", urlPatterns = "/*")
public class LogFilter implements Filter { 

• @Order 数值越低代表调用顺序越靠前
• @WebFilter 主要标注了此Filter的过滤路径

在主类上标注 @ServletComponentScan

@SpringBootApplication
@ServletComponentScan
public class FilterApplication {
    public static void main(String[] args) {
        SpringApplication.run(FilterApplication.class, args);
    }
} 

• @ServletComponentScan 注解让springboot帮助我们扫到Filter，就无需再配置了

简单测试

@Order(1)
@WebFilter(filterName = "LogFilter", urlPatterns = "/*")
public class LogFilter implements Filter {

    private Logger logger = LoggerFactory.getLogger(LogFilter.class);

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        logger.info("init");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        logger.info("doFilter");
        filterChain.doFilter(servletRequest, servletResponse);
    }

    @Override
    public void destroy() {
        logger.info("destroy");
    }
}

• 写了一个简单的测试用例，每个方法执行后输出一下。值得注意的是doFilter方法完了以后一定要调用一下filterChain.doFilter(servletRequest, servletResponse);继续调用下一个filter。

测试结果

（无需配置文件或者配置类）测试无误，执行正常。