Go?CSV包實現(xiàn)結構體和csv內(nèi)容互轉工具詳解

更新時間：2023年03月14日 10:28:37 作者：Go學堂

這篇文章主要介紹了Go?CSV包實現(xiàn)結構體和csv內(nèi)容互轉工具詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪

引言

大家在開發(fā)中一定遇到過將數(shù)據(jù)導出成csv格式文件的需求。go標準庫中的csv包是只能寫入字符串類型的切片。而在go中一般都是將內(nèi)容寫入到結構體中。所以，若使用標準的csv包，就需要將結構體先轉換成對應的字符串類型，再寫入文件。那可不可以將結構體對象直接輸出成csv格式內(nèi)容呢？

今天給大家推薦的就是一個能將結構體和csv內(nèi)容進行快速互轉的工具包：gocsv

gocsv小檔案

gocsv 小檔案
star	1.5 k	used by	1.6k
contributors	80	作者	gocarina
功能簡介	提供一個簡單、高效地將csv內(nèi)容和結構體進行互轉的功能
項目地址	github.com/gocarina/go…
相關知識	reflect、結構體tag

gocsv的基本功能

gocsv包的最基本的作用就是能夠方便的將csv內(nèi)容轉換到對應的結構體上，或者將結構體的內(nèi)容快速的轉換成csv格式（包括寫入文件）。

gocsv.UnmarshalFile函數(shù)：csv內(nèi)容轉成結構體

假設文件中的內(nèi)容如下：

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

然后從文件中讀取出內(nèi)容，并直接轉換到結構體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函數(shù)：結構體轉成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, &amp;Client{Id: "12", Name: "John", Age: "21"}) // Add clients
	clients = append(clients, &amp;Client{Id: "13", Name: "Fred"})
	clients = append(clients, &amp;Client{Id: "14", Name: "James", Age: "32"})
	clients = append(clients, &amp;Client{Id: "15", Name: "Danny"})
	err = gocsv.MarshalFile(&amp;clients, clientsFile) // Use this to save the CSV back to the file
	if err != nil {
		panic(err)
	}
}

自定義類型轉換器

gocsv包還可以給自定義的結構體類型定義csv和結構體的互轉函數(shù)。只要自定義的類型實現(xiàn)如下接口即可：

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字符串時，需要實現(xiàn)如下接口：

// 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類型實現(xiàn)了TypeMarshaller接口的MarshalCSV函數(shù)和TypeUnmarshaller接口的UnmarshalCSV函數(shù)。如下：

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) //輸出內(nèi)容是 001,Go學堂,20231003
}

當我們運行上述代碼，最終的輸出內(nèi)容是：

001,Go學堂,20231003

最后的日期就是按DateTime的MarshalCSV函數(shù)格式輸出的。

自定義CSV的Reader/Writer

在開頭處我們提到，csv文件中的分隔符默認是逗號。但也可以是其他字符。這就要求我們在讀取或寫入之前指定好內(nèi)容的分隔號。那么就可以通過自定義的Reader/Writer來覆蓋默認的Reader/Writer的選項。如下：

指定讀取內(nèi)容的分割符是 "|"

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

指定寫入的內(nèi)容是用分割符 "|" 進行分割的

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