Flutter金额格式化插件mdamount的使用

Flutter金额格式化插件mdamount的使用

mdamount 是一个用于处理金额的库。它提供了从灵活创建到丰富的数据操作和字符串化选项的新方法。

构造方法

要开始使用货币对象，首先需要创建它，以下是几种创建方法：

• Amount 带有以下参数：

  • BigInt 分子
  • 自定义 精度，如果未提供或设置了负精度，则将使用 Amount.defaultPrecision

• Amount.fromNumerator 带有以下参数：

  • int 分子
  • 自定义 精度，如果未提供，则将使用 Amount.defaultPrecision

• Amount.fromBigInt 带有以下参数：

  • BigInt 数额
  • 自定义 精度，如果未提供，则将使用 Amount.defaultPrecision

• Amount.fromInt 带有以下参数：

  • int 数额
  • 自定义 精度，如果未提供，则将使用 Amount.defaultPrecision

• Amount.fromDecimal 带有以下参数：

  • Decimal 数额（来自 decimal 包）
  • 自定义 精度，如果未提供，则将使用 Amount.defaultPrecision

• Amount.fromDouble 带有以下参数：

  • double 数额
  • 自定义 精度，如果未提供，则将使用 Amount.defaultPrecision

• Amount.fromString 带有以下参数：

  • String
  • 自定义 精度，如果未提供，则将使用 Amount.defaultPrecision

此外，还有一些方便的方法来创建对象：

• Amount.zeroOf 创建一个以 0 为分子的金额，并带有自定义精度
• Amount.oneOf 创建一个以 1 为分子的金额，并带有自定义精度
• Amount.oneIntOf 创建一个以 1 为整数的金额，并带有自定义精度
• Amount.zero 创建一个以 0 为分子的金额，并带有默认精度 (Amount.defaultPrecision)
• Amount.one 创建一个以 1 为分子的金额，并带有默认精度 (Amount.defaultPrecision)
• Amount.oneInt 创建一个以 1 为整数的金额，并带有默认精度 (Amount.defaultPrecision)

数据操作

Amount 对象是可比较的，并且具有所有必需的操作符：

• 一元运算符 -
• 二元运算符 -
• 运算符 +
• 运算符 *
• 运算符 /
• 比较运算符 <, <=, >, >=
• 等于运算符 ==

你可以使用以下方法/属性/字段来操作对象：

• cents - 返回金额的 BigInt 表示形式的美分
• currency - 返回金额的货币类型
• precision - 返回金额的精度（小数部分的位数）
• sign - 返回金额的符号
• isEven - 判断金额是否为偶数
• isOdd - 判断金额是否为奇数
• isNegative - 判断金额是否为负数
• isPositive - 判断金额是否为正数
• isZero - 判断金额是否等于零
• isGreaterThanZero - 判断金额是否大于零
• isGreaterThanOrEqualZero - 判断金额是否大于等于零
• isLessThanZero - 判断金额是否小于零
• isLessThanOrEqualZero - 判断金额是否小于等于零
• integer - 返回金额的整数部分
• fractional - 返回金额的小数部分（以 BigInt 美分为单位）
• fractionalDecimal - 返回金额的小数部分（以 Decimal 为单位）
• fractionalDouble - 返回金额的小数部分（以 double 为单位）
• toDecimal - 返回金额的 Decimal 形式
• toDouble - 返回金额的 double 形式
• abs - 返回金额的绝对值（始终为正）
• round - 返回金额的四舍五入结果
• ceil - 返回金额的向上取整结果（四舍五入到下一个整数）
• floor - 返回金额的向下取整结果（截断小数部分）
• toString - 返回金额的字符串表示形式，可以进行多种定制：
  • DecimalSeparatorFormat - 指定使用哪种小数分隔符
    • point
    • comma
  • RankFormat - 指定等级格式化
    • none (XXXX)
    • space (X XXX)
  • AmountFormat - 指定金额显示格式
    • integer - 只显示整数部分 (XXXX)
    • fixedDouble - 小数部分显示完整的精度，即使为零 (XXXX.XX)
    • flexibleDouble - 小数部分不显示尾随零 (XXXX/XXXX.X/XXXX.XX)
  • precision - 如果设置，此方法将根据 AmountFormat 的不同而表现不同
    • integer - precision 被忽略
    • fixedDouble - precision 将覆盖 Amount.precision
    • flexibleDouble - precision 只在分数长度小于 precision 时使用

更改或访问默认精度

要访问默认精度，请使用以下静态获取器：

• Amount.defaultPrecision

要更改默认精度，请使用以下静态方法：

• Amount.setDefaultPrecision(<new_precision>)

但是请注意，精度不能小于零。

已知限制

• 最大精度为 15，超过此精度的数据将被修剪，因为 Decimal 内部无法处理如此高的精度。

示例

要在示例部分查看用法，请参阅 示例 部分。

功能请求和错误报告

如果您有任何功能请求或遇到问题，请在此处发布：问题反馈。

完整示例代码

import 'package:mdamount/mdamount.dart';

void main() {
  // 创建一个金额对象
  var amount = Amount.fromDouble(1234.5678, precision: 2);

  // 输出金额的字符串表示形式
  print(amount.toString(
    decimalSeparatorFormat: DecimalSeparatorFormat.point,
    rankFormat: RankFormat.space,
    amountFormat: AmountFormat.fixedDouble,
    precision: 2
  ));

  // 输出金额的整数部分
  print('整数部分: ${amount.integer}');

  // 输出金额的小数部分
  print('小数部分: ${amount.fractionalDecimal}');

  // 输出金额的绝对值
  print('绝对值: ${amount.abs()}');

  // 输出金额的四舍五入值
  print('四舍五入值: ${amount.round()}');

  // 输出金额的向上取整值
  print('向上取整值: ${amount.ceil()}');

  // 输出金额的向下取整值
  print('向下取整值: ${amount.floor()}');
}