springboot中拦截器的配置及原理

本文介绍了在SpringBoot项目中设置拦截器的步骤,包括创建实现HandlerInterceptor接口的拦截器类,以及在配置类中注册拦截器以进行用户登录检查。通过详细代码示例展示了如何完成拦截器的配置。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

拦截器配置及原理

SpringBoot项目中设置拦截器,分为两步:

  • 创建拦截器类;

  • 编写配置类来完成拦截器的配置

以用户登录检查为例,进行讲解


创建拦截器类

  • 首先创建一个interceptor包
  • 在包内创建拦截器类,例如LoginInterceptor类
  • 令该类实现HandlerInterceptor接口
  • 重写接口的三个方法(不用都重写,用到哪个重写哪个)

代码:

public class LoginInterceptor implements HandlerInterceptor {

    /***
     * 在请求处理之前进行调用(Controller方法调用之前)
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("执行了拦截器的preHandle方法");
        try {
            HttpSession session = request.getSession();
            //统一拦截(查询当前session是否存在user)(这里user会在每次登录成功后,写入session)
            User user = (User) session.getAttribute("user");
            if (user != null) {
                return true;
            }
            response.sendRedirect(request.getContextPath() + "login");
        } catch (Exception e) {
            e.printStackTrace();
        }
        return false;
        //如果设置为false时,被请求时,拦截器执行到此处将不会继续操作
        //如果设置为true时,请求将会继续执行后面的操作
    }

    /***
     * 请求处理之后进行调用,但是在视图被渲染之前(Controller方法调用之后)
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) 													throws Exception {
        System.out.println("执行了拦截器的postHandle方法");
    }

    /***
     * 整个请求结束之后被调用,也就是在DispatchServlet渲染了对应的视图之后执行(主要用于进行资源清理工作)
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) 
        											throws Exception {
        System.out.println("执行了拦截器的afterCompletion方法");
    }
}

编写配置类来完成拦截器的配置

由于新创建的拦截器还没有登记,只有登记了才能使用,因此要在mvc的配置类中进行登记

  • 首先创建一个config包
  • 在包内创建mvc配置类,例如WebConfigurer类
  • 令该类实现WebMvcConfigurer接口
  • 重写设置拦截器的方法

代码:

@Configuration
public class WebConfigurer implements WebMvcConfigurer {
    //重写方法,注册拦截器(InterceptorRegistry)
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //创建刚刚写好的拦截器类
        HandlerInterceptor interceptor=new LoginInterceptor();
		//编写白名单列表
        List<String> patterns=new ArrayList<>();
        patterns.add("/users/login");
        patterns.add("/web/register.html");
        patterns.add("/web/login.html");
        patterns.add("/bootstrap3/**");//对于静态资源,可以通过添加静态资源访问前缀,来放行静态资源,这样就不用每一个静态资源文件夹都写一遍
        patterns.add("/css/**");
        patterns.add("/images/**");
        patterns.add("/js/**");
        //注册拦截器类,添加黑名单(addPathPatterns("/**")),‘/*’只拦截一个层级,'/**'拦截全部
        // 和白名单(excludePathPatterns("List类型参数")),将不必拦截的路径添加到List列表中
        registry.addInterceptor(interceptor)
            	.addPathPatterns("/**")   //设置拦截路径
            	.excludePathPatterns(patterns); //设置放行路径,一般为登录页和静态资源
    }
}

2022-04-03 10:14:32 星期日

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值