不掌握 BigDecimal 的四大坑你敢用嗎?
BigDecimal 是 Java 中的一個類,這個相信大家都是知道的。它的作用就是可以表示任意精度的十進(jìn)制數(shù),BigDecimal 提供了精確的數(shù)字運算,適用于需要高精度計算的場景,例如金融、貨幣或者稅收等涉及到金錢的地方。
與 double 和 float 不同的是,BigDecimal 對象在計算的過程中不會丟失精度,那么下面我們就來看下第一個坑,浮點精度的坑。
一、浮點精度的坑
我們先來看一個例子:
public static void main(String[] args) {
BigDecimal num1 = new BigDecimal("0.1");
BigDecimal num2 = new BigDecimal("0.10");
// false
System.out.println(num1.equals(num2));
// 0
System.out.println(num1.compareTo(num2));
}
compareTo 方法比較中,a.compareTo(b)
返回:
- -1: a小于b
- 0: a等于b
- 1: a大于b。
在上方的代碼中,我們使用 new BigDecimal 的形式 new 了兩個 BigDecimal 對象,分別是 0.1 和0.10。
我們分別使用了 equals 與 compareTo 進(jìn)行比較,當(dāng)使用 equals 進(jìn)行比較時,返回了 false,這是因為 equals 不僅比較了值是否相等,還比較了精度是否相等,源碼中是這樣寫的:
public boolean equals(Object x) {
if (!(x instanceof BigDecimal))
return false;
BigDecimal xDec = (BigDecimal) x;
if (x == this)
return true;
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());
}
所以在使用 equals 進(jìn)行比較兩個 BigDecimal 的大小時,一定要注意這一點了。
簡單概括一下,如果比較兩個 BigDecimal 對象的大小,那就使用 compareTo 方法;如果嚴(yán)格比較精度的大小,那就使用 equals 方法進(jìn)行比較。
上面我們知道了如何比較兩個 BigDecimal 對象的大小,equals 比較的還有他們的精度,那么精度又是如何設(shè)置的呢,這塊有沒有坑呢?
二、設(shè)置精度的坑
有的同學(xué)可能會說了,設(shè)置精度還有啥坑啊,設(shè)置了精度就好了嗎,哎對,就是這個意思,在做 BigDecimal 對象計算的時候,一定要設(shè)置精度。相反,有的同學(xué)就不喜歡設(shè)置精度,那么這 BUG 不就來了嗎。
來看一個例子:
public static void main(String[] args) {
BigDecimal num1 = new BigDecimal("1");
BigDecimal num2 = new BigDecimal("3");
BigDecimal result = num1.divide(num2); // 默認(rèn)舍入模式為 UNNECESSARY,會拋出 ArithmeticException
}
上述的代碼在執(zhí)行結(jié)束之后會報錯 ArithmeticException ,這是因為默認(rèn)舍入模式為 UNNECESSARY,所以會拋出 ArithmeticException。
Exception in thread "main" java.lang.ArithmeticException: Non-terminating decimal expansion; no exact representable decimal result.
要解決這個異常也很容易,只需要加上精度即可。
public static void main(String[] args) {
BigDecimal num1 = new BigDecimal("1");
BigDecimal num2 = new BigDecimal("3");
BigDecimal result = num1.divide(num2, 2,RoundingMode.HALF_UP);
// 輸出:0.33
System.out.println(result);
}
那么出現(xiàn)這個異常的原因是什么你考慮過嗎?為什么加了精度就不報錯了呢?
這個異常在源碼中也有說明:
大概意思就是如果在做 divide 運算時,如果商是一個無限小數(shù),而操作的結(jié)果是一個精確的數(shù)字,那么就會拋出該異常。
不知道大家注意到一點沒有,就是上面做除法運算的時候,也就是 BigDecimal result = num1.divide(num2, 2,RoundingMode.HALF_UP); 這行代碼的位置,使用了一個新的變量 result 來接收結(jié)果值,因為 BigDecimal 是不可變的,因此每次進(jìn)行運算都會創(chuàng)建一個新的 BigDecimal 對象,所以這一點也是需要注意的,創(chuàng)建的多了可能會產(chǎn)生大量的垃圾對象。
講完了精度與運算,那么你初始化的方式對嗎?
三、初始化的坑
先來看代碼:
BigDecimal num = new BigDecimal(0.1); // 使用雙精度浮點數(shù)構(gòu)造
System.out.println(num); // 輸出: 0.1000000000000000055511151231257827021181583404541015625
BigDecimal num2 = new BigDecimal("0.1"); // 使用字符串構(gòu)造
System.out.println(num2); // 輸出: 0.1
在使用 new BigDecimal 構(gòu)造器進(jìn)行初始化的時候,如果有初始值,最好使用字符串的構(gòu)造方法進(jìn)行初始化。
在使用 double 的構(gòu)造器進(jìn)行新建時,本身傳入的 0.1 就是浮點類型了,為了不丟失精度,在使用 new BigDecimal 新建時就把這個近似值完整的保留下來了。
或者就是 另外一種初始化方式 BigDecimal.valueOf(0.1);,通過看源碼可以發(fā)現(xiàn),在 valueOf 的內(nèi)部,將 Double 類型直接轉(zhuǎn)為了字符串了,因此也就不會存在精度丟失的問題了。
對于使用 new BigDecimal(0.1) 構(gòu)造時,源碼中也已經(jīng)說明了這個問題。
大體意思就是生成的 BigDecimal 對象不是我們想要的 0.1,推薦使用 String 類型的構(gòu)造方法。
上面我們已經(jīng)學(xué)會了如何初始化,如何運算,下一步就是如何用了,例如轉(zhuǎn)字符串,很多同學(xué)可能會說,轉(zhuǎn)字符串 toString() 不就好了,如果你也這樣想,那你單純了弟弟。
四、轉(zhuǎn)字符串的坑
還是先看一段代碼:
public static void main(String[] args) {
BigDecimal a = BigDecimal.valueOf(89382389312389594.33822312317952678768725);
System.out.println(a.toString()); // 輸出:8.93823893123896E+16
String str = a.setScale(2, RoundingMode.HALF_UP).toString();
System.out.println(str); // 輸出: 89382389312389600.00
}
上面代碼中是一個非常大的數(shù),我想把他轉(zhuǎn)為字符串,可是在使用 toString() 方法時,打印出來的卻是科學(xué)計數(shù)法。
所以如果想使用 toString() 方法進(jìn)行轉(zhuǎn)字符串時,可以使用設(shè)置精度的方法,但是結(jié)果還是與我們的預(yù)期有所差別,我們想要的是一模一樣的打印出來呢?
那么 toPlainString 就上場了,這個方法返回一個字符串的表示形式,包含所有的有效數(shù)字。
代碼修改如下:
public static void main(String[] args) {
BigDecimal a = BigDecimal.valueOf(89382389312389594.99933822312317952678768725);
System.out.println(a.toPlainString());
}
修改之后就可以了嗎,不可以,忘了上面說的嗎,使用 String 的構(gòu)造函數(shù)吧兄弟,double 類型的構(gòu)造函數(shù)會丟失精度的。
最終代碼如下:
public static void main(String[] args) {
BigDecimal a = new BigDecimal("89382389312389594.99933822312317952678768725");
System.out.println(a.toPlainString());
}
除了上述兩種轉(zhuǎn)字符串的方法外,還有一種,就是 toEngineeringString,這個方法也是返回一個字符串,包含有效數(shù)字,但是它會使用工程計數(shù)法,科學(xué)計數(shù)法的一種變體,它使用數(shù)字的倍數(shù)來表示值,使得指數(shù)是 3 的倍數(shù)。例如,1000會顯示為"1E3",而不是"1E+3"。
所以總結(jié)就是:
- toString:返回有效數(shù)字,必要的時候使用科學(xué)計數(shù)法。
- toPlainString: 不實用任何科學(xué)計數(shù)法。
- toEngineeringString:必要的時候使用工程計數(shù)法。
五、總結(jié)
本文從精度的比較、除法運算中是否設(shè)置精度、對象初始化到轉(zhuǎn)字符串,四個角度來把 BigDecimal 的坑盡可能清晰的描述出來,以及基于這些坑得到的優(yōu)秀實踐。
有些場景下推薦使用 BigDecimal ,但是能不用還是不用,比 double 、float 多出來的性能損失得是你能接受的。如果非得用,那上面這幾個坑一定要規(guī)避。