使用ThreadLocal保存用户登录信息

• 遇到的问题：
  • 在实际开发中，我们的登录是接的代理，每次取登录信息都需要从HttpServletRequest中取，不是很灵活，假如我们想在service，dao层使用，我们就需要从controller层一层一层传递，非常的麻烦
• 解决办法：
  • ThreadLocal可以把用户信息保存在线程中，用户发来的每一次请求启动的线程到保存了用户信息，当请求结束，我们会把保存的用户信息清除掉，这样就方便我们在开发中获取用户登录信息
• 实现思路：
  • 我们需要创建一个ThreadLocal类，创建一个ThreadLocal对象，设置ThreadLocal的set，remove，get方法，
  • 我们定义一个登录的拦截器类，实现HandlerInterceptor ，重写 preHandle() 和afterCompletion()方法 ，preHandle ()方法把登录信息写入ThreadLocal，afterCompletion()方法清除登录信息
  • 我们需要设置一些配置信息，创建一个类实现 WebMvcConfigurer ，重写addInterceptors()方法，创建一个登录拦截器类的对象，给他添加到配置中，我们就实现了ThreadLocal保存用户信息
• 具体代码：
  • 1.ThreadLocalUser.java

    public class ThreadLocalUser {
    
        private ThreadLocalUser(){
        }
        
        private static final ThreadLocal<UserInfoVO> USER_INFO_THREAD_LOCAL = new ThreadLocal<>();
    
        /**
         * 清除用户信息
         */
        public static void clear() {
            USER_INFO_THREAD_LOCAL.remove();
        }
    
        /**
         * 存储用户信息
         */
        public static void set(UserInfoVO userInfo) {
            USER_INFO_THREAD_LOCAL.set(userInfo);
        }
    
        /**
         * 获取当前用户信息
         */
        public static UserInfoVO getCurrentUser() {
            return USER_INFO_THREAD_LOCAL.get();
        }
    }

     

  • 2.LoginCheckInterceptor.java

    @Component
    public class LoginCheckInterceptor implements HandlerInterceptor {
    
        @Override
        public boolean preHandle(@NotNull HttpServletRequest request, @NotNull HttpServletResponse response, @NotNull Object handler) {
            //此方法是获取登录信息，登录方式不一样获取方法不一样，用户信息保存用的UserInfoVO，里边具体信息自己定义即可
            UserInfoVO userInfo = getUserInfo(request);
            ThreadLocalUser.set(userInfo);
            return true;
        }
    
        @Override
        public void afterCompletion(@NotNull HttpServletRequest request, @NotNull HttpServletResponse response, @NotNull Object handler, Exception ex) {
            ThreadLocalUser.clear();
        }
    }
    

     

  • 3.WebConfig.java

    @Configuration
    public class WebConfig implements WebMvcConfigurer {
    
        @Override
        public void addInterceptors(InterceptorRegistry registry) {
            registry.addInterceptor(new LoginCheckInterceptor())
            // 排除X5相关接口，想排除的接口可以自行设置 
            .excludePathPatterns("/x5/**");
            //这段代码是保证前端刷新页面时可以停留在当前页面，不会报错，与保存登录信息无关
            registry.addInterceptor(new HandlerInterceptor() {
                @Override
                public void postHandle(@NonNull HttpServletRequest request, @NonNull HttpServletResponse response, @NonNull Object handler,
                                       @Nullable ModelAndView modelAndView) {
                    if (Objects.nonNull(modelAndView)) {
                        modelAndView.setViewName("index.html");
                        response.setStatus(200);
                    }
                }
            });
        }
    }
    

    注：此代码没有导入一些包，不可直接运行，自己根据需求适当修改就可以使用