13、拦截器

天宇阿

已于 2023-04-25 11:01:34 修改

阅读量480

点赞数

分类专栏： SpringBoot 文章标签： java spring boot

于 2023-04-13 22:31:04 首次发布

本文链接：https://blog.csdn.net/zhao854116434/article/details/130131127

版权

SpringBoot 专栏收录该内容

22 篇文章 0 订阅

订阅专栏

文章介绍了SpringBoot中如何使用HandlerInterceptor接口创建自定义拦截器，包括preHandle、postHandle和afterCompletion方法的实现。在2.2部分展示了如何通过实现WebMvcConfigurer接口的addInterceptors方法将拦截器注册到容器并配置拦截规则。文章最后探讨了拦截器的执行原理，涉及preHandle、postHandle和afterCompletion方法的调用顺序及条件。

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

【尚硅谷】SpringBoot2零基础入门教程-讲师：雷丰阳
 笔记

路还在继续，梦还在期许

1、HandlerInterceptor 接口

拦截器的底层接口

位置：org.springframework.web.servlet.HandlerInterceptor

public interface HandlerInterceptor {

	default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
			throws Exception {

		return true;
	}

	default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
			@Nullable ModelAndView modelAndView) throws Exception {
	}

	default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
			@Nullable Exception ex) throws Exception {
	}
}

2、拦截器使用

2.1、自定义拦截器

编写一个拦截器必须实现 HandlerInterceptor 接口

@Slf4j
public class LoginInterceptor implements HandlerInterceptor {

    // 目标方法执行之前
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {

        String requestURI = request.getRequestURI();
        log.info("preHandle拦截的请求路径是{}",requestURI);
        //登录检查逻辑
        HttpSession session = request.getSession();
        Object loginUser = session.getAttribute("loginUser");
        if(loginUser != null){
            //放行
            return true;
        }
        //拦截住，未登录，跳转到登录页
        request.setAttribute("msg","请先登录");
        //re.sendRedirect("/");
        request.getRequestDispatcher("/").forward(request,response);
        return false;
    }

    // 目标方法执行完成以后
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.info("postHandle执行{}",modelAndView);
    }

    // 页面渲染以后
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.info("afterCompletion执行异常{}",ex);
    }
}

2.2、配置拦截器

拦截器注册到容器中（实现WebMvcConfigurer接口的addInterceptors方法）

指定拦截规则【如果是拦截所有，静态资源也会被拦截】

@Configuration
public class AdminWebConfig implements WebMvcConfigurer {

    // 向容器中添加自定义拦截器
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 在拦截器注册中心中添加 LoginInterceptor 拦截器
        registry.addInterceptor(new LoginInterceptor())
                // 拦截的路径（所有请求都被拦截包括静态资源）
                .addPathPatterns("/**")
                // 放行的路径
                .excludePathPatterns("/","/login","/css/**","/fonts/**","/images/**","/js/**");
    }
}

3、拦截器原理

1、根据当前请求，找到 HandlerExecutionChain。【可以处理请求的handler以及handler的所有拦截器】

在这里插入图片描述

2、先来 顺序执行 所有拦截器的 preHandle方法。
- 1、如果当前拦截器prehandler返回为true，则执行下一个拦截器的preHandle。
- 2、如果当前拦截器返回为false，直接触发倒序执行所有已经执行了的拦截器的 afterCompletion。
3、如果任何一个拦截器执行失败，返回false，直接跳出不执行目标方法。
4、所有拦截器都返回True，执行目标方法。
5、倒序执行所有拦截器的postHandle方法。
6、前面的步骤有任何异常都会直接倒序触发 afterCompletion。
7、页面成功渲染完成以后，也会倒序触发 afterCompletion。