【SpringBoot学习】06、拦截器(Interceptor)示例

0 拦截器应用

论坛网站或者商城网站等需要登陆的网站，用户登陆之后，头部应该显示“首页、消息、头像”
头像的下拉框显示用户信息

如果用户没有登陆，头部应该显示“首页、注册、登陆”
也就是说要根据用户登陆与否，头部也不同

这一功能可以用Spring的拦截器来完成
拦截器可以拦截浏览器的多个请求，在这些请求的开始或者结束部分插入代码，从而可以批量解决多个请求共有的业务

拦截器实际应用见文章：【SpringBoot仿牛客网】04、显示登陆信息与检查登陆状态

上图来自https://blog.csdn.net/Herishwater/article/details/103544342

1 拦截器示例

拦截器也算是视图层的处理逻辑，所以在controller里新建一个包interceptor用来存放拦截器
实现一个拦截器有两步
1.定义拦截器，实现HandlerInterceptor接口
2.配置拦截器，为它指定拦截、排除的路径

1.1 定义拦截器

写注解@Component
进入HandlerInterceptor里看看，里面一共三个方法，都用default修饰，表示实现类可实现也可不实现该方法，那我们肯定都实现一下试一试

	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 {
    }

alt+insert调出菜单栏，o定位到override，重写三个方法
或者还有一种快捷方式：直接打需要重写的方法名

为了查看方法是否被调用，写个debug的日志

@Component
public class DemoInterceptor implements HandlerInterceptor {
    private static final Logger logger = LoggerFactory.getLogger(DemoInterceptor.class);

    @Override
    //在controller之前执行，如果返回false，程序就结束了，后面的controller不会被执行
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        logger.debug("preHandle："+handler.toString());
        return true;
    }

    @Override
    //在controller之后执行
    //有个参数是ModelAndView，因为是在controller之后执行，请求逻辑已经写完，后面是渲染页面了
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        logger.debug("postHandle："+handler.toString());
    }

    @Override
    //在程序的最后执行，在模板引擎之后执行
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        logger.debug("afterCompletion："+handler.toString());
    }
}

1.2 配置拦截器

在config包里新建WebMvcConfig
写注解@Configuration
实现接口WebMvcConfigurer
因为要配置拦截器类，先把拦截器注入进来

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {
    @Autowired
    private DemoInterceptor demoInterceptor;

    @Override
    //spring在调用时会把registry传进来，利用registry注册interceptor
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(demoInterceptor)
                /*excludePathPatterns是不拦截这些路径*/
                .excludePathPatterns("/**/*.css", "/**/*.js", "/**/*.jpg", "/**/*.png", "/**/*.jpeg")
                /*addPathPatterns是就要拦截这些路径*/
                .addPathPatterns("/register", "/login")
                ;
    }
}

1.3 执行结果

可见确实调用了拦截器的三个方法
但是并没有详细显示三个方法和controller之间的执行顺序
所以我们打断点试试，在拦截器三个方法里打断点，在访问登陆页面里打断点（即图中的LoginController）


调试快捷键：f9(+fn)运行到下一断点处
访问登陆页面，可以看到程序先卡在preHandle，再卡在getLogin，再卡在postHandle，最后在afterCompletion