Go CSV包实现结构体和csv内容互转工具详解

 更新时间:2023年03月14日 10:28:37   作者:Go学堂  
这篇文章主要介绍了Go CSV包实现结构体和csv内容互转工具详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪

引言

大家在开发中一定遇到过将数据导出成csv格式文件的需求。go标准库中的csv包是只能写入字符串类型的切片。而在go中一般都是将内容写入到结构体中。所以,若使用标准的csv包,就需要将结构体先转换成对应的字符串类型,再写入文件。那可不可以将结构体对象直接输出成csv格式内容呢?

今天给大家推荐的就是一个能将结构体和csv内容进行快速互转的工具包:gocsv

gocsv小档案

gocsv 小档案
star1.5 kused by1.6k
contributors80作者gocarina
功能简介提供一个简单、高效地将csv内容和结构体进行互转的功能
项目地址github.com/gocarina/go…
相关知识reflect、结构体tag

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 CSV包工具的资料请关注脚本之家其它相关文章!

相关文章

  • Go语言之使用pprof工具查找goroutine(协程)泄漏

    Go语言之使用pprof工具查找goroutine(协程)泄漏

    这篇文章主要介绍了Go语言之使用pprof工具查找goroutine(协程)泄漏,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-01-01
  • Golang根据job数量动态控制每秒协程的最大创建数量方法详解

    Golang根据job数量动态控制每秒协程的最大创建数量方法详解

    这篇文章主要介绍了Golang根据job数量动态控制每秒协程的最大创建数量方法
    2024-01-01
  • 详解Golang中Channel的用法

    详解Golang中Channel的用法

    如果说goroutine是Go语言程序的并发体的话,那么channels则是它们之间的通信机制。这篇文章主要介绍Golang中Channel的用法,需要的朋友可以参考下
    2020-11-11
  • Go语言使用组合的思想实现继承

    Go语言使用组合的思想实现继承

    这篇文章主要为大家详细介绍了在 Go 里面如何使用组合的思想实现“继承”,文中的示例代码讲解详细,对我们学习Go语言有一定的帮助,需要的可以了解一下
    2022-12-12
  • 解析golang中的并发安全和锁问题

    解析golang中的并发安全和锁问题

    本文我们来学习一下golang中的并发安全和锁问题,文章通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧
    2021-11-11
  • GoLang中生成UUID唯一标识的实现

    GoLang中生成UUID唯一标识的实现

    这篇文章主要介绍了GoLang中生成UUID唯一标识的实现,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-05-05
  • Go语言常见错误之any没传递任何信息解决分析

    Go语言常见错误之any没传递任何信息解决分析

    Go语言,由于其高效强大的并行处理能力和优雅简单的设计哲学,一直以来都是编程世界的宠儿,然而,对于一些Go新手和甚至熟悉Go的程序员也可能会遇到一个常见的错误: any没传递任何信息,那么,如何规避这个错误,本文将揭示其中的秘密
    2024-01-01
  • Golang设计模式之外观模式讲解和代码示例

    Golang设计模式之外观模式讲解和代码示例

    外观是一种结构型设计模式, 能为复杂系统、 程序库或框架提供一个简单 (但有限) 的接口,这篇文章就给大家详细介绍一下Golang的外观模式,文中有详细的代码示例,具有一定的参考价值,需要的朋友可以参考下
    2023-06-06
  • 一文详细谈谈GoLang的panic和error

    一文详细谈谈GoLang的panic和error

    说是初识,并不是说第一次使用error和panic包,而是第一次特地去了解golang中的这两个机制,下面这篇文章主要给大家介绍了关于如何通过一文详细谈谈GoLang中panic和error的相关资料,需要的朋友可以参考下
    2022-12-12
  • 一文带你了解Go语言中的类型断言和类型转换

    一文带你了解Go语言中的类型断言和类型转换

    在Go中,类型断言和类型转换是一个令人困惑的事情,他们似乎都在做同样的事情。最明显的不同点是他们具有不同的语法(variable.(type) vs type(variable) )。本文我们就来深入研究一下二者的区别
    2022-09-09

最新评论