Redis快取工具封裝實現

2023-01-16 14:03:06

1. 方法要求

在這個工具類中我們完成四個方法：

方法①：將任意Java物件序列化為json並儲存在string型別的key中，並且可以設定TTL過期時間
方法②：將任意Java物件序列化為json並儲存在string型別的key中，並且可以設定邏輯過期時間，用於處理快取擊穿問題
方法③：根據指定的key查詢快取，並反序列化為指定型別，利用快取空值的方式解決快取穿透問題
方法④：根據指定的key查詢快取，並反序列化為指定型別，需要利用邏輯過期解決快取擊穿問題

我們新建一個類，先把大致框架寫出來，方法的引數可以邊寫邊完善，但是我的方法引數已經完善好了：

@Component
public class CacheClient {

    private final StringRedisTemplate stringRedisTemplate;

    public CacheClient(StringRedisTemplate stringRedisTemplate) {
        this.stringRedisTemplate = stringRedisTemplate;
    }

    //方法一
    public void set(String key, Object value, Long time, TimeUnit unit) {
    }

    //方法二
    public void setWithLogicExpire(String key, Object value, Long time, TimeUnit unit) {
    }

    //方法三
    public <R, ID> R queryWithPassThrough(String keyPrefix, ID id, Class<R> type,
                                          Long time, TimeUnit unit, Function<ID, R> dbFallback) {
    }

    //方法四
    public <R, ID> R queryWithLogicalExpire(String prefix, ID id, String lockPre, Class<R> type,
                                            Long time, TimeUnit unit, Function<ID, R> dbFallback) {
    }

    //執行緒池
    private static final ExecutorService CACHE_REBUILD_EXECUTOR = Executors.newFixedThreadPool(10);

    //獲取鎖
    private boolean tryLock(String key) {
        Boolean flag = stringRedisTemplate.opsForValue().setIfAbsent(key, "1", LOCK_SHOP_TTL, TimeUnit.SECONDS);
        return BooleanUtil.isTrue(flag);
    }

    //釋放鎖
    private void unLock(String key) {
        stringRedisTemplate.delete(key);
    }
}

接下來我們可以不斷完善這些方法。

1.1 方法一

public void set(String key, Object value, Long time, TimeUnit unit) {
    stringRedisTemplate.opsForValue().set(key, JSONUtil.toJsonStr(value), time, unit);
}

1.2 方法二

public void setWithLogicExpire(String key, Object value, Long time, TimeUnit unit) {
    RedisData redisData = new RedisData();
    redisData.setData(value);
    redisData.setExpireTime(LocalDateTime.now().plusSeconds(unit.toSeconds(time)));
    stringRedisTemplate.opsForValue().set(key, JSONUtil.toJsonStr(redisData));
}

1.3 方法三

public <R, ID> R queryWithPassThrough(String keyPrefix, ID id, Class<R> type,
                                          Long time, TimeUnit unit, Function<ID, R> dbFallback) {
    String key = keyPrefix + id;
    //1.從redis中查詢商鋪快取
    String json = stringRedisTemplate.opsForValue().get(key);
    //2.判斷是否存在
    if (StrUtil.isNotBlank(json)) {
        //2.1.存在
        return JSONUtil.toBean(json, type);
    }
    //2.2.不存在
    //判斷是否為空值
    if (json != null) {
        //不為null，則必為空
        return null;
    }
    //3.查詢資料庫
    R r = dbFallback.apply(id);
    if (r == null) {
        //3.1.不存在，快取空值
        stringRedisTemplate.opsForValue().set(key, "", CACHE_NULL_TTL, TimeUnit.MINUTES);
    } else {
        //3.2.存在，快取資料
        this.set(key, r, time, unit);
    }
    return r;
}

方法三用到了函數語言程式設計，這裡非常巧妙，順便再貼一下呼叫方法是怎樣呼叫的：

Shop shop = cacheClient.queryWithPassThrough(CACHE_SHOP_KEY,id,Shop.class,CACHE_SHOP_TTL,TimeUnit.MINUTES,this::getById);

1.4 方法四

public <R, ID> R queryWithLogicalExpire(String prefix, ID id, String lockPre, Class<R> type,
                                            Long time, TimeUnit unit, Function<ID, R> dbFallback) {
    //1.從redis查詢商鋪快取
    String key = prefix + id;
    String json = stringRedisTemplate.opsForValue().get(key);
    //2.判斷是否存在
    if (StrUtil.isBlank(json)) {
        //未命中，直接返回空
        return null;
    }
    //3.命中，判斷是否過期
    RedisData redisData = JSONUtil.toBean(json, RedisData.class);
    R r = JSONUtil.toBean((JSONObject) redisData.getData(), type);
    if (redisData.getExpireTime().isAfter(LocalDateTime.now())) {
        //3.1未過期,直接返回店鋪資訊
        return r;
    }
    //3.2.已過期，快取重建
    //3.3.獲取鎖
    String lockKey = lockPre + id;
    boolean flag = tryLock(lockKey);
    if (flag) {
        //3.4.獲取成功
        //4再次檢查redis快取是否過期，做double check
        json = stringRedisTemplate.opsForValue().get(key);
        //4.1.判斷是否存在
        if (StrUtil.isBlank(json)) {
            //未命中，直接返回空
            return null;
        }
        //4.2.命中，判斷是否過期
        redisData = JSONUtil.toBean(json, RedisData.class);
        r = JSONUtil.toBean((JSONObject) redisData.getData(), type);
        if (redisData.getExpireTime().isAfter(LocalDateTime.now())) {
            //4.3.未過期,直接返回店鋪資訊
            return r;
        }
        //4.4過期，返回舊資料
        CACHE_REBUILD_EXECUTOR.submit(() -> {
            //5.重建快取
            try {
                R r1 = dbFallback.apply(id);
                this.setWithLogicExpire(key, r1, time, unit);
            } catch (Exception e) {
                throw new RuntimeException(e);
            } finally {
                //釋放鎖
                unLock(lockKey);
            }
        });
    }
    //7.獲取失敗,返回舊資料
    return r;
}

2. 完整工具類程式碼

@Component
@Slf4j
public class CacheClient {

    private final StringRedisTemplate stringRedisTemplate;

    public CacheClient(StringRedisTemplate stringRedisTemplate) {
        this.stringRedisTemplate = stringRedisTemplate;
    }

    public void set(String key, Object value, Long time, TimeUnit unit) {
        stringRedisTemplate.opsForValue().set(key, JSONUtil.toJsonStr(value), time, unit);
    }

    public void setWithLogicExpire(String key, Object value, Long time, TimeUnit unit) {
        RedisData redisData = new RedisData();
        redisData.setData(value);
        redisData.setExpireTime(LocalDateTime.now().plusSeconds(unit.toSeconds(time)));
        stringRedisTemplate.opsForValue().set(key, JSONUtil.toJsonStr(redisData));
    }

    public <R, ID> R queryWithPassThrough(String keyPrefix, ID id, Class<R> type,
                                          Long time, TimeUnit unit, Function<ID, R> dbFallback) {
        String key = keyPrefix + id;
        //1.從redis中查詢商鋪快取
        String json = stringRedisTemplate.opsForValue().get(key);
        //2.判斷是否存在
        if (StrUtil.isNotBlank(json)) {
            //2.1.存在
            return JSONUtil.toBean(json, type);
        }
        //2.2.不存在
        //判斷是否為空值
        if (json != null) {
            //不為null，則必為空
            return null;
        }
        //3.查詢資料庫
        R r = dbFallback.apply(id);
        if (r == null) {
            //3.1.不存在，快取空值
            stringRedisTemplate.opsForValue().set(key, "", CACHE_NULL_TTL, TimeUnit.MINUTES);
        } else {
            //3.2.存在，快取資料
            this.set(key, r, time, unit);
        }
        return r;
    }

    public <R, ID> R queryWithLogicalExpire(String prefix, ID id, String lockPre, Class<R> type,
                                            Long time, TimeUnit unit, Function<ID, R> dbFallback) {
        //1.從redis查詢商鋪快取
        String key = prefix + id;
        String json = stringRedisTemplate.opsForValue().get(key);
        //2.判斷是否存在
        if (StrUtil.isBlank(json)) {
            //未命中，直接返回空
            return null;
        }
        //3.命中，判斷是否過期
        RedisData redisData = JSONUtil.toBean(json, RedisData.class);
        R r = JSONUtil.toBean((JSONObject) redisData.getData(), type);
        if (redisData.getExpireTime().isAfter(LocalDateTime.now())) {
            //3.1未過期,直接返回店鋪資訊
            return r;
        }
        //3.2.已過期，快取重建
        //3.3.獲取鎖
        String lockKey = lockPre + id;
        boolean flag = tryLock(lockKey);
        if (flag) {
            //3.4.獲取成功
            //4再次檢查redis快取是否過期，做double check
            json = stringRedisTemplate.opsForValue().get(key);
            //4.1.判斷是否存在
            if (StrUtil.isBlank(json)) {
                //未命中，直接返回空
                return null;
            }
            //4.2.命中，判斷是否過期
            redisData = JSONUtil.toBean(json, RedisData.class);
            r = JSONUtil.toBean((JSONObject) redisData.getData(), type);
            if (redisData.getExpireTime().isAfter(LocalDateTime.now())) {
                //4.3.未過期,直接返回店鋪資訊
                return r;
            }
            //4.4過期，返回舊資料
            CACHE_REBUILD_EXECUTOR.submit(() -> {
                //5.重建快取
                try {
                    R r1 = dbFallback.apply(id);
                    this.setWithLogicExpire(key, r1, time, unit);
                } catch (Exception e) {
                    throw new RuntimeException(e);
                } finally {
                    //釋放鎖
                    unLock(lockKey);
                }
            });
        }
        //7.獲取失敗,返回舊資料
        return r;
    }

    private static final ExecutorService CACHE_REBUILD_EXECUTOR = Executors.newFixedThreadPool(10);

    //獲取鎖
    private boolean tryLock(String key) {
        Boolean flag = stringRedisTemplate.opsForValue().setIfAbsent(key, "1", LOCK_SHOP_TTL, TimeUnit.SECONDS);
        return BooleanUtil.isTrue(flag);
    }

    //釋放鎖
    private void unLock(String key) {
        stringRedisTemplate.delete(key);
    }
}

到此這篇關於Redis快取工具封裝實現的文章就介紹到這了,更多相關Redis快取工具封裝內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！