快捷導(dǎo)航

Spring?boot?RedisTemplate?序列化服務(wù)化配置方式

更新時間：2023年07月13日 09:58:34 作者：夢凡塵／n1ら

這篇文章主要介紹了Springboot?RedisTemplate序列化服務(wù)化配置方式,本文通過實例代碼給大家介紹的非常詳細，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下

Spring boot RedisTemplate 序列化服務(wù)化配置

一，引入依賴

<!--redis 引入jedis 排除lettuce 解決斷線重連問題-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

二、序列化配置

1.因RedisTemplate默認使用的是jdk原生的序列化，但這會導(dǎo)致一些問題，比如數(shù)據(jù)以Unicode編碼格式存儲。因此，建議優(yōu)先使用JSON2的序列化構(gòu)造器進行序列化。

@Bean
public RedisSerializer<Object> redisSerializer() {
    //創(chuàng)建JSON序列化器
    Jackson2JsonRedisSerializer<Object> serializer = new Jackson2JsonRedisSerializer<>(Object.class);
    ObjectMapper objectMapper = new ObjectMapper();
    objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
    objectMapper.configure(MapperFeature.USE_ANNOTATIONS, false);
    objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
    objectMapper.configure(SerializationFeature.FAIL_ON_EMPTY_BEANS, false);
    //解決localDateTime的序列化問題
    objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
    objectMapper.registerModule(new JavaTimeModule());
    objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
    //必須設(shè)置，否則無法將JSON轉(zhuǎn)化為對象，會轉(zhuǎn)化成Map類型
    objectMapper.disableDefaultTyping();
    objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL, JsonTypeInfo.As.PROPERTY);
    //objectMapper.activateDefaultTyping(LaissezFaireSubTypeValidator.instance,ObjectMapper.DefaultTyping.NON_FINAL);
    serializer.setObjectMapper(objectMapper);
    return serializer;
}

2.然后，我們需要配置RedisCacheManager作為Redis的緩存管理器，并使用上面定義的序列化方法

@Bean
public RedisCacheManager redisCacheManager(RedisConnectionFactory redisConnectionFactory) {
    RedisCacheWriter redisCacheWriter = RedisCacheWriter.nonLockingRedisCacheWriter(redisConnectionFactory);
    //設(shè)置Redis緩存有效期為1天
    RedisCacheConfiguration redisCacheConfiguration = RedisCacheConfiguration.defaultCacheConfig()
            .serializeValuesWith(RedisSerializationContext.SerializationPair.fromSerializer(redisSerializer())).entryTtl(Duration.ofDays(1));
    return new RedisCacheManager(redisCacheWriter, redisCacheConfiguration);
}

3.針對RedisTemplate<String,Object>，我們可以重新聲明一個Bean，并對其進行序列化處理，以實現(xiàn)對Redis的有效操作。為此，我們可以采用Jackson2JsonRedisSerializer來完成序列化，它支持對象的序列化和反序列化，能夠輕松實現(xiàn)Redis的存儲。

@Bean
@ConditionalOnMissingBean
public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
    RedisSerializer<Object> serializer = redisSerializer();
    RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>();
    redisTemplate.setConnectionFactory(redisConnectionFactory);
    redisTemplate.setKeySerializer(new StringRedisSerializer());
    redisTemplate.setValueSerializer(serializer);
    redisTemplate.setHashKeySerializer(new StringRedisSerializer());
    redisTemplate.setHashValueSerializer(serializer);
    redisTemplate.afterPropertiesSet();
    return redisTemplate;
}

三，構(gòu)建RedisTemplateService

為了能夠更好地使用Redis，我們對redisTemplate進行了封裝，從而構(gòu)建出RedisTemplateService，并且實現(xiàn)了泛型化。

public interface RedisTemplateService<T> {
    /**
     * 正常的插入
     *
     * @param k    k
     * @param v    v
     * @param time 時間 時間單位秒
     */
    void set(String k, T v, long time);
    LinkedHashMap getAndSet(String k, T v, long time);
    LinkedHashMap getAndSet(String k, T v);
    /**
     * 無過期時間的插入
     *
     * @param key
     * @param value
     */
    void set(String key, T value);
    /**
     * 獲取值
     *
     * @param key
     * @return
     */
    T get(String key);
    /**
     * 刪除值
     *
     * @param key
     * @return
     */
    Boolean del(String key);
    /**
     * 批量刪除
     *
     * @param keys
     * @return
     */
    Long del(List<String> keys);
    /**
     * 設(shè)置失效時間
     *
     * @param key
     * @param time
     * @return
     */
    Boolean expire(String key, long time);
    /**
     * 獲取過期時間
     *
     * @param key
     * @return
     */
    Long getExpire(String key);
    /**
     * 是否存在key
     *
     * @param key
     * @return
     */
    Boolean hasKey(String key);
    /**
     * 以增量的方式將long值存儲在變量中
     *
     * @param key
     * @param delta
     * @return
     */
    Long incr(String key, long delta);
    /**
     * 以減量的方式將long值存儲在變量中
     *
     * @param key
     * @param delta
     * @return
     */
    Long decr(String key, long delta);
    /**
     * 獲取變量中的指定map鍵是否有值,如果存在該map鍵則獲取值，沒有則返回null。
     *
     * @param key
     * @param hashKey
     * @return
     */
    T hGet(String key, String hashKey);
    /**
     * 新增hashMap值
     * 設(shè)置過期時間
     *
     * @param key
     * @param hashKey
     * @param value
     * @param time
     * @return
     */
    Boolean hSet(String key, String hashKey, Object value, long time);
    /**
     * 新增hashMap值
     *
     * @param key
     * @param hashKey
     * @param value
     */
    void hSet(String key, String hashKey, Object value);
    /**
     * 獲取變量中的鍵值對
     *
     * @param key
     * @return
     */
    Map<Object, T> hGetAll(String key);
    /**
     * 以map集合的形式添加鍵值對
     * 有過期時間
     *
     * @param key
     * @param map
     * @param time
     * @return
     */
    Boolean hSetAll(String key, Map<String, T> map, long time);
    /**
     * 以map集合的形式添加鍵值對
     *
     * @param key
     * @param map
     */
    void hSetAll(String key, Map<String, T> map);
    /**
     * 刪除變量中的鍵值對，可以傳入多個參數(shù)，刪除多個鍵值對。
     *
     * @param key
     * @param hashKey
     */
    Long hDel(String key, T... hashKey);
    /**
     * 判斷變量中是否有指定的map鍵。
     *
     * @param key
     * @param hashKey
     * @return
     */
    Boolean hHasKey(String key, String hashKey);
    /**
     * 延長過期時間
     *
     * @param key
     * @param hashKey
     * @param delta
     * @return
     */
    Long hIncr(String key, String hashKey, Long delta);
    /**
     * 減過期時間
     *
     * @param key
     * @param hashKey
     * @param delta
     * @return
     */
    Long hDecr(String key, String hashKey, Long delta);
    /**
     * 獲取變量中的值。
     *
     * @param key
     * @return
     */
    Set<T> sMembers(String key);
    /**
     * @param key
     * @param values
     * @return
     */
    Long sAdd(String key, T... values);
    /**
     * 向變量中批量添加值
     * 有過期時間
     *
     * @param key
     * @param time
     * @param values
     * @return
     */
    Long sAdd(String key, long time, T... values);
    /**
     * 檢查給定的元素是否在變量中
     *
     * @param key
     * @param value
     * @return
     */
    Boolean sIsMember(String key, T value);
    /**
     * 獲取變量中值的長度
     *
     * @param key
     * @return
     */
    Long sSize(String key);
    /**
     * 批量移除變量中的元素
     *
     * @param key
     * @param values
     * @return
     */
    Long sRemove(String key, T... values);
    /**
     * 獲取集合區(qū)間的值
     *
     * @param key
     * @param start
     * @param end
     * @return
     */
    List<T> lRange(String key, long start, long end);
    /**
     * 獲取隊列個數(shù)
     *
     * @param key
     * @return
     */
    Long lSize(String key);
    /**
     * 獲取集合中 對應(yīng)坐標的數(shù)據(jù)
     *
     * @param key
     * @param index
     * @return
     */
    T lIndex(String key, long index);
    /**
     * 插入隊列首部 單個
     * 無過期時間
     *
     * @param key
     * @param value
     * @return
     */
    Long lPush(String key, T value);
    /**
     * 插入隊列首部 （右推單個）
     * 有過期時間
     *
     * @param key
     * @param value
     * @param time
     * @return
     */
    Long lPush(String key, T value, long time);
    /**
     * 從隊列首部全部插入（右推全部）
     * 無過期時間
     *
     * @param key
     * @param values
     * @return
     */
    Long lPushAll(String key, T... values);
    /**
     * 從隊列首部全部插入（右推全部）
     * 設(shè)置過期時間 單位秒
     *
     * @param key
     * @param time
     * @param values
     * @return
     */
    Long lPushAll(String key, Long time, T... values);
    /**
     * List 按value值移除,和移除個數(shù)
     *
     * @param key
     * @param count
     * @param value
     * @return
     */
    Long lRemove(String key, long count, T value);
    /**
     * 分布式鎖 默認2分鐘
     *
     * @param k
     * @param l
     * @param v
     * @return
     */
    Boolean lock(String k, long l, T v);
    /**
     * 分布式鎖 默認2分鐘
     *
     * @param k
     * @param v
     * @return
     */
    Boolean lock(String k, T v);
    default boolean lock(String k, T v, String errorMsg) {
        Boolean lock = this.lock(k, v);
        if (!lock) {
            throw new BasicException(errorMsg);
        }
        return lock;
    }
    /**
     * 分布式鎖 設(shè)置過期時間的
     *
     * @param k
     * @param v
     * @param time
     * @param unit
     * @return
     */
    Boolean lock(String k, T v, long time, TimeUnit unit);
    /**
     * 死鎖(無過期時間的)
     *
     * @param k
     * @param v
     * @return
     */
    Boolean setIfAbsent(String k, T v);
    /**
     * 添加一個元素, zset與set最大的區(qū)別就是每個元素都有一個score，因此有個排序的輔助功能;  zadd
     *
     * @param k
     * @param v
     * @param score
     * @return
     */
    Boolean zadd(String k, T v, double score);
    /**
     * 刪除元素 zrem
     *
     * @param k k
     * @param v v
     */
    Long zRemove(String k, T v);
    /**
     * score的增加or減少 zincrby
     *
     * @param key
     * @param value
     * @param score
     */
    Double incrScore(String key, T value, double score);
    /**
     * 查詢value對應(yīng)的score   zscore
     *
     * @param key
     * @param value
     * @return
     */
    Double score(String key, T value);
    /**
     * 判斷value在zset中的排名  zrank
     *
     * @param key
     * @param value
     * @return
     */
    Long rank(String key, T value);
    /**
     * 返回集合的長度
     *
     * @param key
     * @return
     */
    Long size(String key);
    Set<T> zRange(String key, int start, int end);
    Set<ZSetOperations.TypedTuple<T>> zRangeWithScore(String key, int start, int end);
    Set<T> zRevRange(String key, int start, int end);
    Set<T> zSortRange(String key, int min, int max);
    /**
     * 生成編號
     *
     * @param redisKey
     * @param prefix
     * @param len
     * @return
     */
    String createNo(String redisKey, String prefix, int len);
}

針對RedisTemplateService進行實現(xiàn)。

public class RedisTemplateServiceImpl<T> implements RedisTemplateService<T> {
    @Autowired
    private RedisTemplate<String, T> redisTemplate;
    @Override
    public void set(String k, T v, long time) {
        this.redisTemplate.opsForValue().set(k, v, time, TimeUnit.SECONDS);
    }
    @Override
    public LinkedHashMap getAndSet(String k, T v, long time) {
        LinkedHashMap t = (LinkedHashMap) this.redisTemplate.opsForValue().getAndSet(k, v);
        this.expire(k, time);
        return t;
    }
    @Override
    public LinkedHashMap getAndSet(String k, T v) {
        return (LinkedHashMap) this.redisTemplate.opsForValue().getAndSet(k, v);
    }
    @Override
    public void set(String key, T value) {
        this.redisTemplate.opsForValue().set(key, value);
    }
    @Override
    public T get(String key) {
        return this.redisTemplate.opsForValue().get(key);
    }
    @Override
    public Boolean del(String key) {
        return this.redisTemplate.delete(key);
    }
    @Override
    public Long del(List<String> keys) {
        return this.redisTemplate.delete(keys);
    }
    @Override
    public Boolean expire(String key, long time) {
        return this.redisTemplate.expire(key, time, TimeUnit.SECONDS);
    }
    @Override
    public Long getExpire(String key) {
        return this.redisTemplate.getExpire(key, TimeUnit.SECONDS);
    }
    @Override
    public Boolean hasKey(String key) {
        return this.redisTemplate.hasKey(key);
    }
    @Override
    public Long incr(String key, long delta) {
        return this.redisTemplate.opsForValue().increment(key, delta);
    }
    @Override
    public Long decr(String key, long delta) {
        return this.redisTemplate.opsForValue().increment(key, -delta);
    }
    @Override
    public T hGet(String key, String hashKey) {
        return (T) this.redisTemplate.opsForHash().get(key, hashKey);
    }
    @Override
    public Boolean hSet(String key, String hashKey, Object value, long time) {
        this.redisTemplate.opsForHash().put(key, hashKey, value);
        return this.expire(key, time);
    }
    @Override
    public void hSet(String key, String hashKey, Object value) {
        this.redisTemplate.opsForHash().put(key, hashKey, value);
    }
    @Override
    public Map<Object, T> hGetAll(String key) {
        return (Map<Object, T>) this.redisTemplate.opsForHash().entries(key);
    }
    @Override
    public Boolean hSetAll(String key, Map<String, T> map, long time) {
        this.redisTemplate.opsForHash().putAll(key, map);
        return this.expire(key, time);
    }
    @Override
    public void hSetAll(String key, Map<String, T> map) {
        this.redisTemplate.opsForHash().putAll(key, map);
    }
    @Override
    public Long hDel(String key, T... hashKey) {
        return this.redisTemplate.opsForHash().delete(key, hashKey);
    }
    @Override
    public Boolean hHasKey(String key, String hashKey) {
        return this.redisTemplate.opsForHash().hasKey(key, hashKey);
    }
    @Override
    public Long hIncr(String key, String hashKey, Long delta) {
        return this.redisTemplate.opsForHash().increment(key, hashKey, delta);
    }
    @Override
    public Long hDecr(String key, String hashKey, Long delta) {
        return this.redisTemplate.opsForHash().increment(key, hashKey, -delta);
    }
    @Override
    public Set<T> sMembers(String key) {
        return this.redisTemplate.opsForSet().members(key);
    }
    @Override
    public Long sAdd(String key, T... values) {
        return this.redisTemplate.opsForSet().add(key, values);
    }
    @Override
    public Long sAdd(String key, long time, T... values) {
        Long count = this.redisTemplate.opsForSet().add(key, values);
        this.expire(key, time);
        return count;
    }
    @Override
    public Boolean sIsMember(String key, T value) {
        return this.redisTemplate.opsForSet().isMember(key, value);
    }
    @Override
    public Long sSize(String key) {
        return this.redisTemplate.opsForSet().size(key);
    }
    @Override
    public Long sRemove(String key, T... values) {
        return this.redisTemplate.opsForSet().remove(key, values);
    }
    @Override
    public List<T> lRange(String key, long start, long end) {
        return this.redisTemplate.opsForList().range(key, start, end);
    }
    @Override
    public Long lSize(String key) {
        return this.redisTemplate.opsForList().size(key);
    }
    @Override
    public T lIndex(String key, long index) {
        return this.redisTemplate.opsForList().index(key, index);
    }
    @Override
    public Long lPush(String key, T value) {
        return this.redisTemplate.opsForList().rightPush(key, value);
    }
    @Override
    public Long lPush(String key, T value, long time) {
        Long index = this.redisTemplate.opsForList().rightPush(key, value);
        this.expire(key, time);
        return index;
    }
    @Override
    public Long lPushAll(String key, T... values) {
        return this.redisTemplate.opsForList().rightPushAll(key, values);
    }
    @Override
    public Long lPushAll(String key, Long time, T... values) {
        Long count = this.redisTemplate.opsForList().rightPushAll(key, values);
        this.expire(key, time);
        return count;
    }
    @Override
    public Long lRemove(String key, long count, T value) {
        return this.redisTemplate.opsForList().remove(key, count, value);
    }
    @Override
    public Boolean lock(String k, long l, T v) {
        return this.redisTemplate.opsForValue().setIfAbsent(k, v, l, TimeUnit.MINUTES);
    }
    @Override
    public Boolean lock(String k, T v) {
        return this.redisTemplate.opsForValue().setIfAbsent(k, v, 2, TimeUnit.MINUTES);
    }
    @Override
    public Boolean lock(String k, T v, long time, TimeUnit unit) {
        return this.redisTemplate.opsForValue().setIfAbsent(k, v, time, unit);
    }
    @Override
    public Boolean setIfAbsent(String k, T v) {
        return this.redisTemplate.opsForValue().setIfAbsent(k, v);
    }
    @Override
    public Boolean zadd(String k, T v, double score) {
        return this.redisTemplate.opsForZSet().add(k, v, score);
    }
    @Override
    public Long zRemove(String k, T v) {
        return this.redisTemplate.opsForZSet().remove(k, v);
    }
    /**
     * score的增加or減少 zincrby
     *
     * @param key
     * @param value
     * @param score
     */
    @Override
    public Double incrScore(String key, T value, double score) {
        return this.redisTemplate.opsForZSet().incrementScore(key, value, score);
    }
    /**
     * 查詢value對應(yīng)的score   zscore
     *
     * @param key
     * @param value
     * @return
     */
    @Override
    public Double score(String key, T value) {
        return this.redisTemplate.opsForZSet().score(key, value);
    }
    /**
     * 判斷value在zset中的排名  zrank
     *
     * @param key
     * @param value
     * @return
     */
    @Override
    public Long rank(String key, T value) {
        return this.redisTemplate.opsForZSet().rank(key, value);
    }
    /**
     * 返回集合的長度
     *
     * @param key
     * @return
     */
    @Override
    public Long size(String key) {
        return this.redisTemplate.opsForZSet().zCard(key);
    }
    /**
     * 查詢集合中指定順序的值， 0 -1 表示獲取全部的集合內(nèi)容  zrange
     * <p>
     * 返回有序的集合，score小的在前面
     *
     * @param key
     * @param start
     * @param end
     * @return
     */
    @Override
    public Set<T> zRange(String key, int start, int end) {
        return this.redisTemplate.opsForZSet().range(key, start, end);
    }
    /**
     * 查詢集合中指定順序的值和score，0, -1 表示獲取全部的集合內(nèi)容
     *
     * @param key
     * @param start
     * @param end
     * @return
     */
    @Override
    public Set<ZSetOperations.TypedTuple<T>> zRangeWithScore(String key, int start, int end) {
        Set<ZSetOperations.TypedTuple<T>> typedTuples = this.redisTemplate.opsForZSet().rangeWithScores(key, start, end);
        return typedTuples;
    }
    /**
     * 查詢集合中指定順序的值  zrevrange
     * <p>
     * 返回有序的集合中，score大的在前面
     *
     * @param key
     * @param start
     * @param end
     * @return
     */
    @Override
    public Set<T> zRevRange(String key, int start, int end) {
        return this.redisTemplate.opsForZSet().reverseRange(key, start, end);
    }
    /**
     * 根據(jù)score的值，來獲取滿足條件的集合  zrangebyscore
     *
     * @param key
     * @param min
     * @param max
     * @return
     */
    @Override
    public Set<T> zSortRange(String key, int min, int max) {
        return this.redisTemplate.opsForZSet().rangeByScore(key, min, max);
    }
    @Override
    public String createNo(String redisKey, String prefix, int len) {
        //redis 自增 存在自增1 否則返回1
        Long incr = incr(redisKey, 1);
        //補全數(shù)字
        String leftPad = StringUtils.leftPad(incr.toString(), len ,"0");
        return MessageFormat.format("{0}{1}", prefix , leftPad);
    }
}

最終，我們將bean注入到系統(tǒng)中，以完成我們的工作。這是一個重要的步驟，它將使我們的應(yīng)用程序能夠正常運行，并啟動我們的業(yè)務(wù)流程。通過注入bean，我們可以更好地利用資源，使我們的應(yīng)用程序更加可靠和高效。

@Bean
@ConditionalOnMissingBean(RedisTemplateService.class)
public RedisTemplateService redisTemplateService() {
    return new RedisTemplateServiceImpl();
}

四，總結(jié)

Spring boot 已經(jīng)內(nèi)置了redis依賴，因此無需指定任何特定版本即可使用。
注意，使用redisTemplate時，默認采用的是JDK原生序列化，而為了能夠?qū)bject對象進行反序列化，我們需要改變其序列化方式。在這種情況下，建議使用Jackson2JsonRedisSerialize
使用Jackson2JsonRedisSerializer構(gòu)造器時，ObjectMapper內(nèi)部不會對LocalDateTime進行字符串化，而是保持對象化，因此反序列化時會報錯。為了解決這個問題，我們需要針對LocalDateTime配置自己的ObjectMapper
Jackson2JsonRedisSerializer序列化提供的ObjectMapper在沒有設(shè)置反序列化時，對象會以LinkHashMap的形式存儲，因此我們需要單獨對其進行配置。
cloud的項目中g(shù)ateway網(wǎng)關(guān)不知為何利用封裝的service獲取redis中的數(shù)據(jù)，獲取不到。暫時為發(fā)現(xiàn)問題原因所在，建議在gateway中注入RedisTemplate。找到原因后會寫博客記錄下的。

到此這篇關(guān)于Spring boot RedisTemplate 序列化服務(wù)化配置的文章就介紹到這了,更多相關(guān)Spring boot RedisTemplate 序列化內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: