BigDecimal的常用方法

旧城等待， 2024-03-22 16:44 8阅读 0赞

### 一、BigDecimal概述 ###

Java在java.math包中提供的API类BigDecimal，用来对超过16位有效位的数进行精确的运算。双精度浮点型变量double可以处理16位有效数，但在实际应用中，可能需要对更大或者更小的数进行运算和处理。

一般情况下，对于那些不需要准确计算精度的数字，我们可以直接使用Float和Double处理，但是Double.valueOf(String) 和Float.valueOf(String)会丢失精度。所以开发中，如果我们需要精确计算的结果，则必须使用BigDecimal类来操作。

BigDecimal所创建的是对象，故我们不能使用传统的+、-、\*、/等算术运算符直接对其对象进行数学运算，而必须调用其相对应的方法。方法中的参数也必须是BigDecimal的对象。构造器是类的特殊方法，专门用来创建对象，特别是带有参数的对象。

### 二、BigDecimal常用构造函数 ###

2.1、常用构造函数  
BigDecimal(int)  
创建一个具有参数所指定整数值的对象

BigDecimal(double)  
创建一个具有参数所指定双精度值的对象

BigDecimal(long)  
创建一个具有参数所指定长整数值的对象

BigDecimal(String)  
创建一个具有参数所指定以字符串表示的数值的对象

### 三、BigDecimal常用方法详解 ###

下面是常用的30个BigDecimal API：

1.  `add(BigDecimal val)`：加法操作
2.  `subtract(BigDecimal val)`：减法操作
3.  `multiply(BigDecimal val)`：乘法操作
4.  `divide(BigDecimal val)`：除法操作
5.  `setScale(int newScale, int roundingMode)`：设置小数位数和取整方式
6.  `compareTo(BigDecimal val)`：比较大小
7.  `equals(Object obj)`：判断两个BigDecimal对象是否相等
8.  `intValue()`：返回此BigDecimal的整数值
9.  `longValue()`：返回此BigDecimal的长整数值
10. `floatValue()`：将此BigDecimal转换为float类型
11. `doubleValue()`：将此BigDecimal转换为double类型
12. `toString()`：将此BigDecimal转换为字符串
13. `valueOf(double val)`：将double类型转换为BigDecimal对象
14. `abs()`：返回此BigDecimal的绝对值
15. `negate()`：返回此BigDecimal的相反数
16. `pow(int n)`：返回此BigDecimal的n次幂
17. `remainder(BigDecimal val)`：返回此BigDecimal除以val的余数
18. `round(MathContext mc)`：使用指定的MathContext将此BigDecimal四舍五入
19. `stripTrailingZeros()`：返回去除尾部零的BigDecimal
20. `toBigInteger()`：将此BigDecimal转换为BigInteger类型
21. `ulp()`：返回BigDecimal的最小精度值
22. `max(BigDecimal val)`：返回此BigDecimal与val中较大的值
23. `min(BigDecimal val)`：返回此BigDecimal与val中较小的值
24. `setScale(int newScale)`：设置小数位数，使用默认的取整方式
25. `intValueExact()`：返回此BigDecimal的整数值，如果不是整数则抛出异常
26. `longValueExact()`：返回此BigDecimal的长整数值，如果不是长整数则抛出异常
27. `movePointLeft(int n)`：将小数点左移n位
28. `movePointRight(int n)`：将小数点右移n位
29. `scale()`：返回此BigDecimal的小数位数
30. `signum()`：返回此BigDecimal的符号函数，1表示大于0，-1表示小于0，0表示等于0。

#### BigDecimal的取整方式 ####

BigDecimal可以通过 `setScale(int newScale, int roundingMode)` 方法设置小数位数和取整方式。第一个参数 `newScale` 表示设置后的小数位数，第二个参数 `roundingMode` 表示取整方式。

`roundingMode` 参数可以选择以下取整方式：

*  `BigDecimal.ROUND_CEILING` ：向正无穷方向取整，即大于或等于此数的最小整数。
 *  `BigDecimal.ROUND_DOWN` ：向零方向取整，即舍弃小数部分。
 *  `BigDecimal.ROUND_FLOOR` ：向负无穷方向取整，即小于或等于此数的最大整数。
 *  `BigDecimal.ROUND_HALF_DOWN` ：向最近的整数舍弃一半的小数部分，如果舍弃部分大于等于0.5，则向下取整，否则向上取整。
 *  `BigDecimal.ROUND_HALF_EVEN` ：向最近的整数舍弃一半的小数部分，如果舍弃部分等于0.5，并且舍弃部分前面的数字为偶数，则向下取整，否则向上取整。
 *  `BigDecimal.ROUND_HALF_UP` ：向最近的整数舍弃一半的小数部分，如果舍弃部分大于0.5，则向上取整，否则向下取整。
 *  `BigDecimal.ROUND_UNNECESSARY` ：如果存在小数部分，则抛出 `ArithmeticException` 异常。
 *  `BigDecimal.ROUND_UP` ：向远离零的方向取整，即大于或等于此数的最小整数。

例如，以下代码将一个 BigDecimal 对象舍入到小数点后两位，并以 `ROUND_HALF_UP` 的方式进行取整：

BigDecimal bd = new BigDecimal("3.1415926");
    BigDecimal result = bd.setScale(2, BigDecimal.ROUND_HALF_UP);

在以上代码中，`setScale(2, BigDecimal.ROUND_HALF_UP)` 将 `bd` 对象设置为保留两位小数并且使用 `ROUND_HALF_UP` 取整方式。结果会存储在 `result` 变量中，结果为 3.14。

### 四、BigDecimal格式化 ###

由于NumberFormat类的format()方法可以使用BigDecimal对象作为其参数，可以利用BigDecimal对超出16位有效数字的货币值，百分值，以及一般数值进行格式化控制。

以利用BigDecimal对货币和百分比格式化为例。首先，创建BigDecimal对象，进行BigDecimal的算术运算后，分别建立对货币和百分比格式化的引用，最后利用BigDecimal对象作为format()方法的参数，输出其格式化的货币值和百分比。

NumberFormat currency = NumberFormat.getCurrencyInstance(); //建立货币格式化引用  
NumberFormat percent = NumberFormat.getPercentInstance(); //建立百分比格式化引用  
percent.setMaximumFractionDigits(3); //百分比小数点最多3位

BigDecimal loanAmount = new BigDecimal("15000.48"); //贷款金额
    BigDecimal interestRate = new BigDecimal("0.008"); //利率
    BigDecimal interest = loanAmount.multiply(interestRate); //相乘
    
    System.out.println("贷款金额:\t" + currency.format(loanAmount));
    System.out.println("利率:\t" + percent.format(interestRate));
    System.out.println("利息:\t" + currency.format(interest));
    
    贷款金额: ￥15,000.48 利率: 0.8% 利息: ￥120.00

BigDecimal格式化保留2为小数，不足则补0：

public class NumberFormat {
        
    
        public static void main(String[] s){
        
            System.out.println(formatToNumber(new BigDecimal("3.435")));
            System.out.println(formatToNumber(new BigDecimal(0)));
            System.out.println(formatToNumber(new BigDecimal("0.00")));
            System.out.println(formatToNumber(new BigDecimal("0.001")));
            System.out.println(formatToNumber(new BigDecimal("0.006")));
            System.out.println(formatToNumber(new BigDecimal("0.206")));
        }
        /**
         * @desc 1.0~1之间的BigDecimal小数，格式化后失去前面的0,则前面直接加上0。
         * 2.传入的参数等于0，则直接返回字符串"0.00"
         * 3.大于1的小数，直接格式化返回字符串
         * @param obj传入的小数
         * @return
         */
        public static String formatToNumber(BigDecimal obj) {
        
            DecimalFormat df = new DecimalFormat("#.00");
            if(obj.compareTo(BigDecimal.ZERO)==0) {
        
                return "0.00";
            }else if(obj.compareTo(BigDecimal.ZERO)>0&&obj.compareTo(new BigDecimal(1))<0){
        
                return "0"+df.format(obj).toString();
            }else {
        
                return df.format(obj).toString();
            }
        }
    }

3.44  
0.00  
0.00  
0.00  
0.01  
0.21

### 五、BigDecimal常见异常 ###

#### 5.1、除法的时候出现异常 ####

java.lang.ArithmeticException: Non-terminating decimal expansion; no exact representable decimal result  
原因分析：

通过BigDecimal的divide方法进行除法时当不整除，出现无限循环小数时，就会抛异常：java.lang.ArithmeticException: Non-terminating decimal expansion; no exact representable decimal result.

#### 解决方法： ####

divide方法设置精确的小数点，如：divide(xxxxx,2)

### 六、BigDecimal总结 ###

#### 6.1、总结 ####

在需要精确的小数计算时再使用BigDecimal，BigDecimal的性能比double和float差，在处理庞大，复杂的运算时尤为明显。故一般精度的计算没必要使用BigDecimal。尽量使用参数类型为String的构造函数。

BigDecimal都是不可变的（immutable）的， 在进行每一次四则运算时，都会产生一个新的对象 ，所以在做加减乘除运算时要记得要保存操作后的值。

#### 6.2、工具类推荐 ####

package com.vivo.ars.util;
    import java.math.BigDecimal;
    
    /**
     * 用于高精确处理常用的数学运算
     */
    public class ArithmeticUtils {
        
        //默认除法运算精度
        private static final int DEF_DIV_SCALE = 10;
    
        /**
         * 提供精确的加法运算
         *
         * @param v1 被加数
         * @param v2 加数
         * @return 两个参数的和
         */
    
        public static double add(double v1, double v2) {
        
            BigDecimal b1 = new BigDecimal(Double.toString(v1));
            BigDecimal b2 = new BigDecimal(Double.toString(v2));
            return b1.add(b2).doubleValue();
        }
    
        /**
         * 提供精确的加法运算
         *
         * @param v1 被加数
         * @param v2 加数
         * @return 两个参数的和
         */
        public static BigDecimal add(String v1, String v2) {
        
            BigDecimal b1 = new BigDecimal(v1);
            BigDecimal b2 = new BigDecimal(v2);
            return b1.add(b2);
        }
    
        /**
         * 提供精确的加法运算
         *
         * @param v1    被加数
         * @param v2    加数
         * @param scale 保留scale 位小数
         * @return 两个参数的和
         */
        public static String add(String v1, String v2, int scale) {
        
            if (scale < 0) {
        
                throw new IllegalArgumentException(
                        "The scale must be a positive integer or zero");
            }
            BigDecimal b1 = new BigDecimal(v1);
            BigDecimal b2 = new BigDecimal(v2);
            return b1.add(b2).setScale(scale, BigDecimal.ROUND_HALF_UP).toString();
        }
    
        /**
         * 提供精确的减法运算
         *
         * @param v1 被减数
         * @param v2 减数
         * @return 两个参数的差
         */
        public static double sub(double v1, double v2) {
        
            BigDecimal b1 = new BigDecimal(Double.toString(v1));
            BigDecimal b2 = new BigDecimal(Double.toString(v2));
            return b1.subtract(b2).doubleValue();
        }
    
        /**
         * 提供精确的减法运算。
         *
         * @param v1 被减数
         * @param v2 减数
         * @return 两个参数的差
         */
        public static BigDecimal sub(String v1, String v2) {
        
            BigDecimal b1 = new BigDecimal(v1);
            BigDecimal b2 = new BigDecimal(v2);
            return b1.subtract(b2);
        }
    
        /**
         * 提供精确的减法运算
         *
         * @param v1    被减数
         * @param v2    减数
         * @param scale 保留scale 位小数
         * @return 两个参数的差
         */
        public static String sub(String v1, String v2, int scale) {
        
            if (scale < 0) {
        
                throw new IllegalArgumentException(
                        "The scale must be a positive integer or zero");
            }
            BigDecimal b1 = new BigDecimal(v1);
            BigDecimal b2 = new BigDecimal(v2);
            return b1.subtract(b2).setScale(scale, BigDecimal.ROUND_HALF_UP).toString();
        }
    
        /**
         * 提供精确的乘法运算
         *
         * @param v1 被乘数
         * @param v2 乘数
         * @return 两个参数的积
         */
        public static double mul(double v1, double v2) {
        
            BigDecimal b1 = new BigDecimal(Double.toString(v1));
            BigDecimal b2 = new BigDecimal(Double.toString(v2));
            return b1.multiply(b2).doubleValue();
        }
    
        /**
         * 提供精确的乘法运算
         *
         * @param v1 被乘数
         * @param v2 乘数
         * @return 两个参数的积
         */
        public static BigDecimal mul(String v1, String v2) {
        
            BigDecimal b1 = new BigDecimal(v1);
            BigDecimal b2 = new BigDecimal(v2);
            return b1.multiply(b2);
        }
    
        /**
         * 提供精确的乘法运算
         *
         * @param v1    被乘数
         * @param v2    乘数
         * @param scale 保留scale 位小数
         * @return 两个参数的积
         */
        public static double mul(double v1, double v2, int scale) {
        
            BigDecimal b1 = new BigDecimal(Double.toString(v1));
            BigDecimal b2 = new BigDecimal(Double.toString(v2));
            return round(b1.multiply(b2).doubleValue(), scale);
        }
    
        /**
         * 提供精确的乘法运算
         *
         * @param v1    被乘数
         * @param v2    乘数
         * @param scale 保留scale 位小数
         * @return 两个参数的积
         */
        public static String mul(String v1, String v2, int scale) {
        
            if (scale < 0) {
        
                throw new IllegalArgumentException(
                        "The scale must be a positive integer or zero");
            }
            BigDecimal b1 = new BigDecimal(v1);
            BigDecimal b2 = new BigDecimal(v2);
            return b1.multiply(b2).setScale(scale, BigDecimal.ROUND_HALF_UP).toString();
        }
    
        /**
         * 提供（相对）精确的除法运算，当发生除不尽的情况时，精确到
         * 小数点以后10位，以后的数字四舍五入
         *
         * @param v1 被除数
         * @param v2 除数
         * @return 两个参数的商
         */
    
        public static double div(double v1, double v2) {
        
            return div(v1, v2, DEF_DIV_SCALE);
        }
    
        /**
         * 提供（相对）精确的除法运算。当发生除不尽的情况时，由scale参数指
         * 定精度，以后的数字四舍五入
         *
         * @param v1    被除数
         * @param v2    除数
         * @param scale 表示表示需要精确到小数点以后几位。
         * @return 两个参数的商
         */
        public static double div(double v1, double v2, int scale) {
        
            if (scale < 0) {
        
                throw new IllegalArgumentException("The scale must be a positive integer or zero");
            }
            BigDecimal b1 = new BigDecimal(Double.toString(v1));
            BigDecimal b2 = new BigDecimal(Double.toString(v2));
            return b1.divide(b2, scale, BigDecimal.ROUND_HALF_UP).doubleValue();
        }
    
        /**
         * 提供（相对）精确的除法运算。当发生除不尽的情况时，由scale参数指
         * 定精度，以后的数字四舍五入
         *
         * @param v1    被除数
         * @param v2    除数
         * @param scale 表示需要精确到小数点以后几位
         * @return 两个参数的商
         */
        public static String div(String v1, String v2, int scale) {
        
            if (scale < 0) {
        
                throw new IllegalArgumentException("The scale must be a positive integer or zero");
            }
            BigDecimal b1 = new BigDecimal(v1);
            BigDecimal b2 = new BigDecimal(v1);
            return b1.divide(b2, scale, BigDecimal.ROUND_HALF_UP).toString();
        }
    
        /**
         * 提供精确的小数位四舍五入处理
         *
         * @param v     需要四舍五入的数字
         * @param scale 小数点后保留几位
         * @return 四舍五入后的结果
         */
        public static double round(double v, int scale) {
        
            if (scale < 0) {
        
                throw new IllegalArgumentException("The scale must be a positive integer or zero");
            }
            BigDecimal b = new BigDecimal(Double.toString(v));
            return b.setScale(scale, BigDecimal.ROUND_HALF_UP).doubleValue();
        }
    
        /**
         * 提供精确的小数位四舍五入处理
         *
         * @param v     需要四舍五入的数字
         * @param scale 小数点后保留几位
         * @return 四舍五入后的结果
         */
        public static String round(String v, int scale) {
        
            if (scale < 0) {
        
                throw new IllegalArgumentException(
                        "The scale must be a positive integer or zero");
            }
            BigDecimal b = new BigDecimal(v);
            return b.setScale(scale, BigDecimal.ROUND_HALF_UP).toString();
        }
    
        /**
         * 取余数
         *
         * @param v1    被除数
         * @param v2    除数
         * @param scale 小数点后保留几位
         * @return 余数
         */
        public static String remainder(String v1, String v2, int scale) {
        
            if (scale < 0) {
        
                throw new IllegalArgumentException(
                        "The scale must be a positive integer or zero");
            }
            BigDecimal b1 = new BigDecimal(v1);
            BigDecimal b2 = new BigDecimal(v2);
            return b1.remainder(b2).setScale(scale, BigDecimal.ROUND_HALF_UP).toString();
        }
    
        /**
         * 取余数  BigDecimal
         *
         * @param v1    被除数
         * @param v2    除数
         * @param scale 小数点后保留几位
         * @return 余数
         */
        public static BigDecimal remainder(BigDecimal v1, BigDecimal v2, int scale) {
        
            if (scale < 0) {
        
                throw new IllegalArgumentException(
                        "The scale must be a positive integer or zero");
            }
            return v1.remainder(v2).setScale(scale, BigDecimal.ROUND_HALF_UP);
        }
    
        /**
         * 比较大小
         *
         * @param v1 被比较数
         * @param v2 比较数
         * @return 如果v1 大于v2 则 返回true 否则false
         */
        public static boolean compare(String v1, String v2) {
        
            BigDecimal b1 = new BigDecimal(v1);
            BigDecimal b2 = new BigDecimal(v2);
            int bj = b1.compareTo(b2);
            boolean res;
            if (bj > 0)
                res = true;
            else
                res = false;
            return res;
        }
    }

本文来源 ： [传送门][Link 1]

[Link 1]: https://mp.weixin.qq.com/s?__biz=Mzk0MzIxNTMxNA==&mid=2247494448&idx=1&sn=abedb9d08fb586145e7bda3b75d7a8ac&chksm=c335ec8df442659b2db66e532fe261054052076c86f51d4336b8936f19167a8ca36fbcdf5f1c&mpshare=1&scene=24&srcid=04281skjsDokyXeBHpttYtWu&sharer_sharetime=1682678127447&sharer_shareid=5e1f720976235b1e81fd0d6731dbec3a&key=dde74055d373006c34f9cf66b50f1b998c6d1392a5103798b25583ae780601465329853a8c88ac47960960e0f6a215d9ca4d4b2372b04582ab16514bdd20ffde7042da792e78b309f9e4dc408ea98b75286518e8e032e95bbd5d94b622f3061b17ae1f1ed4b08c9c7518597debc8bfb88bd48d992d05d45dfc26dec279581120&ascene=0&uin=NzM2MjU1Ng==&devicetype=Windows%2011%20x64&version=6309021a&lang=zh_CN&countrycode=CN&exportkey=n_ChQIAhIQgB97iJ9RBe7%2bsiCnzg9XoBLfAQIE97dBBAEAAAAAABObCoLvjLAAAAAOpnltbLcz9gKNyK89dVj0Pd41kR7E6OGefp85cZ6EsrRfvceKumgBdtppHiEn0QXeY72%2bkuScsJ1ykoA8d9bDfQ497XyDSTd7pQNxx3U2FhxTF5wMCoSR4CRxoXzK6PDqxpjrvzthNoD39k3vBLyVBVL/GCfhp//kBuuPaaIZsS9zTNAfS8iLY/EV8OMyasaumqMIIHNEAxGd9j9Y4sGZUAaLsd5jHh7ORAa5kmPG%2bl7S000zJOD3fF4n2WcauKK%2bYExpXPO75HI=&acctmode=0&pass_ticket=ePTpgmYq4tbTNlFfMfQKj/EF/k39LX%2bNAHKuB71FMPTJkwVf9H50KgfMhaMsKadjMorvTSYX0POKAqQQmaHerQ==&wx_header=1