基于springBoot的登录拦截校验

最新推荐文章于 2024-05-08 19:47:36 发布

Happy 猫

最新推荐文章于 2024-05-08 19:47:36 发布

阅读量211

点赞数

文章标签： spring boot java servlet

本文链接：https://blog.csdn.net/m0_62829704/article/details/131301678

版权

文章介绍了如何在SpringBoot应用中创建一个登录检查过滤器，通过@WebFilter注解定义过滤规则，拦截所有请求。过滤器首先获取请求URL，然后定义需要放行的路径，如静态资源和登录路径。接着判断请求是否需要放行，如果不符合放行规则，则检查用户是否已登录。已登录则放行，否则返回错误信息。实现过程中使用了AntPathMatcher进行路径匹配。

摘要由CSDN通过智能技术生成

分析业务流程：

1、获取本次请求的url

2、设置需要放行的路径

3、判断本次请求是否需要放行

3.1、符合放行规则，执行放行

3.2、不符合放行规则，判断是否有用户登录

3.2.1、已登录，执行放行

3.2.2、未登录，返回错误信息

前期准备工作：

创建一个filter类来当过滤器，导入对应的包来启动这个过滤类

package com.itheima.reggie.filter;

import com.alibaba.fastjson.JSON;
import com.itheima.reggie.common.R;
import lombok.extern.slf4j.Slf4j;
import org.springframework.util.AntPathMatcher;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

/*
* 检查校验用户是否登录
* */
@Slf4j
@WebFilter(filterName = "LoginCheckFilter",urlPatterns = "/*") //urlPatterns 拦截的路径
public class LoginCheckFilter implements Filter {
@Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        //1、获取本次请求的url
        HttpServletRequest request=(HttpServletRequest)servletRequest;
        HttpServletResponse response=(HttpServletResponse)servletResponse;
        String requestURI = request.getRequestURI();
        log.info("请求URL："+requestURI);
}

要想@WebFilter这个注解生效，需要在启动类加一个注解

@ServletComponentScan //servler 组件扫描注解 加了这个组件扫面之后可以扫描servlet相关注解 例如：@WebFilter 使之生效。

package com.itheima.reggie;

import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.ServletComponentScan;

@Slf4j
@SpringBootApplication //只要在一个SpringBoot项目的普通类中加这个注解，就会变成SpringBoot项目的引导类（启动类）
@ServletComponentScan //servler 组件扫描注解 加了这个组件扫面之后可以扫描servlet相关注解 例如：@WebFilter 使之生效。
public class ReggieApplication {

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

    }
}

到这里就可以拦截生效了，浏览器打开一个路径页面会一片白，因为我们没有放行静态资源。

以下是对应的逻辑代码

package com.itheima.reggie.filter;

import com.alibaba.fastjson.JSON;
import com.itheima.reggie.common.R;
import lombok.extern.slf4j.Slf4j;
import org.springframework.util.AntPathMatcher;

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

/*
* 检查校验用户是否登录
* */
@Slf4j
@WebFilter(filterName = "LoginCheckFilter",urlPatterns = "/*") //urlPatterns 拦截的路径
public class LoginCheckFilter implements Filter {
/*
* 1、获取本次请求的url

2、设置需要放行的路径

3、判断本次请求是否需要放行

3.1、符合放行规则，执行放行

3.2、不符合放行规则，判断是否有用户登录

3.2.1、已登录，执行放行

3.2.2、未登录，返回错误信息*/

    //路径匹配器 支持通配符比较
    public static final AntPathMatcher PATH_MATCHER=new AntPathMatcher();
    //要实现这个doFilter方法、
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        //1、获取本次请求的url
        HttpServletRequest request=(HttpServletRequest)servletRequest;
        HttpServletResponse response=(HttpServletResponse)servletResponse;
        String requestURI = request.getRequestURI();
        log.info("请求URL："+requestURI);
        //2、设置需要放行的路径
        String [] urls=new String[]{
          //所有的静态资源
          "/backend/**",
          "/front/**",
          //登录/退出 的路径
                "/employee/login",
                "/employee/logout",
        };
        //3、判断本次请求是否需要放行
        boolean check = check(urls, requestURI);
        //4、校验是否需要放行 符合放行规则 执行filterChain.doFilter方法
        if(check){
            filterChain.doFilter(request,response);
            return;
        }
        //5、不符合放行规则 当前用户已经登录
        if(request.getSession().getAttribute("employee")!=null){
            log.info("当前用户已登录");
            filterChain.doFilter(request,response);
            return;
        }
        //6、不符合规则 用户也没有登录 直接返回NOTLOGIN错误信息
        response.getWriter().write(JSON.toJSONString(R.error("NOTLOGIN")));
        return;

    }

    public boolean check(String[] urls,String requestURL){
        for (String url:urls){
            if (PATH_MATCHER.match(url,requestURL)){
                return true;
            }
        }
        return false;
    };
}