BigDecimal精度與相等比較的坑

先想一下，創建BigDecimal對象的時候一般是怎么創建的？

• new一個，傳進去值

• BigDecimal.valueOf方法，傳進去值

 

作為一個數字類型，經常有的操作是比較大小，有一種情況是比較是否相等。用equal方法還是compareTo方法？這里就是一個大坑

//new 傳進去一個double
BigDecimal newZero = new BigDecimal(0.0);
System.out.println(BigDecimal.ZERO.equals(newZero));
 
//new 傳進去一個字符串
BigDecimal stringNewZero = new BigDecimal("0.0");
System.out.println(BigDecimal.ZERO.equals(stringNewZero));
 
//valueOf  傳進去一個double
BigDecimal noScaleZero = BigDecimal.valueOf(0.0);
System.out.println(BigDecimal.ZERO.equals(noScaleZero));
 
//valueOf  傳進去一個double，再手動設置精度為1
BigDecimal scaleZero = BigDecimal.valueOf(0.0).setScale(1);
System.out.println(BigDecimal.ZERO.equals(scaleZero));

 

用於比較的值全都是0，猜一猜上面幾個equals方法返回的結果是什么？全都是true？no no no...

true
false
false
false

 

驚不驚喜，意不意外？原因是什么呢？看一下BigDecimal的equals方法的實現：

public boolean equals(Object x) {
    //類型不同，直接返回false
    if (!(x instanceof BigDecimal))
        return false;
    BigDecimal xDec = (BigDecimal) x;
    //同一個對象，直接返回true
    if (x == this)
        return true;
    //精度不同，直接返回false！！
    if (scale != xDec.scale)
        return false;
    long s = this.intCompact;
    long xs = xDec.intCompact;
    if (s != INFLATED) {
        if (xs == INFLATED)
            xs = compactValFor(xDec.intVal);
        return xs == s;
    } else if (xs != INFLATED)
        return xs == compactValFor(this.intVal);
 
    return this.inflated().equals(xDec.inflated());
}

 

從前面三個簡單的判斷就可以看出來，debug跟一下就知道是上面equals方法有三個返回false，都是因為精度不同。那么BigDecimal.ZERO的精度是多少呢？看下源碼：

// Cache of common small BigDecimal values.
private static final BigDecimal zeroThroughTen[] = {
    new BigDecimal(BigInteger.ZERO,       0,  0, 1),
    new BigDecimal(BigInteger.ONE,        1,  0, 1),
    new BigDecimal(BigInteger.valueOf(2), 2,  0, 1),
    new BigDecimal(BigInteger.valueOf(3), 3,  0, 1),
    new BigDecimal(BigInteger.valueOf(4), 4,  0, 1),
    new BigDecimal(BigInteger.valueOf(5), 5,  0, 1),
    new BigDecimal(BigInteger.valueOf(6), 6,  0, 1),
    new BigDecimal(BigInteger.valueOf(7), 7,  0, 1),
    new BigDecimal(BigInteger.valueOf(8), 8,  0, 1),
    new BigDecimal(BigInteger.valueOf(9), 9,  0, 1),
    new BigDecimal(BigInteger.TEN,        10, 0, 2),
};
 
 
/**
 * The value 0, with a scale of 0.
 *
 * @since  1.5
 */
public static final BigDecimal ZERO = zeroThroughTen[0];

BigDecimal.ZERO值為0，精度為0.

 

而上面幾種返回false的case，都是因為精度不同。精度不同的原因，則是BigDecimal對象初始化的方式不同,從源碼上看，前三種初始化的方式都不同。

所以說，BigDecimal比較大小，還是用compareTo方法比較靠譜，改為compareTo之后，上面四個case返回的結果都是相等：

BigDecimal newZero = new BigDecimal(0.0);
System.out.println(BigDecimal.ZERO.compareTo(newZero));
 
BigDecimal stringNewZero = new BigDecimal("0.0");
System.out.println(BigDecimal.ZERO.compareTo(stringNewZero));
 
BigDecimal noScaleZero = BigDecimal.valueOf(0.0);
System.out.println(BigDecimal.ZERO.compareTo(noScaleZero));
 
BigDecimal scaleZero = BigDecimal.valueOf(0.0).setScale(1);
System.out.println(BigDecimal.ZERO.compareTo(scaleZero));

 

輸出結果

0
0
0
0

 

由此聯想到的一個更大的坑是，如果將BigDecimal的值作為HashMap的key，因為精度的問題，相同的值就可能出現hashCode值不同並且equals方法返回false，導致put和get就很可能會出現相同的值但是存取了不同的value。

再想一想，小數類型在計算機中本來就不能精確存儲，再把其作為HashMap的key就相當不靠譜了，以后還是少用。

 

另外需要注意的一點是，寫代碼調別人寫的方法時，最好是點進去看一下實現。再小再常用的方法，都可能埋着大坑