iOS NSDecimalNumber 遇到的坑

前言:

我遇到了这个年纪不应该遇到的bug。这次我感觉到痛了。

BUG 1：NSDecimalNumber overflow exception

在使用NSDecimalNumber做金额计算的时候，如果不小心传入了错误的字符串金额，比如 @”“ 这样的空串，就有可能引发崩溃。

数字计算溢出崩溃.png

代码：

- (void)needNSDecimalBug {
    
    NSDecimalNumberHandler *roundDown = [NSDecimalNumberHandler decimalNumberHandlerWithRoundingMode:NSRoundDown scale:2 raiseOnExactness:NO raiseOnOverflow:NO raiseOnUnderflow:NO raiseOnDivideByZero:YES];
    
    NSDecimalNumber *a = [NSDecimalNumber decimalNumberWithString:@""];
    NSDecimalNumber *b = [NSDecimalNumber decimalNumberWithString:@""];

    // 下面这行计算得出 nan
    NSDecimalNumber *result_A = [a decimalNumberByAdding:b withBehavior:roundDown];
    NSLog(@"result_A: %@", result_A);
    
    // 下面这行造成崩溃
    NSDecimalNumber *result_B = [a decimalNumberByAdding:b];
    NSLog(@"result_B: %@", result_B);
}

判断一个数值是否为NaN可以使用系统方法：isnan(x)；注：x为数值类型，不是NSDecimalNumber，更不是NSNumber;

如果要判断一个NSDecimalNumber 是否为 NAN ，则使用下面的方法：

if ([number isEqualToNumber:NSDecimalNumber.notANumber]){
    NSLog(@"number is nan");
} else {
    NSLog(@"number:%@",number);
}

BUG 2：关于 NSDecimalNumber 和 0 的比较

比如当前商品金额是100块，然后你使用了一个减免150块钱的优惠券，这时候，做减法结果应该是 -50块。但是我作为商家可能倒贴给你50块钱？于是，在最终的金额结算页面，要把这个结果写成0，然而，就在我用负数和0比较的时候，出了bug。如下图。
图中的 resultA，在代码多次执行的时候，它有概率出现 1 或者 0，很诡异地算不准。
图中的 resultB，在代码多次执行的时候，它就没算准过。
图中的 resultC，才是正确的比较大小的方式。

数字和0比较的bug_1.png

数字和0比较的bug_2.png

这两个数字0，他们有什么区别呢？

1.png

代码

- (void)needBugNSDecimalCompare {
    
    NSDecimalNumber *zeroString = [NSDecimalNumber decimalNumberWithString:@"0"];
    NSDecimalNumber *zeroDecimal = [NSDecimalNumber zero];
    
    NSDecimalNumber *a = [NSDecimalNumber decimalNumberWithString:@"-9"];
    
    //错误的比较方式
    BOOL resultA = a > zeroString ? YES : NO;
    NSLog(@"resultA: %d", resultA);
    
    //错误的比较方式
    BOOL resultB = a > zeroDecimal ? YES : NO;
    NSLog(@"resultB: %d", resultB);

    //正确的比较方式, 和数字 0 的比较, 要使用 [NSDecimalNumber zero]
    NSComparisonResult resultC = [a compare:zeroDecimal];
    if (resultC == NSOrderedAscending) {
        NSLog(@"resultC: 小于");
    } else if (resultC == NSOrderedDescending) {
        NSLog(@"resultC: 大于");
    } else if (resultC == NSOrderedSame) {
        NSLog(@"resultC: 等于");
    } else {
        NSLog(@"resultC: 原地爆炸");
    }
}

附加: 关于加减乘除，结果四舍五入保留两位小数

加减乘除.png

代码：

- (void)needNSDecimalCalculation {
    
    /*
     NSRoundingMode: 解释
     NSRoundPlain    是四舍五入
     NSRoundDown     是向下取整
     NSRoundUp       是向上取整
     NSRoundBankers  是在四舍五入的基础上，当末尾数为5时，如果前一位是偶数,不变; 前一位是奇数,+1变成偶数.
     */
    
    //四舍五入,结果保留两位小数
    NSDecimalNumberHandler *roundPlain = [NSDecimalNumberHandler decimalNumberHandlerWithRoundingMode:NSRoundPlain scale:2 raiseOnExactness:NO raiseOnOverflow:NO raiseOnUnderflow:NO raiseOnDivideByZero:YES];
    
    NSDecimalNumber *a = [NSDecimalNumber decimalNumberWithString:@"2.36"];
    NSDecimalNumber *b = [NSDecimalNumber decimalNumberWithString:@"1.25"];
    
    NSDecimalNumber *Add = [a decimalNumberByAdding:b withBehavior:roundPlain];
    NSLog(@"加法: %@", Add);
    
    NSDecimalNumber *Subtract = [a decimalNumberBySubtracting:b withBehavior:roundPlain];
    NSLog(@"减法: %@", Subtract);
    
    NSDecimalNumber *Multiply = [a decimalNumberByMultiplyingBy:b withBehavior:roundPlain];
    NSLog(@"乘法: %@", Multiply);
    
    NSDecimalNumber *Dividing = [a decimalNumberByDividingBy:b withBehavior:roundPlain];
    NSLog(@"除法: %@", Dividing);
}

后续

iOS 两个数相乘导致 NSDecimalNumber overflow exception 错误的分析及解决

结语：

这波是我第二次接触 NSDecimalNumber。我看人家老代码工作挺正常的，为什么我接手做了改动之后，就出现了奇妙的bug呢。不管是不是我惹出来的bug，都得是我来改。没想到的是，这个bug居然折腾了我一段时间。单步，单步，单步，运行，运行，运行。痛。