Springboot实现过滤器

news2024/11/24 8:56:55

一、导言

在Spring Boot中，过滤器是一种用于对HTTP请求进行预处理和后处理的组件。相较于拦截器，过滤器属于Servlet规范的一部分，它能够在请求进入Web容器之前或返回给客户端之前进行操作。

要在Spring Boot中实现过滤器，可以按照以下步骤进行操作：

创建一个实现了javax.servlet.Filter接口的过滤器类，并实现其中的方法，例如init用于初始化过滤器，doFilter用于实现过滤逻辑，destroy用于销毁过滤器。
在Spring Boot的配置类中，通过@Bean注解将过滤器类注册为一个Bean。
使用@ServletComponentScan注解来启用扫描Servlet组件（包括过滤器）的功能。
运行应用程序后，过滤器将会对符合条件的请求进行过滤处理。

下面是一个简单的示例代码：

@WebFilter(filterName = "MyFilter ",urlPatterns = "/*")//拦截全部
public class MyFilter implements Filter {
    /**
     *  servlet 容器在实例化过滤器后只调用一次 init 方法。
	 *	init 方法必须成功完成，然后才会要求筛选器执行任何筛选工作。
     */
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        // 初始化逻辑
    }
    
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        // 过滤逻辑
        chain.doFilter(request, response);
    }
    
    @Override
    public void destroy() {
        // 销毁逻辑
    }
}

在上述示例中，使用了@WebFilter注解将MyFilter类标记为过滤器，并通过urlPatterns拦截全部。

注意：为了使Spring Boot能够扫描到自定义的过滤器类，需要在启动类上使用@ServletComponentScan注解来开启扫描Servlet组件的功能。

@Slf4j
@ServletComponentScan//开启扫描Servlet组件的功能。
@SpringBootApplication
public class ReggieApplication {

    public static void main(String[] args) {
        SpringApplication.run(ReggieApplication.class, args);
        log.info("项目运行成功");
    }
}

通过实现过滤器，可以对HTTP请求进行一些通用操作，如身份验证、请求日志记录、字符编码设置等。过滤器在Servlet容器层面运行，比拦截器更早执行，因此可以对请求进行更底层的处理。

案例

实现未登录不能访问不需要处理的请求路径之外的路径操作：

案例需求：

以下路径可以跳过用户登录直接访问：

“/employee/login”,
“/employee/logout”,
"/backend/",
“/front/",
"/common/”,
“/user/sendMsg”,//移动端发送短信
“/user/login”,//移动端登录
//swagger
“/doc.html”,
"/webjars/",
“/swagger-resources”,
“/v2/api-docs”

若访问除上面的路径之外，需被拦截过滤看是否已经登录，若未登录，则直接跳到登录界面，若判断已经登录，则放行正常访问：

代码实现：

编写登录过滤器：LoginCheckFilter：
这里包括了管理端和用户端两个登录过滤器

/**
 * 检查用户是否完成登录  
 * 若未完成不能访问除指定路径外的其他路径，直接跳到登录界面
 * 
 */
@Slf4j
@WebFilter(filterName = "LoginCheckFilter",urlPatterns = "/*")//拦截全部
public class LoginCheckFilter implements Filter {

    //路径匹配器，支持通配符
    public static final AntPathMatcher PATH_MATCHER = new AntPathMatcher();

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        HttpServletResponse response = (HttpServletResponse) servletResponse;

        //1、获取本次请求的URI
        String requestURI = request.getRequestURI();// /backend/index.html

        log.info("拦截到请求：{}",requestURI);

        //定义不需要处理的请求路径
        String[] urls = new String[]{
                "/employee/login",
                "/employee/logout",
                "/backend/**",
                "/front/**",
                "/common/**",
                "/user/sendMsg",//移动端发送短信
                "/user/login",//移动端登录
                //swagger
                "/doc.html",
                "/webjars/**",
                "/swagger-resources",
                "/v2/api-docs"

        };

        //2、判断本次请求是否需要处理
        boolean check = check(urls, requestURI);
        //3、如果不需要处理，则直接放行
        if (check == true) {
            log.info("本次请求不处理，直接放行：{}",requestURI);
            filterChain.doFilter(request,response);
            return;
        }
        //4、判断登录状态，如果已登录，则直接放行(登录状态session里面有登录对象的值）  管理端
        if (request.getSession().getAttribute("employee") != null){
            log.info("用户已登录，用户id为：{}",request.getSession().getAttribute("employee"));

            long id = Thread.currentThread().getId();
            log.info("线程id为：{}",id);//处理公共字段无法用session得到用户id用   的线程测试


            //登录成功，将用户id存到一次线程当中，方便后续修改或增加数据时，得到更新或修改数据的操作用户的id
            Long employeeId = (Long) request.getSession().getAttribute("employee");
            BaseContext.setCurrentId(employeeId);

            filterChain.doFilter(request,response);
            return;
        }


        //4、判断登录状态，如果已登录，则直接放行(登录状态session里面有登录对象的值）  移动端
        if (request.getSession().getAttribute("user") != null){
            log.info("用户已登录，用户id为：{}",request.getSession().getAttribute("user"));

            long id = Thread.currentThread().getId();
            log.info("线程id为：{}",id);//处理公共字段无法用session得到用户id用   的线程测试


            //登录成功，将用户id存到一次线程当中，方便后续修改或增加数据时，得到更新或修改数据的操作用户的id
            Long userId = (Long) request.getSession().getAttribute("user");
            BaseContext.setCurrentId(userId);

            filterChain.doFilter(request,response);
            return;
        }
            log.info("用户未登录");
            //5、如果未登录则返回未登录结果，通过输出流方式向客户端页面响应数据
            response.getWriter().write(JSON.toJSONString(R.error("NOTLOGIN")));
            return;

    }

    /**
     * 路径匹配，检查本次请求是否需要放行参数 urls 是一个包含若干URL字符串的数组。
     * 参数 requestURI 是一个 HTTP 请求的 URI 字符串。
     * 该函数使用 Spring MVC 中的 PathMatcher 对象进行路径匹配，判断 requestURI 是否与 urls 中的某个 URL 匹配。
     * 如果匹配成功，则返回 true；否则返回 false。
     * @param urls
     * @param requestURI
     * @return
     */
    public boolean check(String[] urls,String requestURI){
        for (String url:urls) {
            boolean match = PATH_MATCHER.match(url, requestURI);
            if (match == true) {
                return true;
            }
        }
        return false;
    }

}

其中若用户未登录，执行下列的语句：给前端响应

  			log.info("用户未登录");
            //5、如果未登录则返回未登录结果，通过输出流方式向客户端页面响应数据
            response.getWriter().write(JSON.toJSONString(R.error("NOTLOGIN")));
            return;