Java BigDecimal使用指南
2020-08-28 09:52 申城异乡人 阅读(1700) 评论(5) 编辑 收藏 举报提起BigDecimal，相信大家都使用过，之所以总结这篇呢，是因为最近发现项目中使用的不是太规范，在某些场景下甚至出现代码抛出异常的情况，
所以就总结了这篇，希望大家在使用时，可以少踩一些坑。
1. 基本运算
1.1 加法
BigDecimal number1 = new BigDecimal("88.88");
BigDecimal number2 = new BigDecimal("11.12");
BigDecimal number3 = number1.add(number2);
System.out.println("number1 add number2 = " + number3);
输出结果：
number1 add number2 = 100.00
1.2 减法
BigDecimal number1 = new BigDecimal("88.88");
BigDecimal number2 = new BigDecimal("11.12");
BigDecimal number3 = number1.subtract(number2);
System.out.println("number1 subtract number2 = " + number3);
输出结果：
number1 subtract number2 = 77.76
1.3 乘法
BigDecimal number1 = new BigDecimal("88.88");
BigDecimal number2 = new BigDecimal("11.12");
BigDecimal number3 = number1.multiply(number2);
System.out.println("number1 multiply number2 = " + number3);
输出结果：
number1 multiply number2 = 988.3456
1.4 除法
BigDecimal number1 = new BigDecimal("88");
BigDecimal number2 = new BigDecimal("11");
BigDecimal number3 = number1.divide(number2);
System.out.println("number1 divide number2 = " + number3);
输出结果：
number1 divide number2 = 8
因为上面2个数可以整除，所以这么用没有问题，不过一但不能被整除，这么用就会有潜在的风险，会抛出java.lang.ArithmeticException异常，所以强烈建议像下面这样使用：
BigDecimal number1 = new BigDecimal("88.88");
BigDecimal number2 = new BigDecimal("11.12");
BigDecimal number3 = number1.divide(number2, 2, RoundingMode.HALF_UP);
System.out.println("number1 divide number2 = " + number3);
输出结果：
number1 divide number2 = 7.99
此时使用的divide()方法源码如下所示：
public BigDecimal divide(BigDecimal divisor, int scale, RoundingMode roundingMode) {
return divide(divisor, scale, roundingMode.oldMode);
}
这里的scale指的是要保留的小数位数，我们传的是2，即保留2位小数。
这里的roundingMode指的是舍入模式，我们这里传的是RoundingMode.HALF_UP，即经常使用的四舍五入模式。
1.5 保留小数位数
如果我们想对BigDecimal类型保留小数位数，可以使用setScale()方法，使用方法如下所示：
BigDecimal number1 = new BigDecimal("88.88");
BigDecimal number2 = new BigDecimal("11.12");
BigDecimal number3 = number1.multiply(number2);
System.out.println("number1 multiply number2 = " + number3);
// 保留3位小数,四舍五入
BigDecimal number4 = number3.setScale(3, RoundingMode.HALF_UP);
System.out.println("number3 setScale = " + number4);
输出结果：
number1 multiply number2 = 988.3456
number3 setScale = 988.346
1.6 比较大小
BigDecimal比较大小，可以使用compareTo()方法，使用方法如下所示：
BigDecimal number1 = new BigDecimal("88.88");
BigDecimal number2 = new BigDecimal("11.11");
BigDecimal number3 = new BigDecimal("99.99");
BigDecimal number4 = new BigDecimal("88.88");
System.out.println("number1 compareTo number2 = " + number1.compareTo(number2));
System.out.println("number1 compareTo number3 = " + number1.compareTo(number3));
System.out.println("number1 compareTo number4 = " + number1.compareTo(number4));
输出结果：
number1 compareTo number2 = 1
number1 compareTo number3 = -1
number1 compareTo number4 = 0
由输出结果可以看出：
当number1小于number2时，返回-1，
当number1等于number2时，返回0，
当number1大于number2时，返回1。
2. 踩坑总结
2.1 NullPointerException异常
在使用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);
抛出的异常如下图所示：
2.2 ArithmeticException异常
一次在使用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);
运行时抛出以下异常：
java.lang.ArithmeticException: Non-terminating decimal expansion; no exact representable decimal result.
报错原因是因为无法整除，导致结果是无限循环小数：
解决方案是指定下舍入模式，比如我们最常用的四舍五入模式：
// 不含税金额 = 含税金额 / (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
如果你的IDEA装了阿里巴巴代码规范插件，如果不指定RoundingMode，会有下面这样的提示：
2.3 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() 某些场景下使用科学计数法
上面的踩坑就是因为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
3. 使用规范
尽量不要在项目中使用new BigDecimal("0")，而是使用BigDecimal提供的常量BigDecimal.ZERO。
BigDecimal zero = BigDecimal.ZERO;
BigDecimal one = BigDecimal.ONE;
BigDecimal ten = BigDecimal.TEN;
