springboot中使用filter过滤器

一、filter过滤器的介绍

filter过滤器其实是JavaEE中的规范，JavaWeb中的三大组件是filter过滤器、listener监听器，servlet服务。
过滤器的作用就是把请求拦截下来，从而对请求进行一些特殊操作，比如检验用户是否登录，判断权限，设置编码格式、敏感字符处理等。

filter过滤器中有三个方法：

package javax.servlet;
public interface Filter {
    /**
     *  servlet 容器在实例化过滤器后只调用一次 init 方法。
	 *	init 方法必须成功完成，然后才会要求筛选器执行任何筛选工作。
     */
    public default void init(FilterConfig filterConfig) throws ServletException {}
    /**
     *doFilter每次由于客户端请求链末端的资源而导致请求/响应对通过链时，容器都会调用筛选器的方法。
	传递给此方法的筛选器链允许筛选器将请求和响应传递给链中的下一个实体。
     */
    public void doFilter(ServletRequest request, ServletResponse response,
            FilterChain chain) throws IOException, ServletException;

        /*由 Web 容器调用，以向筛选器指示它正在停止服务。
        仅当筛选器的 doFilter 方法中的所有线程退出或超时期限过后，才会调用此方法。
        Web 容器调用此方法后，它不会在此筛选器实例上再次调用 doFilter 方法。 
        此方法使筛选器有机会清理正在保留的任何资源（例如，内存、文件句柄、线程），
        并确保任何持久状态与筛选器在内存中的当前状态同步。默认实现是无操作的。*/
    public default void destroy() {}
}

分别是初始化方法init，拦截方法doFilter，销毁方法destroy
当请求路径正好被filter配置的拦截规则拦截时，servlet过滤器将先执行doFilter方法。FilterChain参数用于访问后续过滤器。
filter的生命周期由web容器负责。

二、在spring boot中使用filter

以检验用户石佛偶登录为例：未登录状态下请求服务器端，请求将被拦截；对登录请求以及页面资源加载请求进行放行

1.首先在源码目录中创建一个filter的包，然后创建一个自定义的filter实现Filter接口：

//@@WebFilter(urlPatterns = "/*")表示要拦截的请求，/*表示拦截所有请求
@WebFilter(urlPatterns = "/*")
public class LoginFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
       //将形参servletRequest强制转换为HttpServletRequest类型，以便获取请求的URL地址和请求头
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        String requestURI = request.getRequestURI();
        if (requestURI.contains("/login")) {
            //  如果是登录请求直接放行
            filterChain.doFilter(servletRequest, servletResponse);
        } else {
            // 获取请求头中的验证token
            String token = request.getHeader("Authorization");
            try {
                JwtUtil.validateToken(token);//检验token的有效性
            } catch (Exception e) {
                System.out.println("=========token认证失败。");
                return;
            }
            System.out.println("=========token认证成功。");
            filterChain.doFilter(servletRequest, servletResponse);
        }
    }
}

2.让spring boot加载自定义的过滤器

由于spring boot项目默认以jar的方式打包，没有使用web.xml配置文件，所以我们可以通过注解的方式在springboot的主类上加@ServletComponentScan

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

@ServletComponentScan可以实现对servlet、filter、listener的扫描

使用postman测试接口：