Golang实现Fowler货币模式的高效处理插件库go-money的使用

简介

GoMoney提供了使用货币最小单位处理货币值的能力。这个包提供了基本且精确的货币操作，如四舍五入、拆分和分配。由于小的舍入差异，货币值不应存储为浮点数。

快速开始

安装包：

$ go get github.com/Rhymond/go-money

特性

• 提供Money结构体，存储货币金额值及其货币信息
• 提供Money.Amount结构体，封装所有关于货币单位的信息
• 以整数形式表示货币值，以分为单位，避免浮点舍入错误
• 以Money.Currency实例表示货币，提供高度灵活性

使用示例

初始化

使用最小单位值初始化Money（例如100表示1英镑）。使用ISO 4217货币代码设置货币。注意，所有ISO 4217货币代码也提供了常量。

pound := money.New(100, money.GBP)

或者使用直接金额初始化Money：

quarterEuro := money.NewFromFloat(0.25, money.EUR)

完整示例

package main

import (
  "log"

  "github.com/Rhymond/go-money"
)

func main() {
    // 初始化1英镑
    pound := money.New(100, money.GBP)
    
    // 加法操作
    twoPounds, err := pound.Add(pound)
    if err != nil {
        log.Fatal(err)
    }

    // 将2英镑分成3份
    parties, err := twoPounds.Split(3)
    if err != nil {
        log.Fatal(err)
    }

    // 显示分配结果
    parties[0].Display() // £0.67
    parties[1].Display() // £0.67
    parties[2].Display() // £0.66
}

比较操作

Go-money提供基本的比较操作：

• Equals
• GreaterThan
• GreaterThanOrEqual
• LessThan
• LessThanOrEqual
• Compare

比较必须在相同货币单位之间进行。

pound := money.New(100, money.GBP)
twoPounds := money.New(200, money.GBP)
twoEuros := money.New(200, money.EUR)

pound.GreaterThan(twoPounds) // false, nil
pound.LessThan(twoPounds) // true, nil
twoPounds.Equals(twoEuros) // false, error: Currencies don't match
twoPounds.Compare(pound) // 1, nil
pound.Compare(twoPounds) // -1, nil
pound.Compare(pound) // 0, nil
pound.Compare(twoEuros) // pound.amount, ErrCurrencyMismatch

断言

• IsZero
• IsNegative
• IsPositive

零值

pound := money.New(100, money.GBP)
result := pound.IsZero() // false

正值

pound := money.New(100, money.GBP)
pound.IsPositive() // true

负值

pound := money.New(100, money.GBP)
pound.IsNegative() // false

运算操作

• Add
• Subtract
• Multiply
• Absolute
• Negative

加法

pound := money.New(100, money.GBP)
twoPounds := money.New(200, money.GBP)

result, err := pound.Add(twoPounds) // £3.00, nil

减法

pound := money.New(100, money.GBP)
twoPounds := money.New(200, money.GBP)

result, err := pound.Subtract(twoPounds) // -£1.00, nil

乘法

pound := money.New(100, money.GBP)
result := pound.Multiply(2) // £2.00

绝对值

pound := money.New(-100, money.GBP)
result := pound.Absolute() // £1.00

负值

pound := money.New(100, money.GBP)
result := pound.Negative() // -£1.00

分配

拆分

pound := money.New(100, money.GBP)
parties, err := pound.Split(3)

if err != nil {
    log.Fatal(err)
}

parties[0].Display() // £0.34
parties[1].Display() // £0.33
parties[2].Display() // £0.33

分配

pound := money.New(100, money.GBP)
// Allocate是可变参数函数，可以接收切片或逗号分隔的整数
parties, err := pound.Allocate(33, 33, 33)

if err != nil {
    log.Fatal(err)
}

parties[0].Display() // £0.34
parties[1].Display() // £0.33
parties[2].Display() // £0.33

格式化

显示

money.New(123456789, money.EUR).Display() // €1,234,567.89

作为主单位

money.New(123456789, money.EUR).AsMajorUnits() // 1234567.89

贡献

感谢您的贡献！请使用GitHub问题和拉取请求进行贡献。

许可证

MIT许可证。有关更多信息，请参阅许可证文件。