lancet/docs/formatter_zh-CN.md

Formatter

formatter 格式化器包含一些数据格式化处理方法。

源码:

https://github.com/duke-git/lancet/blob/v1/formatter/formatter.go

用法:

import (
    "github.com/duke-git/lancet/formatter"
)

目录

• Comma
• Pretty
• PrettyToWriter
• DecimalBytes
• BinaryBytes
• ParseDecimalBytes
• ParseBinaryBytes

文档

Comma

用逗号每隔3位分割数字/字符串，签名添加符号。参数必须是数字或者可以转为数字的字符串

函数签名:

func Comma(v interface{}, prefixSymbol string) string

例子:

package main

import (
    "fmt"
    "github.com/duke-git/lancet/formatter"
)

func main() {
    fmt.Println(formatter.Comma("12345", ""))   // "12,345"
    fmt.Println(formatter.Comma(12345.67, "¥")) // "¥12,345.67"
}

Pretty

返回pretty JSON字符串.

函数签名:

func Pretty(v interface{}) (string, error)

示例:

package main

import (
    "fmt"
    "github.com/duke-git/lancet/formatter"
)

func main() {
    result1, _ := formatter.Pretty([]string{"a", "b", "c"})
    result2, _ := formatter.Pretty(map[string]int{"a": 1})

    fmt.Println(result1)
    fmt.Println(result2)

    // Output:
    // [
    //     "a",
    //     "b",
    //     "c"
    // ]
    // {
    //     "a": 1
    // }
}

PrettyToWriter

Pretty encode数据到writer。

函数签名:

func PrettyToWriter(v interface{}, out io.Writer) error

示例:

package main

import (
    "fmt"
    "github.com/duke-git/lancet/formatter"
)

func main() {
    type User struct {
        Name string `json:"name"`
        Aage uint   `json:"age"`
    }
    user := User{Name: "King", Aage: 10000}

    buf := &bytes.Buffer{}
    err := formatter.PrettyToWriter(user, buf)

    fmt.Println(buf)
    fmt.Println(err)

    // Output:
    // {
    //     "name": "King",
    //     "age": 10000
    // }
    //
    // <nil>
}

DecimalBytes

返回十进制标准（以1000为基数）下的可读字节单位字符串。precision参数指定小数点后的位数，默认为4。

函数签名:

func DecimalBytes(size float64, precision ...int) string

示例:

package main

import (
    "fmt"
    "github.com/duke-git/lancet/formatter"
)

func main() {
    result1 := formatter.DecimalBytes(1000)
    result2 := formatter.DecimalBytes(1024)
    result3 := formatter.DecimalBytes(1234567)
    result4 := formatter.DecimalBytes(1234567, 3)

    fmt.Println(result1)
    fmt.Println(result2)
    fmt.Println(result3)
    fmt.Println(result4)

    // Output:
    // 1KB
    // 1.024KB
    // 1.2346MB
    // 1.235MB
}

BinaryBytes

返回binary标准（以1024为基数）下的可读字节单位字符串。precision参数指定小数点后的位数，默认为4。

函数签名:

func BinaryBytes(size float64, precision ...int) string

示例:

package main

import (
    "fmt"
    "github.com/duke-git/lancet/formatter"
)

func main() {
    result1 := formatter.BinaryBytes(1024)
    result2 := formatter.BinaryBytes(1024 * 1024)
    result3 := formatter.BinaryBytes(1234567)
    result4 := formatter.BinaryBytes(1234567, 2)

    fmt.Println(result1)
    fmt.Println(result2)
    fmt.Println(result3)
    fmt.Println(result4)

    // Output:
    // 1KiB
    // 1MiB
    // 1.1774MiB
    // 1.18MiB
}

ParseDecimalBytes

将字节单位字符串转换成其所表示的字节数（以1000为基数）。

函数签名:

func ParseDecimalBytes(size string) (uint64, error)

示例:

package main

import (
    "fmt"
    "github.com/duke-git/lancet/formatter"
)

func main() {
    result1, _ := formatter.ParseDecimalBytes("12")
    result2, _ := formatter.ParseDecimalBytes("12k")
    result3, _ := formatter.ParseDecimalBytes("12 Kb")
    result4, _ := formatter.ParseDecimalBytes("12.2 kb")

    fmt.Println(result1)
    fmt.Println(result2)
    fmt.Println(result3)
    fmt.Println(result4)

    // Output:
    // 12
    // 12000
    // 12000
    // 12200
}

ParseBinaryBytes

将字节单位字符串转换成其所表示的字节数（以1024为基数）。

函数签名:

func ParseBinaryBytes(size string) (uint64, error)

示例:

package main

import (
    "fmt"
    "github.com/duke-git/lancet/formatter"
)

func main() {
    result1, _ := formatter.ParseBinaryBytes("12")
    result2, _ := formatter.ParseBinaryBytes("12ki")
    result3, _ := formatter.ParseBinaryBytes("12 KiB")
    result4, _ := formatter.ParseBinaryBytes("12.2 kib")

    fmt.Println(result1)
    fmt.Println(result2)
    fmt.Println(result3)
    fmt.Println(result4)

    // Output:
    // 12
    // 12288
    // 12288
    // 12492
}