过滤器Filter

一个处女座的暖男程序猿

于 2023-05-22 17:12:31 发布

阅读量117

点赞数

文章标签： java spring servlet

本文链接：https://blog.csdn.net/weixin_46597615/article/details/130810936

版权

在这里插入图片描述

init方法：过滤器的初始化方法。在web服务器启动的时候会自动的创建Filter过滤器对象，在创建过滤器对象的时候会自动调用init初始化方法，这个方法只会被调用一次。

doFilter方法：这个方法是在每一次拦截到请求之后都会被调用，所以这个方法是会被调用多次的，每拦截到一次请求就会调用一次doFilter()方法。

destroy方法：是销毁的方法。当我们关闭服务器的时候，它会自动的调用销毁方法destroy，而这个销毁方法也只会被调用一次。

在定义完Filter之后，Filter其实并不会生效，还需要完成Filter的配置，Filter的配置非常简单，只需要在Filter类上添加一个注解：@WebFilter，并指定属性urlPatterns，通过这个属性指定过滤器要拦截哪些请求
@WebFilter(urlPatterns = "/") //配置过滤器要拦截的请求路径（ / 表示拦截浏览器的所有请求）
public class DemoFilter implements Filter {
@Override //初始化方法, 只调用一次
public void init(FilterConfig filterConfig) throws ServletException {
System.out.println(“init 初始化方法执行了”);
}

@Override //拦截到请求之后调用, 调用多次
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
    System.out.println("Demo 拦截到了请求...放行前逻辑");
    //放行
    chain.doFilter(request,response);
}

@Override //销毁方法, 只调用一次
public void destroy() {
    System.out.println("destroy 销毁方法执行了");
}

}

当我们在Filter类上面加了@WebFilter注解之后，接下来我们还需要在启动类上面加上一个注解@ServletComponentScan，通过这个@ServletComponentScan注解来开启SpringBoot项目对于Servlet组件的支持。

@ServletComponentScan
@SpringBootApplication
public class TliasWebManagementApplication {

    public static void main(String[] args) {
        SpringApplication.run(TliasWebManagementApplication.class, args);
    }

}

在这里插入图片描述
过滤器当中我们拦截到了请求之后，如果希望继续访问后面的web资源，就要执行放行操作，放行就是调用 FilterChain对象当中的doFilter()方法，在调用doFilter()这个方法之前所编写的代码属于放行之前的逻辑。

在放行后访问完 web 资源之后还会回到过滤器当中，回到过滤器之后如有需求还可以执行放行之后的逻辑，放行之后的逻辑我们写在doFilter()这行代码之后。

@WebFilter(urlPatterns = “/*”)
public class DemoFilter implements Filter {

@Override //初始化方法, 只调用一次
public void init(FilterConfig filterConfig) throws ServletException {
    System.out.println("init 初始化方法执行了");
}

@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
    
    System.out.println("DemoFilter   放行前逻辑.....");

    //放行请求
    filterChain.doFilter(servletRequest,servletResponse);

    System.out.println("DemoFilter   放行后逻辑.....");
    
}

@Override //销毁方法, 只调用一次
public void destroy() {
    System.out.println("destroy 销毁方法执行了");
}

}

在这里插入图片描述
@WebFilter(urlPatterns = “/login”) //拦截/login具体路径
public class DemoFilter implements Filter {
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println(“DemoFilter 放行前逻辑…”);

    //放行请求
    filterChain.doFilter(servletRequest,servletResponse);

    System.out.println("DemoFilter   放行后逻辑.....");
}


@Override
public void init(FilterConfig filterConfig) throws ServletException {
    Filter.super.init(filterConfig);
}

@Override
public void destroy() {
    Filter.super.destroy();
}

}

测试"目录拦截"：@WebFilter(urlPatterns = “/depts/*”) //拦截所有以/depts开头，后面是什么无所谓
public class DemoFilter implements Filter {
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println(“DemoFilter 放行前逻辑…”);

    //放行请求
    filterChain.doFilter(servletRequest,servletResponse);

    System.out.println("DemoFilter   放行后逻辑.....");
}


@Override
public void init(FilterConfig filterConfig) throws ServletException {
    Filter.super.init(filterConfig);
}

@Override
public void destroy() {
    Filter.super.destroy();
}

} 在这里插入图片描述
AbcFilter过滤器*@WebFilter(urlPatterns = “/*”)
public class AbcFilter implements Filter {
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
System.out.println(“Abc 拦截到了请求… 放行前逻辑”);

    //放行
    chain.doFilter(request,response);

    System.out.println("Abc 拦截到了请求... 放行后逻辑");
}

}

DemoFilter过滤器
@WebFilter(urlPatterns = “/*”)
public class DemoFilter implements Filter {
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println(“DemoFilter 放行前逻辑…”);

    //放行请求
    filterChain.doFilter(servletRequest,servletResponse);

    System.out.println("DemoFilter   放行后逻辑.....");
}

}
在这里插入图片描述
通过控制台日志的输出，大家发现AbcFilter先执行DemoFilter后执行，这是为什么呢？

其实是和过滤器的类名有关系。以注解方式配置的Filter过滤器，它的执行优先级是按时过滤器类名的自动排序确定的，类名排名越靠前，优先级越高。

假如我们想让DemoFilter先执行，怎么办呢？答案就是修改类名。

测试：修改AbcFilter类名为XbcFilter，运行程序查看控制台日志

@WebFilter(urlPatterns = “/*”)
public class XbcFilter implements Filter {
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
System.out.println(“Xbc 拦截到了请求…放行前逻辑”);

    //放行
    chain.doFilter(request,response);

    System.out.println("Xbc 拦截到了请求...放行后逻辑");
}

}
登录校验过滤器：LoginCheckFilter
@Slf4j
@WebFilter(urlPatterns = “/*”) //拦截所有请求
public class LoginCheckFilter implements Filter {

@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain chain) throws IOException, ServletException {
    //前置：强制转换为http协议的请求对象、响应对象 （转换原因：要使用子类中特有方法）
    HttpServletRequest request = (HttpServletRequest) servletRequest;
    HttpServletResponse response = (HttpServletResponse) servletResponse;

    //1.获取请求url
    String url = request.getRequestURL().toString();
    log.info("请求路径：{}", url); //请求路径：http://localhost:8080/login


    //2.判断请求url中是否包含login，如果包含，说明是登录操作，放行
    if(url.contains("/login")){
        chain.doFilter(request, response);//放行请求
        return;//结束当前方法的执行
    }


    //3.获取请求头中的令牌（token）
    String token = request.getHeader("token");
    log.info("从请求头中获取的令牌：{}",token);


    //4.判断令牌是否存在，如果不存在，返回错误结果（未登录）
    if(!StringUtils.hasLength(token)){
        log.info("Token不存在");

        Result responseResult = Result.error("NOT_LOGIN");
        //把Result对象转换为JSON格式字符串 (fastjson是阿里巴巴提供的用于实现对象和json的转换工具类)
        String json = JSONObject.toJSONString(responseResult);
        response.setContentType("application/json;charset=utf-8");
        //响应
        response.getWriter().write(json);

        return;
    }

    //5.解析token，如果解析失败，返回错误结果（未登录）
    try {
        JwtUtils.parseJWT(token);
    }catch (Exception e){
        log.info("令牌解析失败!");

        Result responseResult = Result.error("NOT_LOGIN");
        //把Result对象转换为JSON格式字符串 (fastjson是阿里巴巴提供的用于实现对象和json的转换工具类)
        String json = JSONObject.toJSONString(responseResult);
        response.setContentType("application/json;charset=utf-8");
        //响应
        response.getWriter().write(json);

        return;
    }


    //6.放行
    chain.doFilter(request, response);

}

}