Redis 分散ロックで発生するシリアル化の問題

[[389269]]

シナリオの説明

最近、Redis を使用しているときに、分散ロックに似たシナリオに遭遇しました。 Redis の分散ロックの実装と同様に、ロックの解放に失敗しました。つまり、キャッシュを削除できなかったことになります。私はまた別のRedisの穴に足を踏み入れました...

これはどのような状況ですか? また、どのようにトラブルシューティングすればよいですか?

この記事では主にこれについてレビューします。

トラブルシューティング

ロックの解除に問題があるので、まずはロックを解除するコードを見てみましょう。

ロックを解除

ロックを解除するには Lua スクリプトを使用します。コードロジックと Lua スクリプトは次のとおりです。

ロック解除サンプルコード

パブリックオブジェクトリリース(文字列キー、文字列値) {
  オブジェクトexistedValue = stringRedisTemplate.opsForValue().get( key );
  log.info( "キー:{}、値:{}、redis の古い値: {}" 、キー、値、存在する値); 
   
  DefaultRedisScript<Long> redisScript = 新しい DefaultRedisScript<>(COMPARE_AND_DELETE, Long.class);
 stringRedisTemplate.execute ( redisScript 、 Collections.singletonList(キー)、 値 )を返します。
 }

ロックを解除するために使用されるLuaスクリプト

redis.call( 'get' ,KEYS[1]) == ARGV[1]の場合
それから 
 redis.call( 'del' ,KEYS[1])を返す
それ以外 
 0を返す
終わり;

削除スクリプトでは、まず Redis キーの古い値が取得され、入力パラメータ値と比較されます。両者が等しい場合にのみ削除されます。

解放が成功した場合、つまり Redis キャッシュが正常に削除された場合、戻り値は 1 になります。それ以外の場合は失敗し、戻り値は 0 になります。

一見すると、コードは問題ないように見えます。テストしてみましょう。

ただし、ロックを解除する必要があるため、その前にロックする必要があります。まずロックのロジックを見てみましょう。

ロック

ロックのロジックに関しては、コードに実装する方法が 2 つあります。

サンプルコード1

パブリックオブジェクト lock01(文字列キー、文字列値) {
  log.info( "lock01, キー={}, 値={}" ,キー, 値);
 redisTemplate.opsForValue().setIfAbsent(キー、値、LOCKED_TIME、TimeUnit.SECONDS )を返します。
 }

サンプルコード2

パブリックオブジェクト lock02(文字列キー、文字列値) {
  log.info( "lock02, キー={}, 値={}" ,キー, 値);
 stringRedisTemplate.opsForValue().setIfAbsent(キー、値、LOCKED_TIME、TimeUnit.SECONDS )を返します。
 }

実際、それらの違いは、前者は RedisTemplate を使用し、後者は StringRedisTemplate を使用することです。

Q: ちょっと待ってください…なぜテンプレートが 2 つあるのですか?
A: 実を言うと、穴を掘ったのは私です。 RedisTemplate を追加しました... 今考えてみると、なぜそうしたのかまだわかりません。たぶん頭が固まってしまっただけでしょう。

まずこの 2 つの方法をテストしてみてはいかがでしょうか?

試してみる

それぞれロックするには 2 つの方法を使用します。lock01 は k1 と v1、lock02 は k2 と v2 です。

k1 と k2 の値をそれぞれ見てみましょう (ツール: RDM、Redis Desktop Manager を使用)。

v1 には二重引用符がありますが、v2 には二重引用符がないことがわかります。

シリアル化の問題だと思います。 Redis の設定を見てみましょう。

Redisテンプレートの設定

ロックを見るとわかるように、k1 は RedisTemplate を使用し、k2 は StringRedisTemplate を使用しています。それぞれの構成の違いは何ですか?

RedisTemplate の構成は次のようにカスタマイズされます。

 @構成
@AutoConfigureAfter(RedisAutoConfiguration.クラス)
パブリッククラスRedisConfig {
  @ビーン
パブリックRedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
    RedisTemplate<String, Object> redisTemplate = 新しい RedisTemplate<>();
    redisTemplate.setConnectionFactory(redisConnectionFactory); 
 
    // Jackson2JsonRedisSerializeを使用してデフォルトのシリアル化を置き換えます
    Jackson2JsonRedisSerializer<オブジェクト> jackson2JsonRedisSerializer
        = 新しい Jackson2JsonRedisSerializer<>(Object.class); 
 
    オブジェクトマッパー objectMapper = 新しいオブジェクトマッパー();
    objectMapper.setVisibility(PropertyAccessor. ALL 、 JsonAutoDetect.Visibility. ANY );
    オブジェクトマッパーのデフォルトタイピングを有効にします(ObjectMapper.DefaultTyping.NON_FINAL);
    objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false ); 
 
    jackson2JsonRedisSerializer.setObjectMapper(objectMapper); 
 
    //キーと値（特に値）のシリアル化ルールを設定します
    redisTemplate.setKeySerializer(新しい StringRedisSerializer());
    redisTemplate.setValueSerializer(jackson2JsonRedisSerializer);
    redisTemplate.afterPropertiesSet(); 
 
 redisTemplateを返します。
  }
 }

StringRedisTemplate の構成は SpringBoot のデフォルトの構成です。

 @構成
@ConditionalOnClass({RedisOperations.class})
 @EnableConfigurationProperties({RedisProperties.class})
 @Import({LettuceConnectionConfiguration.class、JedisConnectionConfiguration.class}) をインポートします。
パブリッククラスRedisAutoConfiguration {
パブリックRedisAutoConfiguration() {
  } 
 
  @ビーン
  @条件付きで欠落しているBean
パブリックStringRedisTemplate stringRedisTemplate(RedisConnectionFactory redisConnectionFactory) はUnknownHostExceptionをスローします {
    StringRedisTemplate テンプレート = 新しい StringRedisTemplate();
    テンプレート。setConnectionFactory(redisConnectionFactory);
戻りテンプレート;
  }
 }

PS: SpringBootのバージョンは2.1.13.RELEASEです

StringRedisTemplate をクリックして確認してみましょう。

パブリッククラスStringRedisTemplateはRedisTemplate<String, String>を拡張します。 
     
パブリックStringRedisテンプレート() {
    // ここでシリアル化の設定に注意してください
    キーシリアライザーを設定します(RedisSerializer.string());
    RedisSerializer を setValueSerializer(RedisSerializer.string());
    RedisSerializer を setHashKeySerializer(RedisSerializer.string());
    RedisSerializer を setHashValueSerializer(RedisSerializer.string());
  }
  // ...
 }

シリアル化設定に注意し、方法が何であるかを確認するためにフォローアップを続けます。

パブリックインターフェースRedisSerializer<T> {
静的RedisSerializer<String>文字列() {
 StringRedisSerializer.UTF_8を返します。
  }
 }

パブリッククラスStringRedisSerializerはRedisSerializer<String>を実装します。
公共 静的最終 StringRedisSerializer UTF_8 = 新しい StringRedisSerializer(StandardCharsets.UTF_8);
    // ...
 }

ご覧のとおり、StringRedisTemplate のキーと値は、デフォルトで StringRedisSerializer(StandardCharsets.UTF_8) によってシリアル化されます。

RedisTemplate のキーは StringRedisSerializer を使用し、値は Jackson2JsonRedisSerializer を使用してシリアル化されています (なぜこれを使用するかについては、ここでは書きません)。

この時点で、基本的に問題を特定できます。RedisTemplate の値のシリアル化が StringRedisTemplate と一致していません。

一貫性を保つために変更しても大丈夫でしょうか?確認してみてください。

推論を検証する

RedisTemplate の値のシリアル化メソッドを StringRedisSerializer に変更します。

 @構成
@AutoConfigureAfter(RedisAutoConfiguration.クラス)
パブリッククラスRedisConfig {
  @ビーン
パブリックRedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
    RedisTemplate<String, Object> redisTemplate = 新しい RedisTemplate<>(); 
       
    // ... 
 
    redisTemplate.setKeySerializer(新しい StringRedisSerializer());
    redisTemplate.setValueSerializer(新しい StringRedisSerializer()); 
 
    // ...
 redisTemplateを返します。
  }
 }