SpringBoot实现登录拦截的原理

叁歲伎倆 2022-09-02 04:06 266阅读 0赞

![72e8c41a0fab67b1a3925b53db044e4d.png][]

来源：blog.csdn.net/qq_27198345/article/details/111401610

上一篇：[微信红包技术架构首次流出，到底有多牛逼！][Link 1]

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

## **1、SpringBoot实现登录拦截的原理** ##

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

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

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

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之前执行，因此拦截器的功能主要就是在这个部分实现：

1.  检查session中是否有`user`对象存在；
2.  如果存在，就返回`true`，那么Controller就会继续后面的操作；
3.  如果不存在，就会重定向到登录界面  
    就是通过这个拦截器，使得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注解将配置注入。

在公众号Java架构师技术后台回复“面试”，获取一份惊喜礼包。

### 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浏览器中看到。  
![1930d58dcc9bad84227087c1e5c3ea8a.png][]

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

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

![699a754928ab5efcde346d1d34e3f0fb.png][]  
被重定向到了localhost:8081/login，实现了登录拦截。

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

![2b2ce5654e1c58280c4e9cf9c956de8f.png][]

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

![553373912dd8f8a1e6499f74441ffa45.png][]  
没有再次被登录拦截器拦截，证明可以保持登录.

往期推荐

[keepalived实现Nginx双机热备][keepalived_Nginx]

[一行代码让你摆脱U盘完成局域网文件传输][U]

[Docker简易搭建 ElasticSearch 集群][Docker_ ElasticSearch]

[我把跨境当副业，一个星期赚了7000块”：想给有梦想的人提个醒！！！][7000]

[这个基于jedis的Redis工具类可以收藏一下][jedis_Redis]

[ZooKeeper实现分布式队列、分布式锁和选举，很详细][ZooKeeper]

[Spring SchedulingConfigurer 实现动态定时任务][Spring SchedulingConfigurer]

[从原则、方案、策略及难点阐述分库分表][Link 2]

[(建议收藏)服务器宕机了不要慌，这样排查效率高][Link 3]

[DAMS 2021：BATJ、美团等大厂和工行、农行等大型银行如何最大化挖掘数据价值？][DAMS 2021_BATJ]

[一起重新认识一下Log4j2，感受异步性能的无敌][Log4j2]

[Java项目中这样打印错误日志，排查问题更高效][Java]

![6c491ef097554966de84f24cbb8abc12.png][]

![41fe5362b989bd75a1a6d2b248e48f6b.gif][]

[72e8c41a0fab67b1a3925b53db044e4d.png]: /images/20220829/72d217d8e6aa41ea8bca546aecf5d884.png
[Link 1]: http://mp.weixin.qq.com/s?__biz=MzIzNjM3MDEyMg%3D%3D&chksm=e8da1b58dfad924e0d6301c25aebd774a9b0519054a94b8b1452965b99a2c6a3e948d5de12d4&idx=1&mid=2247514877&scene=21&sn=8baa76e348af7bae7c627052ec8b16b5#wechat_redirect
[1930d58dcc9bad84227087c1e5c3ea8a.png]: /images/20220829/432ed63d9f8744ceb5fa5affb492df01.png
[699a754928ab5efcde346d1d34e3f0fb.png]: /images/20220829/54c015e9979d4b5ca03d0e9847cd1a5b.png
[2b2ce5654e1c58280c4e9cf9c956de8f.png]: /images/20220829/e14f7552a2a04cf8b1676e2fab161dea.png
[553373912dd8f8a1e6499f74441ffa45.png]: /images/20220829/9505aa0d8d354044b3895f04fad8428b.png
[keepalived_Nginx]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ef4ecb336658cadbc79d1a7d08db1c523e4badc04fd6c04cb4e8a0d33206a436581f01bc&idx=1&mid=2247490167&scene=21&sn=6e45804ba5db31a876ad0477dba33ab3#wechat_redirect
[U]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ef4ecb336658f827b4e492f2d4d3db4cc2ea6d936ac2e93e0e61dfc7362c576f37a17af4&idx=2&mid=2247490167&scene=21&sn=ce298a0d23b75c736d8780d50afc926d#wechat_redirect
[Docker_ ElasticSearch]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ef4fcb3366596390e361b10db1b6616d405df719cb3b259805629d75601ba03475212cd6&idx=1&mid=2247490166&scene=21&sn=5eb8eed5d0a6cd5c59d00aae41ad0039#wechat_redirect
[7000]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ef4fcb336659b1c864d0c9255b16e0c2eb4aaf7a30854462a7dd238892aa93b11040e767&idx=2&mid=2247490166&scene=21&sn=519f78fa7501840cdf6de96a0dec4564#wechat_redirect
[jedis_Redis]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ef54cb336642fc5ffb45160a552fd6deaf7cef8039251c3962abfc74dccfc721fc97f799&idx=1&mid=2247490157&scene=21&sn=bcb84fb6107ce1a05912da335122700b#wechat_redirect
[ZooKeeper]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ef55cb3366433da40ddcd71fa7f61a60df9902c152a77dc661d9166957a20393d9fdbcc5&idx=1&mid=2247490156&scene=21&sn=fe02fa5db8eafe9468cf5ad63f0d9b3e#wechat_redirect
[Spring SchedulingConfigurer]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ef66cb33667087272c87b07ccb700b48782af0b82ab9df8c93be1a08bb8b0fa5444c1c2f&idx=1&mid=2247490143&scene=21&sn=3608b976ef47aaa572f7872fc76c6954#wechat_redirect
[Link 2]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ef67cb336671c174f6fb2d258f0dc3df395e9ba991bb60740b99ab9aa2af4e03a4eb55d1&idx=1&mid=2247490142&scene=21&sn=424a472c4642ee01a3302fab53f1972a#wechat_redirect
[Link 3]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ef65cb336673784019227c2c2a5ffaef2f35c40f5ea6e5e0a58b22a891cdeffbfa4cc713&idx=1&mid=2247490140&scene=21&sn=a781c5208f37ddaa4999755f98143f72#wechat_redirect
[DAMS 2021_BATJ]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ef62cb3366746af880b1fc9425bceb241f2a504d34903e9cc71811b5ef596459f5075d34&idx=1&mid=2247490139&scene=21&sn=7b04b161f8d508051c0d0ec20507fce1#wechat_redirect
[Log4j2]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ef62cb336674ca09b14a7f3e0eccd9b900a8f0269d5e91bbf927b802f1d78a5c94f0bea7&idx=2&mid=2247490139&scene=21&sn=8cf6676218ba7942a84c39161d80fbc3#wechat_redirect
[Java]: http://mp.weixin.qq.com/s?__biz=MzU2NDc4MjE2Ng%3D%3D&chksm=fc44ef69cb33667fe64a21cefd08f835c89d30b540cd6855dab6df0ec6f3cd502ede5479fa16&idx=1&mid=2247490128&scene=21&sn=e232f3c4982996b6d383d9ba247b57e6#wechat_redirect
[6c491ef097554966de84f24cbb8abc12.png]: /images/20220829/c7c58316d26246f39aae44d74a095544.png
[41fe5362b989bd75a1a6d2b248e48f6b.gif]: /images/20220829/eb1343aca9f246428395d8036dfa8e78.png