Spring Boot 学习（6）拦截器的使用

写在前面：最近利用晚上的时间在网上看视频学习Spring Boot，这博客是对学习的一点点总结及记录，技术是开源的、知识是共享的。
如果你对Spring Boot 感兴趣，可以关注我的动态，我们一起学习。用知识改变命运，让家人过上更好的生活。

登录的controller

@Controller
public class LoginController {

    // @RequestMapping(value = "/user/logn",method = RequestMethod.POST)
    @PostMapping(value = "/user/login") // rest风格
    public String login(@RequestParam("username") String username,
                        @RequestParam("password") String password,
                        Map<String, Object> map,
                        HttpSession session) {

        // 判断用户是否登录成功
        if (!StringUtils.isEmpty(username) && "123456".equals(password)) {
            // 登录成功，跳转页面
            // 如果用户登录了，将信息存在session中
            session.setAttribute("loginUser", username);
            // 防止表单重复提交，可以重定向到主页
            return "redirect:/main.html";
        } else {
            // 登录失败,在登录页面显示错误提示
            map.put("msg", "用户名或密码错误");
            return "login";
        }
    }
}

第一步：编写一个普通类实现HandlerInterceptor接口

定义的拦截器需要实现 HandlerInterceptor 接口，这个接口有三个方法，每个方法会在请求调用的不同时期完成，因为我们需要在接口调用之前拦截请求判断用户是否登陆，所以这里需要使用 preHandle 方法，在里面写验证逻辑，最后返回 true 或者 false，确定请求是否合法。

public class LoginHandlerInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        Object user = request.getSession().getAttribute("loginUser");
        if(user == null) {
            // 未登录，返回登录页面
            request.setAttribute("msg","没有权限，请重新登录");
            request.getRequestDispatcher("/index.html").forward(request,response);
        } else {
        	// 如果session里有user，表示该用户已经登陆，放行请求
            return true;
        }

        return false;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
                           ModelAndView modelAndView) throws Exception {

    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {

    }
}

第二步：配置拦截器

注册自定义拦截器，添加拦截路径和排除拦截路径

 /**
     * 注册拦截器
     *
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // addPathPatterns("/**") 拦截所有的请求;  excludePathPatterns("xxx") 排除不需要拦截的请求
        registry.addInterceptor(new LoginHandlerInterceptor()).addPathPatterns("/**").excludePathPatterns("/index.html","/","/asserts/**","/webjars/**","/user/login");
    }

    // 所有的WebMvcConfigurer组件会一起起作用
    @Bean
    public WebMvcConfigurer webMvcConfigurer() {
        WebMvcConfigurer confogurer = new WebMvcConfigurer() {
            @Override
            public void addViewControllers(ViewControllerRegistry registry) {
                registry.addViewController("/").setViewName("login");
                registry.addViewController("/index.html").setViewName("login");
                registry.addViewController("/main.html").setViewName("dashboard");

            }
        };

        return confogurer;
    }

注意 ： addPathPatterns("/**") 拦截所有的请求 excludePathPatterns(“xxx”) 排除不需要拦截的请求