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

文章來源于公眾號(hào)：Hollis 作者：Hollis

BigDecimal 很多人應(yīng)該聽說過它，也知道它的用法，它是java.math包中提供的一種可以用來進(jìn)行精確運(yùn)算的類型。

很多人都知道，在進(jìn)行金額表示、金額計(jì)算等場(chǎng)景，不能使用double、float等類型，而是要使用對(duì)精度支持的更好的BigDecimal。

所以，很多支付、電商、金融等業(yè)務(wù)中，BigDecimal的使用非常頻繁。而且不得不說這是一個(gè)非常好用的類，其內(nèi)部自帶了很多方法，如加，減，乘，除等運(yùn)算方法都是可以直接調(diào)用的。

除了需要用BigDecimal表示數(shù)字和進(jìn)行數(shù)字運(yùn)算以外，代碼中還經(jīng)常需要對(duì)于數(shù)字進(jìn)行相等判斷。

關(guān)于BigDecimal等值判斷的這個(gè)知識(shí)點(diǎn)，在最新版的《阿里巴巴Java開發(fā)手冊(cè)》中也有說明：

那么，為什么會(huì)有這樣的要求呢？背后的思考是什么呢？

其實(shí)，我在之前的CodeReview中，看到過以下這樣的低級(jí)錯(cuò)誤：

if(bigDecimal == bigDecimal1){


    // 兩個(gè)數(shù)相等


}

這種錯(cuò)誤，相信聰明的讀者一眼就可以看出問題，因?yàn)锽igDecimal是對(duì)象，所以不能用==來判斷兩個(gè)數(shù)字的值是否相等。

以上這種問題，在有一定的經(jīng)驗(yàn)之后，還是可以避免的，但是聰明的讀者，看一下以下這行代碼，你覺得他有問題嗎：

if(bigDecimal.equals(bigDecimal1)){


    // 兩個(gè)數(shù)相等


}

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

先來做個(gè)實(shí)驗(yàn)，運(yùn)行以下代碼：

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));

以上代碼，輸出結(jié)果為：

true


true


false

BigDecimal的equals原理

通過以上代碼示例，我們發(fā)現(xiàn)，在使用BigDecimal的equals方法對(duì)1和1.0進(jìn)行比較的時(shí)候，有的時(shí)候是 true（當(dāng)使用 int、double 定義 BigDecimal 時(shí)），有的時(shí)候是 false（當(dāng)使用 String 定義 BigDecimal時(shí)）。

那么，為什么會(huì)出現(xiàn)這樣的情況呢，我們先來看下BigDecimal的equals方法。

在BigDecimal的JavaDoc中其實(shí)已經(jīng)解釋了其中原因：

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方法會(huì)比較兩部分內(nèi)容，分別是值（value）和精度（scale）

對(duì)應(yīng)的代碼如下：

所以，我們以上代碼定義出來的兩個(gè)BigDecimal對(duì)象（bigDecimal4和bigDecimal5）的精度是不一樣的，所以使用equals比較的結(jié)果就是false了。

嘗試著對(duì)代碼進(jìn)行debug，在debug的過程中我們也可以看到bigDecimal4的精度是0，而bigDecimal5的精度是1。

到這里，我們大概解釋清楚了，之所以equals比較bigDecimal4和bigDecimal5的結(jié)果是 false ，是因?yàn)榫炔煌?/p>

那么，為什么精度不同呢？為什么bigDecimal2和bigDecimal3的精度是一樣的（當(dāng)使用int、double定義BigDecimal時(shí)），而bigDecimal4和bigDecimal5卻不一樣（當(dāng)使用String定義BigDecimal時(shí)）呢？

為什么精度不同

這個(gè)就涉及到BigDecimal的精度問題了，這個(gè)問題其實(shí)是比較復(fù)雜的，由于不是本文的重點(diǎn)，這里面就簡(jiǎn)單介紹一下吧。大家感興趣的話，后面單獨(dú)講。

首先，BigDecimal一共有以下4個(gè)構(gòu)造方法：

1. BigDecimal(int)
2. BigDecimal(double)
3. BigDecimal(long)
4. BigDecimal(String)

以上四個(gè)方法，創(chuàng)建出來的的BigDecimal的精度是不同的。

BigDecimal(long) 和BigDecimal(int)

首先，最簡(jiǎn)單的就是BigDecimal(long) 和BigDecimal(int)，因?yàn)槭钦麛?shù)，所以精度就是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)

而對(duì)于BigDecimal(double) ，當(dāng)我們使用new BigDecimal(0.1)創(chuàng)建一個(gè)BigDecimal 的時(shí)候，其實(shí)創(chuàng)建出來的值并不是正好等于0.1的，而是0.1000000000000000055511151231257827021181583404541015625 。這是因?yàn)閐oule自身表示的只是一個(gè)近似值。

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

其他的浮點(diǎn)數(shù)也同樣的道理。對(duì)于new BigDecimal(1.0)這樣的形式來說，因?yàn)樗举|(zhì)上也是個(gè)整數(shù)，所以他創(chuàng)建出來的數(shù)字的精度就是0。

所以，因?yàn)?code>BigDecimal(1.0)和BigDecimal(1.00)的精度是一樣的，所以在使用equals方法比較的時(shí)候，得到的結(jié)果就是 true。

BigDecimal(string)

而對(duì)于BigDecimal(double) ，當(dāng)我們使用new BigDecimal("0.1")創(chuàng)建一個(gè)BigDecimal 的時(shí)候，其實(shí)創(chuàng)建出來的值正好就是等于0.1的。那么他的精度也就是1。

如果使用new BigDecimal("0.10000")，那么創(chuàng)建出來的數(shù)就是0.10000，精度也就是5。

所以，因?yàn)锽igDecimal("1.0")和BigDecimal("1.00")的精度不一樣，所以在使用equals方法比較的時(shí)候，得到的結(jié)果就是false。

如何比較BigDecimal

前面，我們解釋了BigDecimal的equals方法，其實(shí)不只是會(huì)比較數(shù)字的值，還會(huì)對(duì)其精度進(jìn)行比較。

所以，當(dāng)我們使用equals方法判斷判斷兩個(gè)數(shù)是否相等的時(shí)候，是極其嚴(yán)格的。

那么，如果我們只想判斷兩個(gè)BigDecimal的值是否相等，那么該如何判斷呢？

BigDecimal中提供了compareTo方法，這個(gè)方法就可以只比較兩個(gè)數(shù)字的值，如果兩個(gè)數(shù)相等，則返回0。

    BigDecimal bigDecimal4 = new BigDecimal("1");


    BigDecimal bigDecimal5 = new BigDecimal("1.0000");


    System.out.println(bigDecimal4.compareTo(bigDecimal5));

以上代碼，輸出結(jié)果：

0

其源碼如下：

總結(jié)

BigDecimal是一個(gè)非常好用的表示高精度數(shù)字的類，其中提供了很多豐富的方法。

但是，他的equals方法使用的時(shí)候需要謹(jǐn)慎，因?yàn)樗诒容^的時(shí)候，不僅比較兩個(gè)數(shù)字的值，還會(huì)比較他們的精度，只要這兩個(gè)因素有一個(gè)是不相等的，那么結(jié)果也是 false。

如果讀者想要對(duì)兩個(gè)BigDecimal的數(shù)值進(jìn)行比較的話，可以使用compareTo方法。

以上就是W3Cschool編程獅關(guān)于阿里巴巴為何禁止使用BigDecimal的equals方法做等值比較？的相關(guān)介紹了，希望對(duì)大家有所幫助。