BigDecimal踩坑总结

使用String类型对BigDecimal进行初始化

Java在java.math包中提供的API类BigDecimal，用来对超过16位有效位的数进行精确的运算。在bigDecimal初始化时，不要使用double或者float类型的值传入构造器，对比可知，test2仍然会出现精度问题，而在创建BigDecimal对象时，参数为字符串就不会出现精度问题所以总结如下

//使用String构造
BigDecimal b1 = new BigDecimal("0.1");
//或者是：
BigDecimal b1 = BigDecimal.valueOf(0.1);
//点开valueOf的源码，可以看到在源码中也是用new BigDecimal(String);返回一个BigDecimal对象的
//源码如下：
public static BigDecimal valueOf(double val) {
    // Reminder: a zero double returns '0.0', so we cannot fastpath
    // to use the constant ZERO.  This might be important enough to
    // justify a factory approach, a cache, or a few private
    // constants, later.
    return new BigDecimal(Double.toString(val));
}
复制代码

在进行BigDecimal数值比较时不要使用equals进行比较

使用equals进行比较会比较值的大小和精度的大小，即0.00和0.000是不相等的，要使用compareTo()来进行比较。

进行计算时需要保证参与计算的值不能为null

在使用BigDecimal类型进行计算时，进行加、减、乘、除、比较大小时，一定要保证参与计算的两个值不能为空，否则会抛出java.lang.NullPointerException异常。

比如下面的2段代码，都会抛出异常：

BigDecimal number1 = null;
BigDecimal number2 = new BigDecimal("11.12");

BigDecimal number3 = number1.add(number2);
System.out.println("number1 add number2 = " + number3);

BigDecimal number1 = new BigDecimal("88.88");
BigDecimal number2 = null;

BigDecimal number3 = number1.add(number2);
System.out.println("number1 add number2 = " + number3);
复制代码

抛出的异常如下图所示：

使用`divide`方法方法时小心无限循环小数以及除数不能为0

一次在使用BigDecimal的divide方法时，抛出java.lang.ArithmeticException异常，错误代码如下所示：

// 含税金额
BigDecimal inclusiveTaxAmount = new BigDecimal("1000");
// 税率
BigDecimal taxRate = new BigDecimal("0.13");
// 不含税金额 = 含税金额 / (1+税率)
BigDecimal exclusiveTaxAmount = inclusiveTaxAmount.divide(BigDecimal.ONE.add(taxRate));

System.out.println(exclusiveTaxAmount);
复制代码

运行时抛出以下异常：

报错原因是因为无法整除，导致结果是无限循环小数：

解决方案是指定下舍入模式，比如我们最常用的四舍五入模式：

// 不含税金额 = 含税金额 / (1+税率)
BigDecimal exclusiveTaxAmount = inclusiveTaxAmount.divide(BigDecimal.ONE.add(taxRate),RoundingMode.HALF_UP);
复制代码

此时不再报错，输出结果为：885

但这里我的需求是保留2位小数，四舍五入，因此代码应该是下面这样的：

// 不含税金额 = 含税金额 / (1+税率)
BigDecimal exclusiveTaxAmount = inclusiveTaxAmount.divide(BigDecimal.ONE.add(taxRate), 2, RoundingMode.HALF_UP);
复制代码

此时的输出结果为： 884.96

BigDecimal转String，科学计数法问题

结论：将BigDecimal转换为String，推荐使用toPlainString()，而不是toString()

可能你的写法是下面这样的：

BigDecimal amount = new BigDecimal("3450.67");
System.out.println(amount.toString());
复制代码

输出结果：3450.67

大部分情况下，这么使用并没有问题，不过在某些场景下，这么使用就容易踩坑，比如下面的3个示例：

System.out.println( new BigDecimal("0.000000000000").toString());
//输出结果：0E-12

BigDecimal bigDecimal = new BigDecimal("1E+11");
System.out.println(bigDecimal.toString());
//输出结果：1E+11
复制代码

还有个更为常用的场景：抹零，也容易踩坑，比如下面所示的代码，预期的输出结果是3550，但实际上并不是：

BigDecimal bigDecimal = new BigDecimal("3550.00");
System.out.println(bigDecimal.stripTrailingZeros().toString());
//输出结果：3.55E+3

//使用toPlainString()方法可以避免这个问题，如下所示：
System.out.println( new BigDecimal("0.000000000000").toPlainString());
System.out.println( new BigDecimal("1E+11").toPlainString());
System.out.println(new BigDecimal("3550.00").stripTrailingZeros().toPlainString());

//输出结果：
//0.000000000000
//100000000000
//3550
复制代码

其实，BigDecimal提供了3个转换为String的方法，分别为：

toString() 某些场景下使用科学计数法
toPlainString() 不使用任何计数法
toEngineeringString() 某些场景下使用工程计数法

这里简单提下科学计数法和工程计数法的区别：

科学记数法，是将数字表示成10的幂的倍数的形式。

工程记数法，是在科学记数法基础上，将10的幂限制为3的倍数。

举例：

原始值	科学技术法	工程计数法
2700	2.7 x 10³	2.7 x 10³
27000	2.7 x 10⁴	27 x 10³
270000	2.7 x 10⁵	270 x 10³
2700000	2.7 x 10⁶	2.7 x 10⁶

示例代码：

BigDecimal bigDecimal = new BigDecimal("270000.00").stripTrailingZeros();
System.out.println(bigDecimal.toString());
System.out.println(bigDecimal.toPlainString());
System.out.println(bigDecimal.toEngineeringString());

//输出结果：
//2.7E+5
//270000
//270E+3
复制代码

使用规范

尽量不要在项目中使用new BigDecimal("0")，而是使用BigDecimal提供的常量BigDecimal.ZERO。

BigDecimal zero = BigDecimal.ZERO;
BigDecimal one = BigDecimal.ONE;
BigDecimal ten = BigDecimal.TEN;
复制代码