解決spring data redis的那些坑

更新時間：2021年09月16日 11:33:55 作者：一個松

這篇文章主要介紹了spring data redis的那些坑，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

spring data redis的那些坑

spring 的IOC很少有bug，AOPbug開始多起來，到了它的一些“玩具”一樣的組件，bug無處不在。而且跟一般的開源框架不同，在github上你報告issue，會被“這不是一個bug”強行關閉。開一博文記錄，給遇到同樣問題而苦惱的人歇歇腳。

1. 使用lua腳本，返回類型解析錯誤

背景：一般來講，就算腳本里沒有return語句，redis也是會返回執(zhí)行結(jié)果，看起來就像：{“Ok” = “ok”}，或者{“ok”:”ok”}。然而對于一些操作redis沒有返回，或者return語句后面返回一個值，spring包了的那一層殼就會出問題。影響的包：spring封裝了jedis的所有版本，包括：spring-data-redis 2.0以下的所有版本，以及使用了jedis的2.0以上版本：

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
            <version>2.0.0.RELEASE</version>
            <exclusions>
                <exclusion>
                    <groupId>io.lettuce</groupId>
                    <artifactId>lettuce-core</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

這種情況下就會遇到

XXX cannot be cast to XXX

原因：DefaultScriptExecutor.java類中：

    public <T> T execute(final RedisScript<T> script, final RedisSerializer<?> argsSerializer,
            final RedisSerializer<T> resultSerializer, final List<K> keys, final Object... args) {
        return template.execute((RedisCallback<T>) connection -> {
            final ReturnType returnType = ReturnType.fromJavaType(script.getResultType()); // return type is wrong.
            final byte[][] keysAndArgs = keysAndArgs(argsSerializer, keys, args);
            final int keySize = keys != null ? keys.size() : 0;
            if (connection.isPipelined() || connection.isQueueing()) {
                // We could script load first and then do evalsha to ensure sha is present,
                // but this adds a sha1 to exec/closePipeline results. Instead, just eval
                connection.eval(scriptBytes(script), returnType, keySize, keysAndArgs);
                return null;
            }
            return eval(connection, script, returnType, keySize, keysAndArgs, resultSerializer);
        });
    }

而作為消費者，一般會將返回值設置為Object，因為同一個腳本里有若干的邏輯，不同情況下返回值可能是布爾型，字符串型，Number型等。

    ScriptSource scriptSource = new ResourceScriptSource(new ClassPathResource("META-INF/scripts/redis.lua"));
    DefaultRedisScript<Object> redisScript = new DefaultRedisScript<Object>();
    redisScript.setScriptSource(scriptSource);
    redisScript.setResultType(Object.class);

而DefaultScriptExecutor的execute方法，會把Object類型解析為List類型，進而設置returnType為Multi。

public Object convert(Object result) {
        if (result instanceof String) {
            // evalsha converts byte[] to String. Convert back for consistency
            return SafeEncoder.encode((String) result);
        }
        if (returnType == ReturnType.STATUS) {
            return JedisConverters.toString((byte[]) result);
        }
        if (returnType == ReturnType.BOOLEAN) {
            // Lua false comes back as a null bulk reply
            if (result == null) {
                return Boolean.FALSE;
            }
            return ((Long) result == 1);
        }
        if (returnType == ReturnType.MULTI) {
            List<Object> resultList = (List<Object>) result;
            List<Object> convertedResults = new ArrayList<>();
            for (Object res : resultList) {
                if (res instanceof String) {
                    // evalsha converts byte[] to String. Convert back for
                    // consistency
                    convertedResults.add(SafeEncoder.encode((String) res));
                } else {
                    convertedResults.add(res);
                }
            }
            return convertedResults;
        }
        return result;
    }

會因為result（原本只是一個Object），被解析為List，轉(zhuǎn)換出了問題。此外，這里居然沒有設置null的轉(zhuǎn)換，難道null就不是List了。。。好在spring redis基于lettuce的實現(xiàn)不存在這個問題。

2. spring redis基于lettuce配置Client必須顯示調(diào)用

從官方的reference看，spring的lettuce的配置只需要簡單使用一個包含host、port、database、password等鏈接必須信息構造的RedisStandaloneConfiguration對象作為參數(shù)傳遞給LettuceConnectionFactory 的構造函數(shù)，同理連接池，然而實際使用中發(fā)現(xiàn)，ConnectionFactory用于建立連接的是從它的client屬性獲取的服務器地址等，因此必須調(diào)用afterPropertiesSet方法。

現(xiàn)在client信息有了，可以連接，但是連接池又未開啟，盡管已經(jīng)在構造器參數(shù)中指定過。受限于時間，還沒有調(diào)這個點。

    LettucePoolingClientConfiguration poolingClientConfiguration = LettucePoolingClientConfiguration.builder()
        .poolConfig(new GenericObjectPoolConfig())
        .build();

    RedisStandaloneConfiguration redisStandaloneConfiguration = new RedisStandaloneConfiguration(
        redisProperty.getHost(),redisProperty.getPort()
    );
    redisStandaloneConfiguration.setDatabase(redisProperty.getDatabase());

    LettuceConnectionFactory cf = new LettuceConnectionFactory(redisStandaloneConfiguration, poolingClientConfiguration);
    cf.afterPropertiesSet(); // must
    StringRedisTemplate stringRedisTemplate = new StringRedisTemplate();
    stringRedisTemplate.setConnectionFactory(cf);
    setSerializer(stringRedisTemplate);

spring data redis 的優(yōu)缺點

spring-data-redis是由spring的 cache api 整合 redis 而來，它的命名規(guī)則由spring cache 的規(guī)則來定義key和對key的管理，進一步弱化redis的API。

事實上redis提供的功能已經(jīng)足夠強大，并且可以直接使用，同時支持靈活的分庫。

spring 的 cache 功能主要由 @Cacheable @CacheEvict @CachePut 實現(xiàn)

@Cacheable 主要針對方法配置，能夠根據(jù)方法的請求參數(shù)對其結(jié)果進行緩存
@CachePut 主要針對方法配置，能夠根據(jù)方法的請求參數(shù)對其結(jié)果進行緩存，和 @Cacheable 不同的是，它每次都會觸發(fā)真實方法的調(diào)用
@CachEvict 主要針對方法配置，能夠根據(jù)一定的條件對緩存進行清空

默認情況下Spring使用CacheManagerBean 來實現(xiàn)，其實現(xiàn)有3種：EHCache，Redis，ConcurrentHashMap，默認的ConcurrentHashMap 是沒有過期的。

Redis 的使用也是要自己手動調(diào) expire ，所以暫時使用原生的 jedis ，直接調(diào)用 redis 的api

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: