關(guān)于Redis解決Session共享問題

更新時間：2023年07月11日 14:52:13 作者：熬夜磕代碼丶

這篇文章主要介紹了Redis解決Session共享問題,本文結(jié)合實例代碼給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下

一、集群Session共享問題

session共享問題：多臺Tomcat并不共享session存儲空間，當(dāng)請求切換到不同tomcat服務(wù)器時導(dǎo)致數(shù)據(jù)丟失的問題

tomcat可以進(jìn)行多臺tomcat進(jìn)行session拷貝，但是數(shù)據(jù)拷貝保存相同的內(nèi)容會存在資源浪費，而且會有時間延遲，所以這種方案不可行

session的替代方案應(yīng)該滿足：

數(shù)據(jù)共享
內(nèi)存存儲
key、value結(jié)構(gòu)

這里我們可以使用redis

二、Redis存儲驗證碼和對象

發(fā)送短信：

@Resource
    private StringRedisTemplate stringRedisTemplate;
    @Override
    public Result sendCode(String phone, HttpSession session) {
        // 1.校驗手機號
        if (phone == null || str.matches("^1([38][0-9]|4[579]|5[0-3,5-9]|6[6]|7[0135678]|9[89])\\d{8}$")) {
            // 2.如何不符合,返回錯誤信息
            return Result.fail("手機號格式錯誤!");
        }
        // 3.符合,生成驗證碼
        String code = RandomUtil.randomNumbers(6);
        // 4.保存驗證碼到Redis
        stringRedisTemplate.opsForValue().set("login:code:" + phone,code,2, TimeUnit.MINUTES);
        //具體的發(fā)送邏輯 在這里就不實現(xiàn)了
        return Result.ok();
    }

首先，我們會校驗前端傳來的手機號格式，如果格式不正確直接返回。使用hutool的工具類生成6位隨機驗證碼，然后將驗證碼作為value存入到Redis中，為了避免key重復(fù)，我們設(shè)置了固定格式的key，并且設(shè)置一個2分鐘的超時時間，超過兩分鐘驗證碼自動失效。

登錄功能：

public Result login(LoginFormDTO loginForm, HttpSession session) {
        // 1. 校驗手機號
        String phone = loginForm.getPhone();
        if (phone == null || str.matches("^1([38][0-9]|4[579]|5[0-3,5-9]|6[6]|7[0135678]|9[89])\\d{8}$")) {
            // 如何不符合,返回錯誤信息
            return Result.fail("手機號格式錯誤!");
        }
        // 2. 校驗驗證碼
        String cacheCode = stringRedisTemplate.opsForValue().get("login:code:" + phone);
        String code = loginForm.getCode();
        // 3. 不一致,報錯
        if(cacheCode == null || !cacheCode.equals(code)) {
            return Result.fail("驗證碼錯誤!");
        }
        // 4. 一致,根據(jù)手機號查詢用戶 select * from tb_user where phone = ?
        User user = query().eq("phone", phone).one();
        // 5. 判斷用戶是否存在
        if (user == null) {
            // 6. 不存在,創(chuàng)建用戶并保存
            user = createUserWithPhone(phone);
        }
        // 7. 保存用戶信息到Redis
        String token = UUID.randomUUID().toString(true);
        UserDTO userDTO = BeanUtil.copyProperties(user, UserDTO.class);
        Map<String, Object> userMap = BeanUtil.beanToMap(userDTO,new HashMap<>()
        , CopyOptions.create().setIgnoreNullValue(true).setFieldValueEditor((fieldName,fieldValue) -> fieldValue.toString()));
        stringRedisTemplate.opsForHash().putAll("login:token:" + token,userMap);
        stringRedisTemplate.expire("login:token:" + token,30,TimeUnit.MINUTES);
        return Result.ok(token);
    }

我們在進(jìn)行登錄時，首先會對手機號格式進(jìn)行檢驗，如果手機號格式正確，我們從Redis中獲取驗證碼和客戶端傳來的驗證碼進(jìn)行比較，如果一致我們就放行，先去數(shù)據(jù)庫查詢該用戶信息，如果用戶不存在進(jìn)行保存。

可能有的同學(xué)會有疑問，為什么這里要進(jìn)行這么麻煩的操作呢？

因為我們UserDTO中的id是Long類型的，會報Long轉(zhuǎn)String類型轉(zhuǎn)換異常，因為我們這里使用的是StringRedisTemplate

該類型要求key和value都是String類型，但是我們將對象轉(zhuǎn)為Map時，id為Long類型，所以就出現(xiàn)了該問題，兩種方案：1.自定義Map手動put 2.使用BeanUtil，自定義規(guī)則

我們需要將用戶對象存儲在Redis中，這里用什么作為key呢？我們這里用token作為key，將token返回給客戶端，客戶端后面請求的時候使用該token來獲取value。

我們value保存對象時，使用什么存儲呢？

1.String：

2.Hash:

我們這里使用Hash存儲對象，因為Hash結(jié)構(gòu)可以將對象中的每個字段獨立存儲，可以針對單個字段做CRUD，并且占用內(nèi)存更少。

我們使用UUID隨機生成token，但是我們value是哈希結(jié)構(gòu)，我們使用BeanUtil將對象轉(zhuǎn)為Hash存儲，因為Redis是在內(nèi)存存儲的，如果一直只存會存在內(nèi)存不夠用的情況，所以我們這里仍然需要設(shè)置一個超時時間，那么設(shè)置多長時間呢？我們這里模仿Session的只要超過30分鐘不訪問就會銷毀。

但是我們現(xiàn)在設(shè)置的是，從設(shè)置開始不管有沒有用戶訪問30分鐘后都會銷毀，這樣肯定是不行的，我們需要和session一樣，只要有用戶訪問我們就需要更新超時時間，那么怎么做呢？可以借助攔截器

我們的攔截器不是Spring創(chuàng)建的對象，所以我們無法使用注入的方式獲取StringRedisTemplate對象，我們需要使用構(gòu)造方法的方法，那么誰來調(diào)用呢？

我們可以在MvcConfig注冊攔截器時傳入StringRedisTemplate對象由于我們多處都需要用到ThreadLocal存儲的對象，所以我們將ThreadLocal封裝成一個工具類：

public class UserHolder {
    private static final ThreadLocal<UserDTO> tl = new ThreadLocal<>();
    public static void saveUser(UserDTO user){
        tl.set(user);
    }
    public static UserDTO getUser(){
        return tl.get();
    }
    public static void removeUser(){
        tl.remove();
    }
}

public class LoginInterceptor implements HandlerInterceptor {
    private StringRedisTemplate stringRedisTemplate;
    public LoginInterceptor(StringRedisTemplate stringRedisTemplate) {
        this.stringRedisTemplate = stringRedisTemplate;
    }
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 1. 獲取請求頭中的token
        String token = request.getHeader("authorization");
        if(StrUtil.isBlank(token)) {
            response.setStatus(401);
            return false;
        }
        // 2. 使用token獲取Redis中的對象
        Map<Object, Object> userMap = stringRedisTemplate.opsForHash().entries("login:token:" + token);
        // 3. 判斷用戶是否存在
        if(userMap == null) {
            response.setStatus(401);
            return false;
        }
        // 4. 將Hash 格式轉(zhuǎn)為UserDTO對象
        UserDTO userDTO = BeanUtil.fillBeanWithMap(userMap, new UserDTO(), false);
        // 5. 將用戶存入ThreadLocal中
        UserHolder.saveUser(userDTO);
        // 6. 刷新token超時時間
        stringRedisTemplate.expire("login:token:" + token,30,TimeUnit.MINUTES);
        return true;
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        UserHolder.removeUser();
    }
}

大家需要注意的是我們需要remove ThreadLocal，因為ThreadLocal可能會存在內(nèi)存泄露問題，因為強軟引用的問題，這里我們不具體介紹。

三、解決狀態(tài)登錄刷新問題

但是這樣會存在一些問題，該攔截器只會攔截需要登錄的路徑，其他路徑是不會攔截了，也就不會進(jìn)行token有效期的刷新了。怎么解決呢？新加一個全部路徑的攔截器

public class RefreshTokenInterceptor implements HandlerInterceptor {
    private StringRedisTemplate stringRedisTemplate;
    public RefreshTokenInterceptor(StringRedisTemplate stringRedisTemplate) {
        this.stringRedisTemplate = stringRedisTemplate;
    }
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 1. 獲取請求頭中的token
        String token = request.getHeader("authorization");
        if (StrUtil.isBlank(token)) {
            return true;
        }
        // 2. 基于token獲取Redis中的用戶
        Map<Object, Object> userMap = stringRedisTemplate.opsForHash().entries(RedisConstants.LOGIN_USER_KEY + token);
        // 3. 判斷用戶是否存在
        if(userMap == null) {
            return true;
        }
        // 將查詢到的Hash轉(zhuǎn)為UserDTO對象
        UserDTO userDTO = BeanUtil.fillBeanWithMap(userMap, new UserDTO(), false);
        // 5. 存在 保存用戶到ThreadLocal
        UserHolder.saveUser(userDTO);
        stringRedisTemplate.expire(RedisConstants.LOGIN_USER_KEY + token,RedisConstants.LOGIN_USER_TTL, TimeUnit.MINUTES);
        return true;
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        UserHolder.removeUser();
    }
}

我們創(chuàng)建一個攔截全部路徑的攔截器來進(jìn)行token有效期的刷新

我們在登錄攔截器里，只需要判斷ThreadLocal里是否存在有效的用戶，如果有放行，否則攔截。

public class MvcConfig implements WebMvcConfigurer {
    @Resource
    private StringRedisTemplate stringRedisTemplate;
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LoginInterceptor())
                .excludePathPatterns(
                   "/user/code",
                   "/user/login",
                   "/blog/hot",
                   "/shop/**",
                   "/shop-type/**",
                   "/upload/**",
                   "/voucher/**"
                );
        registry.addInterceptor(new RefreshTokenInterceptor(stringRedisTemplate)).addPathPatterns("/**");
    }
}

我們在注冊刷新Token的攔截器，并且增加所有路徑。但是我們?nèi)绾伪ＷC刷新Token的攔截器在登錄攔截器之前執(zhí)行呢？其實在MvcConfig中注冊攔截器的順序也就是攔截的順序，但是這樣不保險