过滤器的介绍及使用

提示：文章写完后，目录可以自动生成，如何生成可参考右边的帮助文档

---

前言

• 概念：Filter 表示过滤器，是 JavaWeb 三大组件(Servlet、Filter、Listener)之一。

• 过滤器可以把对资源的请求拦截下来，从而实现一些特殊的功能。

• 过滤器一般完成一些通用的操作，比如：权限控制、统一编码处理、敏感字符处理等等…

---

一、过滤器是什么？

示例：pandas 是基于NumPy 的一种工具，该工具是为了解决数据分析任务而创建的。

二、过滤器代码实现

过滤器具体的处理逻辑如下：

A. 获取本次请求的URI

B. 判断本次请求, 是否需要登录, 才可以访问

C. 如果不需要，则直接放行

D. 判断登录状态，如果已登录，则直接放行

E. 如果未登录, 则返回未登录结果

1.定义登录校验过滤器

自定义一个过滤器 LoginCheckFilter 并实现 Filter 接口, 在doFilter方法中完成校验的逻辑。 那么接下来, 我们就根据上述分析的步骤, 来完成具体的功能代码实现:

代码如下（示例）：

@Slf4j
@WebFilter(value = "/*")
public class CheckLoginFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        log.info("-------登陆过滤器开启过滤--------");
    }

    //确定需要放行的路径
    String[] urls = {"/backend/**","/front/**","/employee/login"};

    //路径匹配类
    AntPathMatcher antPathMatcher = new AntPathMatcher();


    public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain) throws ServletException, IOException {
        //0.获取request中的方法,将req和resp进行强转
        HttpServletRequest request = (HttpServletRequest) req;
        HttpServletResponse response = (HttpServletResponse) resp;

        //1.获取用户访问的路径
        String requestURI = request.getRequestURI();
        System.out.println(requestURI);
        //例如:  /backend/index.html    /employee/page

        //2.判断用户访问的路径是否在放行的路径中,若是直接放行
        boolean flag = checkURI(requestURI);
        if (flag) {
            chain.doFilter(request,response);
            return;
        }

        //3.若是需要拦截的路径.再获取session中登陆对象
        Object userId = request.getSession().getAttribute("employee");

        //4.若有对象,直接放行
        if (userId != null) {
            chain.doFilter(request,response);
            return;
        }

        //5.若没有对象,返回R.error("NOTLOGIN")
        R<Object> r = R.error("NOTLOGIN");

        //将r转成json数据写回浏览器
        response.setContentType("application/json;charset=utf-8");//可以省略
        response.getWriter().print(JSON.toJSONString(r));
    }

    private boolean checkURI(String requestURI) {
        for (String url : urls) {
            //若当前请求的路径和url能够匹配上就放行
            if (antPathMatcher.match(url, requestURI)) {
                return true;
            }
        }
        return false;
    }
}

AntPathMatcher 拓展:

介绍:Spring中提供的路径匹配器 ;
通配符规则:**

符号	含义
?	匹配一个字符
*	匹配0个或多个字符
**	匹配0个或多个目录/字符

2.开启组件扫描

需要在引导类上, 加上Servlet组件扫描的注解, 来扫描过滤器配置的@WebFilter注解， 扫描上之后， 过滤器在运行时就生效了
代码如下（示例）：

@SpringBootApplication
@MapperScan(basePackages = "com.itheima.reggie.mapper")
//注意: springboot默认是不会扫描servlet的注解，如果需要扫描servlet或者是filter的注解需要自己开启
@ServletComponentScan
public class ReggieApplication {
    public static void main(String[] args) {
        SpringApplication.run(ReggieApplication.class, args);
    }
}

@ServletComponentScan 的作用:

在SpringBoot项目中, 在引导类/配置类上加了该注解后, 会自动扫描项目中(当前包及其子包下)的@WebServlet , @WebFilter , @WebListener 注解, 自动注册Servlet的相关组件 ;

---

总结

拦截器和过滤器的区别:

• 归属不同：Filter属于Servlet技术，Interceptor属于SpringMVC技术
• 拦截内容不同：Filter对所有访问进行增强，Interceptor仅针对SpringMVC的访问进行增强