Spring Boot 实现登录拦截器，这才是正确的姿势！！

我就是我 2022-09-04 03:57 149阅读 0赞

**点击关注公众号，Java干货****及时送达**![4936bd816727bd7d5e1b9c0d3a36487a.png][]

对于管理系统或其他需要用户登录的系统，登录验证都是必不可少的环节，在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接口来实现一个配置类，将上面实现的拦截器的一个对象注册到这个配置类中。][3][`Spring Boot 学习笔记`][3]这个很全了。

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注解将配置注入。][Configuration]

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

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

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

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

@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、代码实现及示例][3] ####

代码实现如上所示。

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

![c3927359f5eaee6ad73d46bf47fcd4ad.png][]

## 3、效果验证 ##

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

![1b76c93d82c4f7de3a2a76a52eb1447c.png][]

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

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

![e9d7770a21b736c735cca72477d6a6f7.png][]

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

![5c295c0d2e4d67d3e92a1f7938a7019a.png][]

没有再次被登录拦截器拦截，证明可以保持登录。另外，关注公众号Java技术栈，在后台回复：面试，可以获取我整理的 Spring Boot 系列面试题和答案，非常齐全。

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

![fe2c05ecd3edbd1b25be0bbe9aef7eb5.gif][]

![02a7f74306dc514d22a4efd23da29be0.png][]

[![fd6c10cdf1415b6f31f64c308b4ca2ff.png][]][fd6c10cdf1415b6f31f64c308b4ca2ff.png 1]

[![dd98eca53bc53218c51da58cfc910e35.png][]][dd98eca53bc53218c51da58cfc910e35.png 1]

[![17c1aaef6357812f4aa7723f3ca7bc0d.png][]][17c1aaef6357812f4aa7723f3ca7bc0d.png 1]

[![74a4efccfc6f17bf8f7ff15077295577.png][]][74a4efccfc6f17bf8f7ff15077295577.png 1]

[![9609303c6ab73dcd3e7afbefcd62b0c8.png][]][9609303c6ab73dcd3e7afbefcd62b0c8.png 1]

**关注Java技术栈看更多干货**

![f2dbeb72f9fe033799b559806487ff75.png][]

![0aafb69239c7f91caffe766871d83bf4.gif][]

获取 Spring Boot 实战笔记！

[4936bd816727bd7d5e1b9c0d3a36487a.png]: /images/20220829/bf2f1c79e45b481eb42d5947705615c2.png
[3]: http://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&chksm=eb50f82edc2771386229a5bb81d865eee375f8ecbec665494417beb8c933260114d67b34c3a0&idx=2&mid=2247531800&scene=21&sn=fbf496a2626d9d550c4ae95bb4f60c11#wechat_redirect
[Configuration]: http://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&chksm=eb50f765dc277e7328851c2d884e557c362c8cbfdfea922fd49b2cbacffc4ab10034c784b82c&idx=2&mid=2247529043&scene=21&sn=ccbb24c037bbe434e86779c4206f0040#wechat_redirect
[c3927359f5eaee6ad73d46bf47fcd4ad.png]: /images/20220829/674700d2cd334c5bb194c6b8aa7fc0ae.png
[1b76c93d82c4f7de3a2a76a52eb1447c.png]: /images/20220829/abe7de1a594948c1aef4069c279df0d7.png
[e9d7770a21b736c735cca72477d6a6f7.png]: /images/20220829/248b823fbce54418aec21afd5704ff80.png
[5c295c0d2e4d67d3e92a1f7938a7019a.png]: /images/20220829/e80eaf4eb68d4a95ac0616f96b7a1a59.png
[fe2c05ecd3edbd1b25be0bbe9aef7eb5.gif]: /images/20220829/90aa141bd5624e68948b884bb06ea1fe.png
[02a7f74306dc514d22a4efd23da29be0.png]: /images/20220829/2b77e5d838b44443bf8842b90788e2f1.png
[fd6c10cdf1415b6f31f64c308b4ca2ff.png]: /images/20220829/0b17361e1deb43cbb27ae54fb20f355e.png
[fd6c10cdf1415b6f31f64c308b4ca2ff.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247538317&scene=21&sn=43c95adbf842bcbd3c36628e46a8cff0#wechat_redirect
[dd98eca53bc53218c51da58cfc910e35.png]: /images/20220829/e4efa614cae744689119f45d97059d73.png
[dd98eca53bc53218c51da58cfc910e35.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247538213&scene=21&sn=2aa32b7da9aa26cc30c641769c8527c9#wechat_redirect
[17c1aaef6357812f4aa7723f3ca7bc0d.png]: /images/20220829/7c5077cfacd7434ab2ede21210858ed0.png
[17c1aaef6357812f4aa7723f3ca7bc0d.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247538473&scene=21&sn=336b6df5831b1a84b9c1d61d995b27f2#wechat_redirect
[74a4efccfc6f17bf8f7ff15077295577.png]: /images/20220829/c41fd21200ce499ca1a34503c080cf94.png
[74a4efccfc6f17bf8f7ff15077295577.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247537730&scene=21&sn=3869e164e482b838671fa8896cb33cdb#wechat_redirect
[9609303c6ab73dcd3e7afbefcd62b0c8.png]: /images/20220829/df784249c6474e508e06a20bc52bd316.png
[9609303c6ab73dcd3e7afbefcd62b0c8.png 1]: https://mp.weixin.qq.com/s?__biz=MzI3ODcxMzQzMw%3D%3D&idx=1&mid=2247539051&scene=21&sn=e59d2d5f0fba696a6b40d7b943e8a707#wechat_redirect
[f2dbeb72f9fe033799b559806487ff75.png]: /images/20220829/3e4f7842cbd14bc2b57964d072a3644b.png
[0aafb69239c7f91caffe766871d83bf4.gif]: /images/20220829/5456b85a676c46d8b7905cc7f077d2cf.png