每个系统都能用上：Spring Boot 实现登录拦截器，

今天药忘吃喽~ 2022-09-07 09:48 118阅读 0赞

![34acded88aa8bfdab2283459ea540e7e.png][]

原文：https://blog.csdn.net/qq\_27198345/article/details/111401610

对于管理系统或其他需要用户登录的系统，登录验证都是必不可少的环节，在SpringBoot开发的项目中，通过实现拦截器来实现用户登录拦截并验证。

## **1、Spring Boot实现登录拦截原理** ##

SpringBoot通过实现HandlerInterceptor接口实现拦截器，通过实现WebMvcConfigurer接口实现一个配置类，在配置类中注入拦截器，最后再通过@Configuration注解注入配置。

#### 1.1、实现HandlerInterceptor接口 ####

实现HandlerInterceptor接口需要实现3个方法：`preHandle`、`postHandle`、`afterCompletion`.

[3个方法各自的功能如下：][3]

package blog.interceptor;
    
    import blog.entity.User;
    import org.springframework.web.servlet.HandlerInterceptor;
    import org.springframework.web.servlet.ModelAndView;
    
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    import javax.servlet.http.HttpSession;
    
    public class UserLoginInterceptor 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方法");
        }
    }

[preHandle在Controller之前执行，因此拦截器的功能主要就是在这个部分实现：][3]

*  检查session中是否有user对象存在；
 *  如果存在，就返回true，那么Controller就会继续后面的操作；
 *  如果不存在，就会重定向到登录界面。就是通过这个拦截器，使得Controller在执行之前，都执行一遍preHandle.

#### 1.2、实现WebMvcConfigurer接口，注册拦截器 ####

实现WebMvcConfigurer接口来实现一个配置类，将上面实现的拦截器的一个对象注册到这个配置类中。

package blog.config;
    
    import blog.interceptor.UserLoginInterceptor;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.servlet.config.annotation.InterceptorRegistration;
    import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
    import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
    
    @Configuration
    public class LoginConfig implements WebMvcConfigurer {
    
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            //注册TestInterceptor拦截器
            InterceptorRegistration registration = registry.addInterceptor(new UserLoginInterceptor());
            registration.addPathPatterns("/**"); //所有路径都被拦截
            registration.excludePathPatterns(    //添加不拦截路径
                    "/login",                    //登录路径
                    "/**/*.html",                //html静态资源
                    "/**/*.js",                  //js静态资源
                    "/**/*.css"                  //css静态资源
            );
        }
    }

将拦截器注册到了拦截器列表中，并且指明了拦截哪些访问路径，不拦截哪些访问路径，不拦截哪些资源文件；最后再以@Configuration注解将配置注入。

Spring Boot 基础教程和示例代码看这里：https://github.com/javastacks/spring-boot-best-practice

#### 1.3、保持登录状态 ####

只需一次登录，如果登录过，下一次再访问的时候就无需再次进行登录拦截，可以直接访问网站里面的内容了。

在正确登录之后，就将user保存到session中，再次访问页面的时候，登录拦截器就可以找到这个user对象，就不需要再次拦截到登录界面了.

@RequestMapping(value = {"", "/", "/index"}, method = RequestMethod.GET)
    public String index(Model model, HttpServletRequest request) {
        User user = (User) request.getSession().getAttribute("user");
        model.addAttribute("user", user);
        return "users/index";
    }
    
    @RequestMapping(value = {"/login"}, method = RequestMethod.GET)
    public String loginIndex() {
        return "users/login";
    }
    
    @RequestMapping(value = {"/login"}, method = RequestMethod.POST)
    public String login(@RequestParam(name = "username")String username, @RequestParam(name = "password")String password,
                        Model model, HttpServletRequest request) {
        User user = userService.getPwdByUsername(username);
        String pwd = user.getPassword();
        String password1 = MD5Utils.md5Code(password).toUpperCase();
        String password2 = MD5Utils.md5Code(password1).toUpperCase();
        if (pwd.equals(password2)) {
            model.addAttribute("user", user);
            request.getSession().setAttribute("user", user);
            return "redirect:/index";
        } else {
            return "users/failed";
        }
    }

#### **2、代码实现及示例** ####

代码实现如上所示。

在登录成功之后，将user信息保存到session中，下一次登录时浏览器根据自己的SESSIONID就可以找到对应的session，就不要再次登录了，可以从Chrome浏览器中看到。

![b2c0d92e131d4e079eb50c095de1e16b.png][]

## **3、效果验证** ##

#### 3.1、访问localhost:8081/index页面： ####

![5f00b5964c16613ff3bdcb31cd12e865.png][]

被重定向到了localhost:8081/login，实现了登录拦截。

#### 3.2、正确输入用户名和密码登录 ####

![1a0d2f96c6a54ea34bbf57e5e0725e50.png][]

#### 3.3、再次访问localhost:8081/index ####

![38b8812e9289d48aa476a44600f5b108.png][]

没有再次被登录拦截器拦截，证明可以保持登录。

往期推荐

[面试官：给我讲讲你的项目是怎么性能优化的？][Link 1]

[怎么样通过Nginx实现限流？][Nginx]

[Spring Boot 实现通用 Auth 认证的 4 种方式！][Spring Boot _ Auth _ 4]

[Redis 性能测试与监控][Redis]

[缺练手项目？这7 个 Spring Cloud 实战项目收藏一下][7 _ Spring Cloud]

[MySQL 调优，程序员必备的4个效率工具][MySQL _4]

[springboot同一接口兼容Form表单和JSON两种提交方式][springboot_Form_JSON]

[java压缩文件耗时：30秒到1秒的优化过程][java_30_1]

[java服务端实践：防止订单重复提交支付][java]

![23389ca40667fc51ff26a723636d22cb.png][]

[34acded88aa8bfdab2283459ea540e7e.png]: /images/20220829/9e778e5949274aca8bfc5f0def96ef22.png
[3]: http://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&chksm=eb50f82edc2771386229a5bb81d865eee375f8ecbec665494417beb8c933260114d67b34c3a0&idx=2&mid=2247531800&scene=21&sn=fbf496a2626d9d550c4ae95bb4f60c11#wechat_redirect
[b2c0d92e131d4e079eb50c095de1e16b.png]: /images/20220829/b9b5de55020c48c1ab653f61d1152b2f.png
[5f00b5964c16613ff3bdcb31cd12e865.png]: /images/20220829/4bd9cc37d53e43488063f3890388bfc5.png
[1a0d2f96c6a54ea34bbf57e5e0725e50.png]: /images/20220829/b2986e5d652f4b6399ded8ed9934cdde.png
[38b8812e9289d48aa476a44600f5b108.png]: /images/20220829/85dd6d477e784687b62c31cd36d30ee7.png
[Link 1]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ee78cb33676e9735434c315e43b33647beb6ca3f3af695da20d4743b9fa44a6a34b598e1&idx=1&mid=2247490369&scene=21&sn=28848102cb8257f76964084447d4a01e#wechat_redirect
[Nginx]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ee78cb33676e4351022d726adf98f509085a3bda8f91dda6f0ceb59476c0e341aeb6793e&idx=2&mid=2247490369&scene=21&sn=ea366882ec33a14e37bcac2422b25ece#wechat_redirect
[Spring Boot _ Auth _ 4]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ee05cb3367133462cc9172e00bb7592d131723e2335f641ddb8995d4f78a0a0c5ee36b10&idx=1&mid=2247490364&scene=21&sn=a808c4c288320834d6b8f3d5fa2be533#wechat_redirect
[Redis]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ee05cb33671332e1bfbd866ff18cca6abba2e231f95982da1ce4d6ebb3624396d2cd094a&idx=2&mid=2247490364&scene=21&sn=ce3a61fbcd077fea294f1eb318ed5715#wechat_redirect
[7 _ Spring Cloud]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ee0fcb336719faa152ee94081c921b07f0a2328d05b01f65b6602be56e3426463381cee3&idx=1&mid=2247490358&scene=21&sn=8123bd20ec3a42081cbd95da377b6a42#wechat_redirect
[MySQL _4]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ee0fcb336719345585783155ef4c3ae18de80f8ff7cd1d4786462dd76e992b766cb2d873&idx=2&mid=2247490358&scene=21&sn=a0d57d64e9686c733ce13756a86c198f#wechat_redirect
[springboot_Form_JSON]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ee13cb336705a01880aa7e74f008450e06b64a8bb181ee71ef2d8bbab4b23fbfe9c73e95&idx=1&mid=2247490346&scene=21&sn=2cdf09e9d7eac7fd8bbf876089c0eb02#wechat_redirect
[java_30_1]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ee1fcb336709e293871ba8ee916c93eb4ecae919460da40004abaed3b5096526a507b24a&idx=2&mid=2247490342&scene=21&sn=02142a1a49d955e73f813696a8b40fd9#wechat_redirect
[java]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44efc7cb3366d1d8dc4304908944ceaaa147f8aa8e12b4cf7d2ea07ebfbd93780f1db02f73&idx=1&mid=2247490302&scene=21&sn=fcccee5eaada19086295a8108dd03c95#wechat_redirect
[23389ca40667fc51ff26a723636d22cb.png]: /images/20220829/7abed168ce2348e785b4df126a4953cf.png