Flutter货币处理插件flutter_money的使用

Flutter货币处理插件flutter_money的使用

本项目基于 FlutterMoneyFormatter。以下为原README的重述。

FlutterMoney 是一个针对 Flutter 的扩展插件，用于根据你的喜好格式化各种类型的货币，而不必受限于任何本地化设置。

依赖项 :

安装

要安装 FlutterMoney，你可以查看 安装指南。

使用

首先导入库：

import 'package:flutter_money/flutter_money.dart';

入门

为了能够将 double 类型的值格式化为你想要的各种形式，你需要创建一个 FlutterMoney 实例，如下所示：

FlutterMoney fm = FlutterMoney(
    amount: 12345678.9012345
);

注意，上述代码仍然使用了默认配置，如在配置部分所解释的那样。

创建实例后，你可以请求各种格式的结果，如下所示：

// 正常格式
print(fm.output.nonSymbol); // 12,345,678.90
print(fm.output.symbolOnLeft); // $ 12,345,678.90
print(fm.output.symbolOnRight); // 12,345,678.90 $
print(fm.output.fractionDigitsOnly); // 90
print(fm.output.withoutFractionDigits); // 12,345,678

// 简约格式
print(fm.output.compactNonSymbol) // 12.3M
print(fm.output.compactSymbolOnLeft) // $ 12.3M
print(fm.output.compactSymbolOnRight) // 12.3M $

如果你将输出格式多次使用，我强烈建议你初始化一个变量，如下所示：

MoneyFormatterOutput fo = fm.output;

或者在初始化 FlutterMoney 实例时直接赋值，如下所示：

MoneyFormatterOutput fo = FlutterMoney(
    amount: 12345678.9012345
).output;

这样你就可以更方便地获取值，如下所示：

// 正常格式
print(fo.nonSymbol); // 12,345,678.90
print(fo.symbolOnLeft); // $ 12,345,678.90
print(fo.symbolOnRight); // 12,345,678.90 $
print(fo.fractionDigitsOnly); // 90
print(fo.withoutFractionDigits); // 12,345,678

// 简约格式
print(fo.compactNonSymbol) // 12.3M
print(fo.compactLeftSymbol) // $ 12.3M
print(fo.compactRightSymbol) // 12.3M $

更多详细信息，请参见 演示部分。

配置

要根据你的需求调整格式，你可以通过 settings 参数进行设置：

FlutterMoney fm = new FlutterMoney(
    amount: 12345678.9012345,
    settings: MoneyFormatterSettings(
        symbol: 'IDR',
        thousandSeparator: '.',
        decimalSeparator: ',',
        symbolAndNumberSeparator: ' ',
        fractionDigits: 3,
        compactFormatType: CompactFormatType.sort
    )
)

当然，你不必在 settings (MoneyFormatterSettings) 参数中初始化整个配置，如上例所示。你可以更改上述配置中的一个或多个。这是因为上述每个配置都不是强制性的，并且有默认值。

属性、方法和函数

FlutterMoney

MoneyFormatterSettings

CompactFormatType

你可以更改紧凑格式类型，例如使用 M 或 million 表示百万，或使用 T 或 trillion 表示万亿等。这种类型只支持两种类型，如下所述：

MoneyFormatterOutput

你可以通过 MoneyFormatterOutput 实例中的属性来使用符合你需求的格式。

MoneyFormatterCompare

使用比较器的例子：

FlutterMoney fm = FlutterMoney(amount: 12345678.9012345);
double comparerValue = 5678.9012;

print(fm.comparator.isEqual(comparerValue)); // false
print(fm.comparator.isGreaterThan(comparerValue)); // true

快速计算

fastCalc 是一个可以用于执行各种快速计算过程的函数。在实现时，fastCalc 函数返回一个 FlutterMoney 实例，因此你可以通过链式方法一次执行多个计算功能。

函数

FlutterMoney fastCalc({
    @required FastCalcType type, 
    @required double amount
})

实现

FlutterMoney fm = FlutterMoney(amount: 12345.678);
fm.fastCalc(type: FastCalcType.addition, amount: 1.111);
fm.fastCalc(type: FastCalcType.substraction, amount: 2.222);

print(fm.output.nonSymbol); // 12,345.68

由于它支持链式过程，上面的示例可以简化为：

FlutterMoney fm = FlutterMoney(amount: 12345.678)
    .fastCalc(type: FastCalcType.addition, amount: 1.111)
    .fastCalc(type: FastCalcType.substraction, amount: 2.222);

print(fm.output.nonSymbol);  // 12,345.68

type 参数由 FastCalcType 数据类型枚举提供。以下是 FastCalcType 枚举的说明表：

复制实例

出于某些原因，你可能需要复制实例并仅更改一些配置。为此，你可以使用 copyWith 方法，如下所示：

FlutterMoney fm = FlutterMoney(amount: 12345678.9012345);

print(fm.output.symbolOnLeft); // $ 12,345,678.90
print(fm.copyWith(symbol: 'IDR', symbolAndNumberSeparator: '-').output.symbolOnLeft); // IDR-12,345,678.90

演示

更多完整的示例，你可以从 示例目录 获取。

我们的其他包

查看我们的 其他包。

帮助我

如果你发现任何问题或错误，请在这里 报告问题。你也可以在这里 请求新功能。

更改日志

你对每次版本的变化感到好奇吗？ 这里 查看详细的变更信息。

贡献者

许可证

版权所有 (c) 2019, Fadhly Permata <fadhly.permata@gmail.com>
保留所有权利。

重新分发和使用源码和二进制形式，无论是修改还是未修改，均允许，但须满足以下条件：

1. 源码的重新分发必须保留上述版权声明、此条件列表和以下免责声明。
2. 二进制形式的重新分发必须在文档和/或其他提供的材料中包含上述版权声明、此条件列表和以下免责声明。

此软件按“现状”提供，没有任何明示或暗示的保证，包括但不限于适销性和适用于特定用途的默示保证。在任何情况下，版权持有者或贡献者都不应对任何直接、间接、附带、特殊、惩戒性或后果性损害负责（包括但不限于替代商品或服务的采购、数据或利润的损失、或业务中断）无论这些损害是如何引起的，即使已被告知发生此类损害的可能性。

软件和文档中包含的观点和结论属于作者，不应被解释为官方政策，无论是明示的还是暗示的，代表“FlutterMoney”项目的观点。