為什麼阿里巴巴禁止使用BigDecimal的equals方法做等值比較？

BigDecimal，相信對於很多人來說都不陌生，很多人都知道他的用法，這是一種java.math包中提供的一種可以用來進行精確運算的型別。

很多人都知道，在進行金額表示、金額計算等場景，不能使用double、float等型別，而是要使用對精度支援的更好的BigDecimal。

所以，很多支付、電商、金融等業務中，BigDecimal的使用非常頻繁。而且不得不說這是一個非常好用的類，其內部自帶了很多方法，如加，減，乘，除等運算方法都是可以直接呼叫的。

除了需要用BigDecimal表示數位和進行數位運算以外，程式碼中還經常需要對於數位進行相等判斷。

關於這個知識點，在最新版的《阿里巴巴Java開發手冊》中也有說明：

這背後的思考是什麼呢？

我在之前的CodeReview中，看到過以下這樣的低階錯誤：

if(bigDecimal == bigDecimal1){
    // 兩個數相等
}

這種錯誤，相信聰明的讀者一眼就可以看出問題，因為BigDecimal是物件，所以不能用==來判斷兩個數位的值是否相等。

以上這種問題，在有一定的經驗之後，還是可以避免的，但是聰明的讀者，看一下以下這行程式碼，你覺得他有問題嗎：

if(bigDecimal.equals(bigDecimal1)){
    // 兩個數相等
}

可以明確的告訴大家，以上這種寫法，可能得到的結果和你預想的不一樣！

先來做個實驗，執行以下程式碼：

BigDecimal bigDecimal = new BigDecimal(1);
BigDecimal bigDecimal1 = new BigDecimal(1);
System.out.println(bigDecimal.equals(bigDecimal1));


BigDecimal bigDecimal2 = new BigDecimal(1);
BigDecimal bigDecimal3 = new BigDecimal(1.0);
System.out.println(bigDecimal2.equals(bigDecimal3));


BigDecimal bigDecimal4 = new BigDecimal("1");
BigDecimal bigDecimal5 = new BigDecimal("1.0");
System.out.println(bigDecimal4.equals(bigDecimal5));

以上程式碼，輸出結果為：

true
true
false

BigDecimal的equals原理

通過以上程式碼範例，我們發現，在使用BigDecimal的equals方法對1和1.0進行比較的時候，有的時候是true（當使用int、double定義BigDecimal時），有的時候是false（當使用String定義BigDecimal時）。

那麼，為什麼會出現這樣的情況呢，我們先來看下BigDecimal的equals方法。

在BigDecimal的JavaDoc中其實已經解釋了其中原因：

Compares this  BigDecimal with the specified Object for equality.  Unlike compareTo, this method considers two BigDecimal objects equal only if they are equal in value and scale (thus 2.0 is not equal to 2.00 when compared by  this method)

大概意思就是，equals方法和compareTo並不一樣，equals方法會比較兩部分內容，分別是值（value）和精度（scale）

對應的程式碼如下：

所以，我們以上程式碼定義出來的兩個BigDecimal物件（bigDecimal4和bigDecimal5）的精度是不一樣的，所以使用equals比較的結果就是false了。

嘗試著對程式碼進行debug，在debug的過程中我們也可以看到bigDecimal4的精度時0，而bigDecimal5的精度是1。

到這裡，我們大概解釋清楚了，之所以equals比較bigDecimal4和bigDecimal5的結果是false，是因為精度不同。

那麼，為什麼精度不同呢？為什麼bigDecimal2和bigDecimal3的精度是一樣的（當使用int、double定義BigDecimal時），而bigDecimal4和bigDecimal5卻不一樣（當使用String定義BigDecimal時）呢？

為什麼精度不同

這個就涉及到BigDecimal的精度問題了，這個問題其實是比較複雜的，由於不是本文的重點，這裡面就簡單介紹一下吧。大家感興趣的話，後面單獨講。

首先，BigDecimal一共有以下4個構造方法：

BigDecimal(int)
BigDecimal(double) 
BigDecimal(long) 
BigDecimal(String)

以上四個方法，建立出來的的BigDecimal的精度是不同的。

BigDecimal(long) 和BigDecimal(int)

首先，最簡單的就是BigDecimal(long) 和BigDecimal(int)，因為是整數，所以精度就是0 ：

public BigDecimal(int val) {
    this.intCompact = val;
    this.scale = 0;
    this.intVal = null;
}

public BigDecimal(long val) {
    this.intCompact = val;
    this.intVal = (val == INFLATED) ? INFLATED_BIGINT : null;
    this.scale = 0;
}

BigDecimal(double)

而對於BigDecimal(double) ，當我們使用new BigDecimal(0.1)建立一個BigDecimal 的時候，其實建立出來的值並不是整好等於0.1的，而是0.1000000000000000055511151231257827021181583404541015625 。這是因為doule自身表示的只是一個近似值。

那麼，無論我們使用new BigDecimal(0.1)還是new BigDecimal(0.10)定義，他的近似值都是0.1000000000000000055511151231257827021181583404541015625這個，那麼他的精度就是這個數位的位數，即55。

其他的浮點數也同樣的道理。對於new BigDecimal(1.0)這樣的形式來說，因為他本質上也是個整數，所以他建立出來的數位的精度就是0。

所以，因為BigDecimal(1.0)和BigDecimal(1.00)的精度是一樣的，所以在使用equals方法比較的時候，得到的結果就是true。

BigDecimal(string)

而對於BigDecimal(double) ，當我們使用new BigDecimal(「0.1」)建立一個BigDecimal 的時候，其實建立出來的值正好就是等於0.1的。那麼他的精度也就是1。

如果使用new BigDecimal(「0.10000」)，那麼建立出來的數就是0.10000，精度也就是5。

所以，因為BigDecimal(「1.0」)和BigDecimal(「1.00」)的精度不一樣，所以在使用equals方法比較的時候，得到的結果就是false。

如何比較BigDecimal

前面，我們解釋了BigDecimal的equals方法，其實不只是會比較數位的值，還會對其精度進行比較。

所以，當我們使用equals方法判斷判斷兩個數是否相等的時候，是極其嚴格的。

那麼，如果我們只想判斷兩個BigDecimal的值是否相等，那麼該如何判斷呢？

BigDecimal中提供了compareTo方法，這個方法就可以只比較兩個數位的值，如果兩個數相等，則返回0。

    BigDecimal bigDecimal4 = new BigDecimal("1");
    BigDecimal bigDecimal5 = new BigDecimal("1.0000");
    System.out.println(bigDecimal4.compareTo(bigDecimal5));

以上程式碼，輸出結果：

其原始碼如下：

總結

BigDecimal是一個非常好用的表示高精度數位的類，其中提供了很多豐富的方法。

但是，他的equals方法使用的時候需要謹慎，因為他在比較的時候，不僅比較兩個數位的值，還會比較他們的精度，只要這兩個因素有一個是不相等的，那麼結果也是false、

如果讀者想要對兩個BigDecimal的數值進行比較的話，可以使用compareTo方法。