lancet/docs/convertor_zh-CN.md

Convertor

convertor 转换器包支持一些常见的数据类型转换

源码:

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

用法:

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

目录

• ColorHexToRGB
• ColorRGBToHex
• ToBool
• ToBytes
• ToChar
• ToChannel
• ToFloat
• ToInt
• ToJson
• ToString
• StructToMap
• EncodeByte
• DecodeByte
• DeepClone

文档

ColorHexToRGB

颜色值十六进制转rgb

函数签名:

func ColorHexToRGB(colorHex string) (red, green, blue int)

列子:

package main

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

func main() {
    colorHex := "#003366"
    r, g, b := ColorHexToRGB(colorHex)
    fmt.Println(r, g, b) //0,51,102
}

ColorRGBToHex

颜色值rgb转十六进制

函数签名:

func ColorRGBToHex(red, green, blue int) string

列子:

package main

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

func main() {
    r := 0
    g := 51
    b := 102
    colorHex := ColorRGBToHex(r, g, b)

    fmt.Println(colorHex) //#003366
}

ToBool

字符串转布尔类型，使用strconv.ParseBool

函数签名:

func ToBool(s string) (bool, error)

列子:

package main

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

func main() {
    v1, _ := convertor.ToBool("1")
    fmt.Println(v1) //true

    v2, _ := convertor.ToBool("true")
    fmt.Println(v2) //true

    v3, _ := convertor.ToBool("True")
    fmt.Println(v3) //true

    v4, _ := convertor.ToBool("123")
    fmt.Println(v4) //false
}

ToBytes

interface转字节切片.

函数签名:

func ToBytes(data interface{}) ([]byte, error)

列子:

package main

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

func main() {
    bytesData, err := convertor.ToBytes("0")
    if err != nil {
        fmt.Println(err)
    }
    fmt.Println(bytesData) //[]bytes{3, 4, 0, 0}
}

ToChar

字符串转字符切片

函数签名:

func ToChar(s string) []string

列子:

package main

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

func main() {
    chars := convertor.ToChar("")
    fmt.Println(chars) //[]string{""}

    chars = convertor.ToChar("abc")
    fmt.Println(chars) //[]string{"a", "b", "c"}

    chars = convertor.ToChar("1 2#3")
    fmt.Println(chars) //[]string{"1", " ", "2", "#", "3"}
}

ToChannel

将切片转为只读channel

函数签名:

func ToChannel(array []interface{}) <-chan interface{}

例子:

package main

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

func main() {
    ch := convertor.ToChannel([]int{1, 2, 3})

    val1, _ := <-ch
    fmt.Println(val1) //1

    val2, _ := <-ch
    fmt.Println(val2) //2

    val3, _ := <-ch
    fmt.Println(val3) //3

    _, ok := <-ch
    fmt.Println(ok) //false
}

ToFloat

将interface转成float64类型，如果参数无法转换，会返回0和error

函数签名:

func ToFloat(value interface{}) (float64, error)

列子:

package main

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

func main() {
    v, err := convertor.ToFloat("")
    if err != nil {
        fmt.Println(err) //strconv.ParseFloat: parsing "": invalid syntax
    }
    fmt.Println(v) //0

    v, _ = convertor.ToFloat("-.11")
    fmt.Println(v) //-0.11
}

ToInt

将interface转成intt64类型，如果参数无法转换，会返回0和error

函数签名:

func ToInt(value interface{}) (int64, error)

例子:

package main

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

func main() {
    v, err := convertor.ToInt("")
    if err != nil {
        fmt.Println(err) //strconv.ParseInt: parsing "": invalid syntax
    }
    fmt.Println(v) //0

    v, _ = convertor.ToFloat(1.12)
    fmt.Println(v) //1
}

ToJson

将interface转成json字符串，如果参数无法转换，会返回""和error

函数签名:

func ToJson(value interface{}) (string, error)

列子:

package main

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

func main() {
    var aMap = map[string]int{"a": 1, "b": 2, "c": 3}
    jsonStr, _ := convertor.ToJson(aMap)
    fmt.Printf("%q", jsonStr) //"{\"a\":1,\"b\":2,\"c\":3}"
}

ToString

将interface转成字符串

函数签名:

func ToString(value interface{}) string

例子:

package main

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

func main() {
    fmt.Printf("%q", convertor.ToString(1)) //"1"
    fmt.Printf("%q", convertor.ToString(1.1)) //"1.1"
    fmt.Printf("%q", convertor.ToString([]int{1, 2, 3})) //"[1,2,3]"
}

StructToMap

将struct转成map，只会转换struct中可导出的字段。struct中导出字段需要设置json tag标记

函数签名:

func StructToMap(value interface{}) (map[string]interface{}, error)

列子:

package main

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

func main() {
    type People struct {
        Name string `json:"name"`
        age  int
    }
    p := People{
        "test",
        100,
    }
    pm, _ := convertor.StructToMap(p)

    fmt.Printf("type: %T, value: %s", pm, pm) //type: map[string]interface {}, value: map[name:test]
}

EncodeByte

将data编码成字节切片

函数签名:

func EncodeByte(data any) ([]byte, error)

例子:

package main

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

func main() {
    byteData, _ := convertor.EncodeByte("abc")
    fmt.Println(byteData) //[]byte{6, 12, 0, 3, 97, 98, 99}
}

DecodeByte

解码字节切片到目标对象，目标对象需要传入一个指针实例子

函数签名:

func DecodeByte(data []byte, target any) error

例子:

package main

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

func main() {
    var result string
    byteData := []byte{6, 12, 0, 3, 97, 98, 99}
    convertor.DecodeByte(byteData, &result)
    fmt.Println(result) //"abc"
}

DeepClone

创建一个传入值的深拷贝, 无法克隆结构体的非导出字段。

函数签名:

func DeepClone[T any](src T) T

示例:

package main

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

func main() {
    type Struct struct {
        Str        string
        Int        int
        Float      float64
        Bool       bool
        Nil        interface{}
        unexported string
    }

    cases := []interface{}{
        true,
        1,
        0.1,
        map[string]int{
            "a": 1,
            "b": 2,
        },
        &Struct{
            Str:   "test",
            Int:   1,
            Float: 0.1,
            Bool:  true,
            Nil:   nil,
            // unexported: "can't be cloned",
        },
    }

    for _, item := range cases {
        cloned := convertor.DeepClone(item)

        isPointerEqual := &cloned == &item
        fmt.Println(cloned, isPointerEqual)
    }

    // Output:
    // true false
    // 1 false
    // 0.1 false
    // map[a:1 b:2] false
    // &{test 1 0.1 true <nil> } false
}