Redis 浮點數(shù)累計實現(xiàn)

作者：老鄭 2023-07-05 08:00:58

按照官方文檔的說法 INCRBYFLOAT 可以表示小數(shù)位 17 位。比如按照 jedis 的 api 來說，我們能夠使用的就是在 double 的精度范圍內(nèi)，也就是 15-16位。這里我也看了 redis 的源碼，他在底層實現(xiàn)是通過 c 語言的 long double 類型來進(jìn)行計算的。

Redis 浮點數(shù)累計主要是有兩個命令

INCRBYFLOAT 是 SET 指令的浮點數(shù)累計
HINCRBYFLOAT 是 HASH 類型的浮點數(shù)累計

在內(nèi)部 HINCRBYFLOAT 和 INCRBYFLOAT 自增實現(xiàn)相同。所以我們分析 INCRBYFLOAT 即可。

基本使用

直接使用指令。

INCRBYFLOAT mykey 0.1
INCRBYFLOAT mykey 1.111
INCRBYFLOAT mykey 1.111111

使用 lua 腳本的方式，因為 redis 可以通過 lua 腳本來保證操作的原子性，所以當(dāng)我們同時操作多個 key 的時候一般使用 lua 腳本的方式。

eval "return redis.call('INCRBYFLOAT', KEYS[1], ARGV[1])" 1 mykey1 "1.11" 
eval "return redis.call('INCRBYFLOAT', KEYS[1], ARGV[1])" 1 mykey1 "1.11111" 
eval "return redis.call('INCRBYFLOAT', KEYS[1], ARGV[1])" 1 mykey1 "1.11111"

INCRBYFLOAT 可表示范圍

void incrbyfloatCommand(client *c) {
    long double incr, value;
    robj *o, *new;

    o = lookupKeyWrite(c->db,c->argv[1]);
    if (checkType(c,o,OBJ_STRING)) return;
    if (getLongDoubleFromObjectOrReply(c,o,&value,NULL) != C_OK ||
        getLongDoubleFromObjectOrReply(c,c->argv[2],&incr,NULL) != C_OK)
        return;

    value += incr;
    if (isnan(value) || isinf(value)) {
        addReplyError(c,"increment would produce NaN or Infinity");
        return;
    }
    new = createStringObjectFromLongDouble(value,1);
    if (o)
        dbReplaceValue(c->db,c->argv[1],new);
    else
        dbAdd(c->db,c->argv[1],new);
    signalModifiedKey(c,c->db,c->argv[1]);
    notifyKeyspaceEvent(NOTIFY_STRING,"incrbyfloat",c->argv[1],c->db->id);
    server.dirty++;
    addReplyBulk(c,new);

    /* Always replicate INCRBYFLOAT as a SET command with the final value
     * in order to make sure that differences in float precision or formatting
     * will not create differences in replicas or after an AOF restart. */
    rewriteClientCommandArgument(c,0,shared.set);
    rewriteClientCommandArgument(c,2,new);
    rewriteClientCommandArgument(c,3,shared.keepttl);
}

源碼地址：https://github.com/redis/redis/blob/unstable/src/t_string.c long double 是 c 語言的長雙精度浮點型，在 x86 的 64 位操作系統(tǒng)上占通常占用 16 字節(jié)(128 位)，相較于 8 字節(jié)的 double 類型具有更大的范圍和更高的精度。（這部分來源于 chatgpt）因為 redis 采用的 long double 類型來做浮點數(shù)計算，所以 redis 就可以保證到小數(shù)點后 17 位的精度。整數(shù)位也可以表示 17 位 redis 的浮點數(shù)計算通常情況下會丟失精度嗎？通常情況下是不會的，但是不能保證一定不會。

浮點數(shù)范圍測試

測試代碼如下：

public class RedisIncrByFloatTest {

    public static void main(String[] args) {
        Jedis jedis = new Jedis("127.0.0.1", 6379);
        BigDecimal decimalIncr = java.math.BigDecimal.ZERO;
        String key = "IncrFloat:Digit100";


        //測試精度
        test_accuracy(jedis, decimalIncr, key);

        //測試正浮點數(shù)最大值
        test_max_positive_float(jedis, decimalIncr, key);

        jedis.disconnect();
        jedis.close();
    }

    private static void test_max_positive_float(Jedis jedis, BigDecimal decimalIncr, String key) {
        jedis.del(key);
        String value = "99999999999999999.00000000000000003";
        List<String> evalKeys = Collections.singletonList(key);
        List<String> evalArgs = Collections.singletonList(value);
        String luaStr = "redis.call('INCRBYFLOAT', KEYS[1], ARGV[1]) return redis.call('GET', KEYS[1])";
        Object result = jedis.eval(luaStr, evalKeys, evalArgs);
        decimalIncr = decimalIncr.add(new BigDecimal(value));
        BigDecimal redisIncr = new BigDecimal(String.valueOf(result));

        value = "0.99999999999999996";
        evalKeys = Collections.singletonList(key);
        evalArgs = Collections.singletonList(value);
        luaStr = "redis.call('INCRBYFLOAT', KEYS[1], ARGV[1]) return redis.call('GET', KEYS[1])";
        result = jedis.eval(luaStr, evalKeys, evalArgs);
        decimalIncr = decimalIncr.add(new BigDecimal(value));
        redisIncr = new BigDecimal(String.valueOf(result));


        boolean eq = comparteNumber(redisIncr, decimalIncr);
        if (eq) {
            System.out.println("累計結(jié)果正確, 整數(shù)位: " + 17 + "位, 結(jié)果期望值: decimalIncr " + decimalIncr.toPlainString() + ", 目標(biāo)值(redis):" + redisIncr.toPlainString());
        } else {
            System.out.println("累計結(jié)果不正確, 整數(shù)位: " + 17 + "位, 期望值: decimalIncr " + decimalIncr.toPlainString() + ", 目標(biāo)值(redis):" + redisIncr.toPlainString());
        }
    }

    private static void test_accuracy(Jedis jedis, BigDecimal decimalIncr, String key) {
        jedis.del(key);
        for (int i = 16; i < 30; i++) {
            String value = createValue(i);
            final List<String> evalKeys = Collections.singletonList(key);
            final List<String> evalArgs = Collections.singletonList(value);
            String luaStr = "redis.call('INCRBYFLOAT', KEYS[1], ARGV[1]) return redis.call('GET', KEYS[1])";

            Object result = jedis.eval(luaStr, evalKeys, evalArgs);
            decimalIncr = decimalIncr.add(new BigDecimal(value));
            BigDecimal redisIncr = new BigDecimal(String.valueOf(result));
            boolean eq = comparteNumber(redisIncr, decimalIncr);
            if (eq) {
                System.out.println("累計結(jié)果正確, 整數(shù)位: " + i + "位, 結(jié)果期望值: decimalIncr " + decimalIncr.toPlainString() + ", 目標(biāo)值(redis):" + redisIncr.toPlainString());
            } else {
                System.out.println("累計結(jié)果不正確, 整數(shù)位: " + i + "位, 期望值: decimalIncr " + decimalIncr.toPlainString() + ", 目標(biāo)值(redis):" + redisIncr.toPlainString());
                break;
            }
        }
    }

    private static String createValue(int i) {
        String result = "9" + "0".repeat(Math.max(0, i - 1));
        return result + ".00000000000000003";
    }

    private static boolean comparteNumber(BigDecimal redisIncr, BigDecimal decimalIncr) {
        return decimalIncr.compareTo(redisIncr) == 0;
    }
}

輸出結(jié)果：

累計結(jié)果正確, 整數(shù)位: 16位, 結(jié)果期望值: decimalIncr 9000000000000000.00000000000000003, 目標(biāo)值(redis):9000000000000000.00000000000000003
累計結(jié)果正確, 整數(shù)位: 17位, 結(jié)果期望值: decimalIncr 99000000000000000.00000000000000006, 目標(biāo)值(redis):99000000000000000.00000000000000006
累計結(jié)果不正確, 整數(shù)位: 18位, 期望值: decimalIncr 999000000000000000.00000000000000009, 目標(biāo)值(redis):999000000000000000
累計結(jié)果正確, 整數(shù)位: 17位, 結(jié)果期望值: decimalIncr 99999999999999999.99999999999999999, 目標(biāo)值(redis):99999999999999999.99999999999999999

INCRBYFLOAT 導(dǎo)致精度丟失

INCRBYFLOAT 導(dǎo)致精度丟失有兩種情況：

累計的范圍值超過 INCRBYFLOAT 所能表示的最大精度范圍，在 double 范圍內(nèi)。

INCRBYFLOAT 底層計算是通過long double 來計算的在 C語言中 long double占用128 位,其范圍為: 最小值: ±5.4×10^-4951 最大值: ±1.1×10^4932 能表示的有效數(shù)字在34~35位之間。

我們使用類似 jedis 的 api 提供的是 double 類型的參數(shù)，可能在調(diào)用之前，參數(shù)轉(zhuǎn)換的過程就發(fā)生了精度問題。比如

StringRedisTemplate template = new StringRedisTemplate();        
template.opsForValue().increment("v1", 1.3D);

在 RedisTemplate 的這個 increment 接受的參數(shù)類型就是一個 double 所以會發(fā)生精度問題

C 語言長雙精度類型

因為 redis 底層采用的是long double 計算，所以這個問題轉(zhuǎn)化為長雙精度(long double)為什么沒有精度問題? 這是因為 long double 具有更大的范圍和更高的精度。long double 的范圍和精度高于 double 類型:

范圍更大:long double 可以表示更大和更小的數(shù)字
精度更高:long double 可以表示的有效數(shù)字多于 double 類型這意味著,對于同樣的浮點計算,long double 具有更少的舍入誤差。

具體來說,幾點原因造成 long double 沒有精度問題:

long double 使用更多的bit位來表示浮點數(shù)。
long double 使用四舍五入(rounding to nearest)而不是銀行家舍入(bankers' rounding),導(dǎo)致更少的誤差累加。
許多編譯器及 CPU 針對 long double 具有優(yōu)化, 會生成精度更高的機(jī)器碼來執(zhí)行 long double 計算。
long double 內(nèi)部采用更大的指數(shù)域, 能更準(zhǔn)確地表示相同范圍內(nèi)的數(shù)字。

綜上,long double 的更廣范圍和更高精度,讓它在相同的浮點計算中具有更少的舍入誤差。這也就解釋了為什么 long double 沒有明顯的精度問題,因為它天生就是為了提供更高精度而設(shè)計的。相比之下,double 使用的位數(shù)相對有限,即使采用折中舍入法,在一些場景下它的誤差也可能累加顯著。所以總的來說,long double 之所以沒有精度問題,主要還是源于其更大的范圍和更高的內(nèi)在精度。

問題總結(jié)

Redis 浮點數(shù)累計操作 INCRBYFLOAT 不適合精度要求比較高的金額計算。
Redis 浮點數(shù)累計操作 INCRBYFLOAT 也不能平替 BigDecimal 計算，如果一定需要存儲可以考慮通過 lua 腳本實現(xiàn) CAS 進(jìn)行修改，最終存儲為 String 類型的一個結(jié)果。
Redis 的浮點數(shù)雖然做了比較好的優(yōu)化，但是沒有從根本解決計算精度問題。

參考文檔

https://redis.io/commands/incrbyfloat/。
https://wiki.c2.com/?BankersRounding。
https://www.wikihow.com/Round-to-the-Nearest-Tenth。
https://learn.microsoft.com/zh-cn/cpp/c-language/type-long-double?view=msvc-170。
https://learn.microsoft.com/zh-cn/cpp/c-runtime-library/reference/strtold-strtold-l-wcstold-wcstold-l?view=msvc-170。

責(zé)任編輯：姜華來源：運維開發(fā)故事

Redis 數(shù)據(jù)庫