背景

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

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

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

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

关于 BigDecimal 等值判断的这个知识点，在最新版的《阿里巴巴 Java 开发手册》中也有说明：

那么，为什么会有这样的要求呢？背后的思考是什么呢？

其实，我在之前的 CodeReview 中，看到过以下这样的低级错误：

1
2
3

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

这种错误，相信聪明的读者一眼就可以看出问题，因为 BigDecimal 是对象，所以不能用 == 来判断两个数字的值是否相等。

以上这种问题，在有一定的经验之后，还是可以避免的，但是聪明的读者，看一下以下这行代码，你觉得他有问题吗：

1
2
3

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

以上代码，输出结果为：

1
2
3

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 一共有以下 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 (String) ，当我们使用 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

其源码如下：

总结

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

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

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