为什么阿里巴巴禁止使用BigDecimal的equals方法做等值比较

BigDecimal介绍

BigDecimal，相信对于很多人来说都不陌生，很多人都知道他的用法，这是一种java.math包中提供的一种可以用来进行精确运算的类型。

很多人都知道，在进行金额表示、金额计算等场景，不能使用double、float等类型，而是要使用对精度支持的更好的BigDecimal。

所以，很多支付、电商、金融等业务中，BigDecimal的使用非常频繁。而且不得不说这是一个非常好用的类，其内部自带了很多方法，如加，减，乘，除等运算方法都是可以直接调用的。

除了需要用BigDecimal表示数字和进行数字运算以外，代码中还经常需要对于数字进行相等判断。

《阿里巴巴Java开发手册》的说明

详细说明

如下代码就是这样的低级错误：

错误一 ==

if(bigDecimal == bigDecimal1){
    // 两个数相等
}

因为BigDecimal是对象，所以不能用==来判断两个数字的值是否相等。

错误二 equals()

但是下面的代码呢？

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的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一共有以下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));

以上代码，输出结果：

0

compareTo源码：

最佳实践–小数相关操作

当需要使用小数构造一个BigDecimal时，建议使用

String worth = "1.22"
BigDecimal data = new BigDecimal(worth);

一定要谨慎使用Double/double作为参数构建BigDecimal，如下

Double worth = 1.22；
BigDecimal data = new BigDecimal(worth);

两种方式造成结果如下：

public static void main(String[] args) {
        BigDecimal data = new BigDecimal("2");
        Double d = 2.3232;
        // 转成String
        BigDecimal valueWithString = data.multiply(new BigDecimal(d.toString()));
        System.out.println("valueWithString=" + valueWithString.toString());
 
        // 不转String,会使用精度
        BigDecimal valueWithBigDecimal = data.multiply(new BigDecimal(d));
        System.out.println("valueWithBigDecimal=" + valueWithBigDecimal.toString());
}

执行结果为，显然第二种结果不是我们想要的结果。

valueWithString=4.6464
valueWithBigDecimal=4.6463999999999998635757947340607643127441406250

总结

BigDecimal是一个非常好用的表示高精度数字的类，其中提供了很多丰富的方法。

但是，他的equals方法使用的时候需要谨慎，因为他在比较的时候，不仅比较两个数字的值，还会比较他们的精度，只要这两个因素有一个是不相等的，那么结果也是false

如果想要对两个BigDecimal的数值进行比较的话，可以使用compareTo方法。

参考资料

https://juejin.im/post/6874754180058185736

http://www.heartthinkdo.com/?p=829