关于go:Go工具箱GoCSV包一个能将结构体和csv内容互转的工具

大家好，我是渔夫子。本号新推出「Go工具箱」系列，意在给大家分享应用go语言编写的、实用的、好玩的工具。同时理解其底层的实现原理，以便更深刻地理解Go语言。

大家在开发中肯定遇到过将数据导出成csv格式文件的需要。go规范库中的csv包是只能写入字符串类型的切片。而在go中个别都是将内容写入到构造体中。所以，若应用规范的csv包，就须要将构造体先转换成对应的字符串类型，再写入文件。那可不可以将构造体对象间接输入成csv格局内容呢？

明天给大家举荐的就是一个能将构造体和csv内容进行疾速互转的工具包：gocsv

gocsv小档案

gocsv的基本功能

gocsv包的最根本的作用就是可能不便的将csv内容转换到对应的构造体上，或者将构造体的内容疾速的转换成csv格局（包含写入文件）。

gocsv.UnmarshalFile函数：csv内容转成构造体

假如文件中的内容如下：

client_id,client_name,client_age
1,Jose,42
2,Daniel,26
3,Vincent,32

而后从文件中读取出内容，并间接转换到构造体Client上，如下：

package main

import (
    "fmt"
    "os"

    "github.com/gocarina/gocsv"
)

type NotUsed struct {
    Name string
}

type Client struct { // Our example struct, you can use "-" to ignore a field
    Id            string `csv:"client_id"`
    Name          string `csv:"client_name"`
    Age           string `csv:"client_age"`
    NotUsedString string `csv:"-"`
    NotUsedStruct NotUsed `csv:"-"` 
}

func main() {
    clientsFile, err := os.OpenFile("clients.csv", os.O_RDWR|os.O_CREATE, os.ModePerm)
    if err != nil {
        panic(err)
    }
    defer clientsFile.Close()

    clients := []*Client{}

    if err := gocsv.UnmarshalFile(clientsFile, &clients); err != nil { // Load clients from file
        panic(err)
    }
    for _, client := range clients {
        fmt.Println("Hello", client.Name)
    }
}

gocsv.MarshalFile函数：构造体转成csv文件

package main

import (
    "fmt"
    "os"

    "github.com/gocarina/gocsv"
)

type NotUsed struct {
    Name string
}

type Client struct { // Our example struct, you can use "-" to ignore a field
    Id            string `csv:"client_id"`
    Name          string `csv:"client_name"`
    Age           string `csv:"client_age"`
    NotUsedString string `csv:"-"`
    NotUsedStruct NotUsed `csv:"-"` 
}

func main() {
    clientsFile, err := os.OpenFile("clients.csv", os.O_RDWR|os.O_CREATE, os.ModePerm)
    if err != nil {
        panic(err)
    }
    defer clientsFile.Close()

    clients := []*Client{}

    clients = append(clients, &Client{Id: "12", Name: "John", Age: "21"}) // Add clients
    clients = append(clients, &Client{Id: "13", Name: "Fred"})
    clients = append(clients, &Client{Id: "14", Name: "James", Age: "32"})
    clients = append(clients, &Client{Id: "15", Name: "Danny"})
    
    err = gocsv.MarshalFile(&clients, clientsFile) // Use this to save the CSV back to the file
    if err != nil {
        panic(err)
    }

}

自定义类型转换器

gocsv包还能够给自定义的构造体类型定义csv和构造体的互转函数。只有自定义的类型实现如下接口即可：

type TypeMarshaller interface {
    MarshalCSV() (string, error)
}

// TypeUnmarshaller is implemented by any value that has an UnmarshalCSV method
// This converter is used to convert a string to your value representation of that string
type TypeUnmarshaller interface {
    UnmarshalCSV(string) error
}

或者将构造体转换成csv字符串时，须要实现如下接口：

// MarshalText encodes the receiver into UTF-8-encoded text and returns the result.
type TextMarshaler interface {
    MarshalText() (text []byte, err error)
}

type TextUnmarshaler interface {
    UnmarshalText(text []byte) error
}

例如，咱们定义了一个构造体DateTime，外面有一个time.Time类型的属性。并且DateTime类型实现了TypeMarshaller接口的MarshalCSV函数和TypeUnmarshaller接口的UnmarshalCSV函数。如下：

type DateTime struct {
    time.Time
}

// Convert the internal date as CSV string
func (date *DateTime) MarshalCSV() (string, error) {
    return date.Time.Format("20060201"), nil
}

// You could also use the standard Stringer interface 
func (date *DateTime) String() (string) {
    return date.String() // Redundant, just for example
}

// Convert the CSV string as internal date
func (date *DateTime) UnmarshalCSV(csv string) (err error) {
    date.Time, err = time.Parse("20060201", csv)
    return err
}

type Client struct { // Our example struct with a custom type (DateTime)
    Id       string   `csv:"id"`
    Name     string   `csv:"name"`
    Employed DateTime `csv:"employed"`
}

func main() {

    client := []Client{
        {
            Id: "001",
            Name: "Go学堂",
            Employed: DateTime{time.Now()},
        },
    }

    csvContent, _ := gocsv.MarshalString(client)
    fmt.Println("csv:", csvContent) //输入内容是 001,Go学堂,20231003
}

当咱们运行上述代码，最终的输入内容是：

001,Go学堂,20231003

最初的日期就是按DateTime的MarshalCSV函数格局输入的。

自定义CSV的Reader/Writer

在结尾处咱们提到，csv文件中的分隔符默认是逗号。但也能够是其余字符。这就要求咱们在读取或写入之前指定好内容的分隔号。那么就能够通过自定义的Reader/Writer来笼罩默认的Reader/Writer的选项。如下：

• 指定读取内容的宰割符是 “|”

  gocsv.SetCSVReader(func(in io.Reader) gocsv.CSVReader {
    r := csv.NewReader(in)
    r.Comma = '|'
    return r // Allows use pipe as delimiter
  })

• 指定写入的内容是用 宰割符 “|” 进行宰割的

  gocsv.SetCSVWriter(func(out io.Writer) *gocsv.SafeCSVWriter {
    writer := csv.NewWriter(out)
    writer.Comma = '|'
    return gocsv.NewSafeCSVWriter(writer)
  })

gocsv包的特点总结

1、构造体切片和csv内容互转。可能将构造体切片（或数组）间接输入成csv内容或输入到文件。反之亦然。

2、csv标签。其转换过程是通过构造体上的“csv”标签进行关联的。

3、csv标签对应csv内容表头。当构造体和csv格局互转时，构造体中的csv标签对应的就是csv表格的表头，构造体中的字段程序对应的就是csv文件列的程序。

4、底层仍然是应用规范库中的csv。在写入csv文件时，底层实际上用的还是go规范库中的encoding/csv/Writer构造体的Write(row []string)办法。

5、主动将构造体字段的类型转换成字符串：大家看到规范csv包中的Write办法的入参是string类型的切片，而在要转换的构造体上的字段能够是各种类型。这里就是gocsv包中的一个特点：能够将字段中的非string类型转换成string类型，最终写入到csv文件中。

6、可自定义类型转换器。能够通过实现TypeMarshaller接口或TypeUnMarshaller接口对自定义类型的内容按对应的格局输入成csv内容。

7、可自定义CSV的Reader/Writer来笼罩默认参数。比方csv格局的内容默认应用逗号分隔内容。通过该性能咱们能够指定应用其余分隔符的csv内容。比方应用”|”或”;”等。

这里须要留神的是 将csv文件的内容肯定是解析到构造体类型的切片或数组中。同样，也只有是构造体类型的切片或数组能力间接写入到csv文件中。

以上，就是明天咱们要分享的工具包。如需理解更多内容，请关注「Go学堂」。

—特地举荐—

特地举荐：一个专一go我的项目实战、我的项目中踩坑教训及避坑指南、各种好玩的go工具的公众号，「Go学堂」，专一实用性，十分值得大家关注。点击下方公众号卡片，间接关注。关注送《100个go常见的谬误》pdf文档。