Redis 分布式鎖遇到的序列化問題

作者： jaxer 2021-03-24 08:41:38

開發(fā) 前端分布式 Redis

最近使用 Redis 遇到了一個類似分布式鎖的場景，跟 Redis 實現分布式鎖類比一下，就是釋放鎖失敗，也就是緩存刪不掉。又踩了一個 Redis 的坑……本文主要對此做個復盤。

[[389269]]

場景描述

最近使用 Redis 遇到了一個類似分布式鎖的場景，跟 Redis 實現分布式鎖類比一下，就是釋放鎖失敗，也就是緩存刪不掉。又踩了一個 Redis 的坑……

這是什么個情況、又是怎樣排查的呢?

本文主要對此做個復盤。

問題排查

既然是釋放鎖有問題，那就先看看釋放鎖的代碼吧。

釋放鎖

釋放鎖使用了 Lua 腳本，代碼邏輯和 Lua 腳本如下：

釋放鎖示例代碼

public Object release(String key, String value) { 
  Object existedValue = stringRedisTemplate.opsForValue().get(key); 
  log.info("key:{}, value:{}, redis舊值：{}", key, value, existedValue); 
   
  DefaultRedisScript<Long> redisScript = new DefaultRedisScript<>(COMPARE_AND_DELETE, Long.class); 
  return stringRedisTemplate.execute(redisScript, Collections.singletonList(key), value); 
}

釋放鎖使用的 Lua 腳本

if redis.call('get',KEYS[1]) == ARGV[1] 
then 
    return redis.call('del',KEYS[1]) 
else 
    return 0 
end;

刪除腳本中，會先獲取 Redis key 的舊值，并與入參 value 比較，二者相等時才會刪除。

如果釋放成功，也就是 Redis 緩存刪除成功，返回值為 1，否則失敗返回為 0。

乍一看代碼似乎沒啥問題，測一下試試?

不過既然要釋放鎖，在此之前肯定要加鎖，先看看加鎖的邏輯吧。

加鎖

說到加鎖這里的邏輯，代碼里有兩種實現方式：

示例代碼一

public Object lock01(String key, String value) { 
  log.info("lock01, key={}, value={}", key, value); 
  return redisTemplate.opsForValue().setIfAbsent(key, value, LOCKED_TIME, TimeUnit.SECONDS); 
}

示例代碼二

public Object lock02(String key, String value) { 
  log.info("lock02, key={}, value={}", key, value); 
  return stringRedisTemplate.opsForValue().setIfAbsent(key, value, LOCKED_TIME, TimeUnit.SECONDS); 
}

其實它們的區(qū)別就在于前者使用了 RedisTemplate，而后者使用的是 StringRedisTemplate。

Q: 等等……為什么會有兩個 template??
A: 憋說了，是我挖的坑，RedisTemplate 是我加的……現在回想都沒想明白當初為什么這樣搞，可能真是腦子一時抽風了。

先測試一下這兩個方法?

測試一下

使用兩種方式分別加鎖，其中：lock01 為 k1 和 v1，lock02 為 k2 和 v2。

分別看下 k1、k2 的值(使用工具：RDM, Redis Desktop Manager)：

可以看到 v1 是有雙引號的，而 v2 沒有。

猜測應該是序列化的問題，看看 Redis 配置?

RedisTemplate 配置

加鎖那里可以看到，k1 使用了 RedisTemplate，而 k2 是 StringRedisTemplate，它們兩個的配置有什么區(qū)別呢?

其中 RedisTemplate 的配置是自定義的，如下：

@Configuration 
@AutoConfigureAfter(RedisAutoConfiguration.class) 
public class RedisConfig { 
  @Bean 
  public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) { 
    RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>(); 
    redisTemplate.setConnectionFactory(redisConnectionFactory); 
 
    // 使用 Jackson2JsonRedisSerialize 替換默認序列化 
    Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer 
        = new Jackson2JsonRedisSerializer<>(Object.class); 
 
    ObjectMapper objectMapper = new ObjectMapper(); 
    objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY); 
    objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL); 
    objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); 
 
    jackson2JsonRedisSerializer.setObjectMapper(objectMapper); 
 
    // 設置 key、value 的序列化規(guī)則（尤其是 value） 
    redisTemplate.setKeySerializer(new StringRedisSerializer()); 
    redisTemplate.setValueSerializer(jackson2JsonRedisSerializer); 
    redisTemplate.afterPropertiesSet(); 
 
    return redisTemplate; 
  } 
}

StringRedisTemplate 的配置是 SpringBoot 默認的，即：

@Configuration 
@ConditionalOnClass({RedisOperations.class}) 
@EnableConfigurationProperties({RedisProperties.class}) 
@Import({LettuceConnectionConfiguration.class, JedisConnectionConfiguration.class}) 
public class RedisAutoConfiguration { 
  public RedisAutoConfiguration() { 
  } 
 
  @Bean 
  @ConditionalOnMissingBean 
  public StringRedisTemplate stringRedisTemplate(RedisConnectionFactory redisConnectionFactory) throws UnknownHostException { 
    StringRedisTemplate template = new StringRedisTemplate(); 
    template.setConnectionFactory(redisConnectionFactory); 
    return template; 
  } 
}

PS: SpringBoot 版本為 2.1.13.RELEASE

點進去 StringRedisTemplate 看下：

public class StringRedisTemplate extends RedisTemplate<String, String> { 
     
  public StringRedisTemplate() { 
    // 注意這里的序列化設置 
    setKeySerializer(RedisSerializer.string()); 
    setValueSerializer(RedisSerializer.string()); 
    setHashKeySerializer(RedisSerializer.string()); 
    setHashValueSerializer(RedisSerializer.string()); 
  } 
  // ... 
}

注意下序列化設置，繼續(xù)跟進，看到底是什么方式：

public interface RedisSerializer<T> { 
  static RedisSerializer<String> string() { 
    return StringRedisSerializer.UTF_8; 
  } 
}

public class StringRedisSerializer implements RedisSerializer<String> { 
  public static final StringRedisSerializer UTF_8 = new StringRedisSerializer(StandardCharsets.UTF_8); 
    // ... 
}

可以看到，StringRedisTemplate 的 key 和 value 默認都是用 StringRedisSerializer(StandardCharsets.UTF_8) 進行序列化的。

而 RedisTemplate 的 key 使用 StringRedisSerializer，value 使用的是 Jackson2JsonRedisSerializer 序列化(至于為什么用這個，這里就不是我寫的了)。

到這里，基本可以定位到問題所在了：就是 RedisTemplate 的 value 序列化和 StringRedisTemplate 不一致。

如果改成一致就可以了嗎?驗證一下試試。

驗證推論

把 RedisTemplate 的 value 序列化方式修改為 StringRedisSerializer：

@Configuration 
@AutoConfigureAfter(RedisAutoConfiguration.class) 
public class RedisConfig { 
  @Bean 
  public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) { 
    RedisTemplate<String, Object> redisTemplate = new RedisTemplate<>(); 
       
    // ... 
 
    redisTemplate.setKeySerializer(new StringRedisSerializer()); 
    redisTemplate.setValueSerializer(new StringRedisSerializer()); 
 
    // ... 
    return redisTemplate; 
  } 
}