spring data redis 的那些坑

待我称王封你为后i 2024-02-18 18:50 44阅读 0赞

spring 的IOC很少有bug，AOPbug开始多起来，到了它的一些“玩具”一样的组件，bug无处不在。而且跟一般的开源框架不同，在github上你报告issue，会被“这不是一个bug”强行关闭。开一博文记录，给遇到同样问题而苦恼的人歇歇脚。

## 1. 使用lua脚本，返回类型解析错误 ##

背景：一般来讲，就算脚本里没有return语句，redis也是会返回执行结果，看起来就像：\{“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，转换出了问题。此外，这里居然没有设置null的转换，难道null就不是List了。。。好在spring redis基于lettuce的实现不存在这个问题。

## 2. spring redis基于lettuce配置Client必须显示调用 ##

从官方的reference看，spring的lettuce的配置只需要简单使用一个包含host、port、database、password等链接必须信息构造的RedisStandaloneConfiguration对象作为参数传递给LettuceConnectionFactory 的构造函数，同理连接池，然而实际使用中发现，ConnectionFactory用于建立连接的是从它的client属性获取的服务器地址等，因此必须调用afterPropertiesSet方法。现在client信息有了，可以连接，但是连接池又未开启，尽管已经在构造器参数中指定过。受限于时间，还没有调这个点。

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);