使用RedisAtomicInteger計數出現少計問題及解決

RedisAtomicInteger計數出現少計

最近工作中遇到了這樣一個場景

同一個外部單號生成了多張出庫單，等待所有相關的出庫單都出庫成功後回覆成功訊息外部系統呼叫方。因為是分散式布系統，我使用了RedisAtomicInteger計數器來判斷出庫單是否全部完成，數量達成時回覆成功訊息給外部系統呼叫方。

在本地測試和測試環境測試時都沒有發現問題，到了生產環境後，發現偶爾出現所有出庫單都已經出庫，但沒有回覆訊息給呼叫方，如：出庫單15張，但計數器只有14。

分析

開始以為是有單據漏計算了，通過紀錄檔分析，發現所有的出庫單都統計進去了。

然後通過增加開啟偵錯紀錄檔，發現最開始的2張出庫單統計後的值都為1，少了1個。

原因

redis的increment是原子性，但new RedisAtomicInteger時會呼叫set方法來設定初始值，set方法是可以被後面的方法覆蓋的。

edisAtomicInteger redisAtomicInt = new RedisAtomicInteger(countKey, redisTemplate.getConnectionFactory());
  
// spring-data-redis-1.8.13原碼
public RedisAtomicInteger(String redisCounter, RedisConnectionFactory factory) {
        this(redisCounter, factory, null);
    }
  
private RedisAtomicInteger(String redisCounter, RedisConnectionFactory factory, Integer initialValue) {
        RedisTemplate<String, Integer> redisTemplate = new RedisTemplate<String, Integer>();
        redisTemplate.setKeySerializer(new StringRedisSerializer());
        redisTemplate.setValueSerializer(new GenericToStringSerializer<Integer>(Integer.class));
        redisTemplate.setExposeConnection(true);
        redisTemplate.setConnectionFactory(factory);
        redisTemplate.afterPropertiesSet();
 
        this.key = redisCounter;
        this.generalOps = redisTemplate;
        this.operations = generalOps.opsForValue();
 
        if (initialValue == null) {
            if (this.operations.get(redisCounter) == null) {
                set(0);
            }
        } else {
            set(initialValue);
        }
    }

解決方法

網上看到的都是加業務鎖或升級spring-data-redis版本。

但老專案升級spring-data-redis版本可能會引起相容性問題，加業務鎖又增加了程式碼複雜度。

那有沒有更簡單方法呢，有。竟然是set方法導致的值覆蓋，那就不走set方法就可以了。

增加下面一行程式碼解決問題

// Fixed bug 前幾個數累計重複問題
redisTemplate.opsForValue().setIfAbsent(countKey, 0);

使用RedisAtomicInteger中間遇到的問題

RedisAtomicInteger是springdata中在redis的基礎上實現的原子計數器，在以下maven依賴包中:

<groupId>org.springframework.data</groupId>     
<artifactId>spring-data-redis</artifactId> 

當使用RedisAtomicInteger(String redisCounter, RedisOperations<String, Integer> template,...)函數構建範例的情況下，在使用INCR或者DECR時，會遇到ERR value is not an integer or out of range錯誤，顯示操作的資料不是一個整數或者超出範圍。

參考redis命令說明我們知道incr對操作值的要求

這是一個針對字串的操作，因為 Redis 沒有專用的整數型別，所以 key 內儲存的字串被解釋為十進位制 64 位有符號整數來執行 INCR 操作。如果值包含錯誤的型別，或字串型別的值不能表示為數位，那麼返回一個錯誤。

從redis範例中檢視該key的value,會發現結果類似這樣：

"xacxedx00x05srx00x11java.lang.Integerx12xe2xa0xa4xf7x81x878x02x00x01Ix00x05valuexrx00x10java.lang.Numberx86xacx95x1dx0bx94xe0x8bx02x00x00xpx00x00x00x01"

原因在於value使用的序列化方式是JdkSerializationRedisSerializer,這和INCR命令對結果的要求是違背的。

該使用哪種序列化方式把value放進去呢？按照INCR命令對結果的要求，最容易想到StringRedisSerializer，但經過嘗試這也行不通

會報java.lang.ClassCastException: java.lang.Integer cannot be cast to java.lang.String。

如果看過RedisAtomicInteger的原始碼，在private RedisAtomicInteger(String redisCounter, RedisConnectionFactory factory, Integer initialValue)中會發現方法內部建立了RedisTemplate範例，對value設定的序列化方式是GenericToStringSerializer。

該序列化內部使用spring core包下的
org.springframework.core.convert.support.DefaultConversionService作為預設的物件和字串的轉換方式，主要為了滿足大多數環境的要求。

至此，我們終於知道了錯誤的根本原因，構造RedisAtomicInteger時傳入的redisTemplate是有問題的，value的預設序列化方式不滿足RedisAtomicInteger的需要。那麼問題也迎刃而解，將GenericToStringSerializer作為redisTemplate的value序列化方式。

這樣雖然解決了問題，但很麻煩，很可能為了RedisAtomicInteger的要求需要再建立一個redisTemplate，簡直不能忍受。再看RedisAtomicInteger的原始碼，發現建構函式除了可以用redisTemplate,還可以用RedisConnectionFactory，嘗試之後，完美解決。

以上為個人經驗，希望能給大家一個參考，也希望大家多多支援it145.com。