Go結合反射將結構體轉換成Excel的過程詳解

Posted on by

Excel中的一些概念

一個excel文件中可以包含多個sheet，一個sheet可以理解成一個表格

表格的每一行稱為 Row

表格的每一行中的任意一個單元格稱為 Cell

使用tealeg操作Excel

安裝tealeg

go get github.com/tealeg/xlsx

使用tealeg新建一個表格

tealeg提供瞭傻瓜式API，主要流程為創建一個Sheet，在Sheet中添加Row，然後在Row中添加每個單元格的值，最終持久化到磁盤。

func TestTealeg(t *testing.T) {
	excel := xlsx.NewFile()

	// 新建一個sheet
	sheet, err := excel.AddSheet("Sheet1")
	if err != nil {
		t.Fatal(err)
	}

	// 創建首行
	headerRow := sheet.AddRow()

	// 設置行高
	headerRow.SetHeightCM(0.5)

	// 填充行中的單元格
	headerRow.AddCell().Value = "姓名"
	headerRow.AddCell().Value = "年齡"

	valList := [][]string{
		{"張三", "13"},
		{"李四", "14"},
		{"王五", "15"},
	}

	for _, line := range valList {
		row := sheet.AddRow()
		row.SetHeightCM(0.5)
		for _, v := range line {
			row.AddCell().Value = v
		}
	}

	// 持久化到磁盤
	if err := excel.Save("username.xlsx"); err != nil {
		t.Fatal(err)
	}
}

執行這個Test用例後，在項目的當前文件夾中會出現一個username.xlsx的表格，內容和前面介紹的excel概念中使用的表格是一個。

Go結合反射將結構體轉換成Excel

  • 大概思路是在Go的結構體中每個屬性打上一個excel標簽
  • 利用反射獲取標簽中的內容，作為表格的Header
  • 利用反射獲取Go結構體中的屬性的值，組成一個map，key為從標簽中excel反射獲取的值，val為結構體屬性具體的值，map的偽代碼如下：map[excelTag]strucVal 類型為map[string]string。
  • 如果一個array或者slice中的結構體需要轉換成excel，那麼隻需要將每個元素轉換成第 3 步提到的map作為一行，組成一個[]map[excelTag]strucVal然後遍歷這個切片，追加到表格中即可。

反射獲取每個Struct中的Tag

func getStructTagList(v interface{}, tag string) []string {
	var resList []string
	if v == nil {
		return resList
	}
	var item interface{}
	switch reflect.TypeOf(v).Kind() {
	case reflect.Slice, reflect.Array:
		values := reflect.ValueOf(v)
		if values.Len() == 0 {
			return resList
		}
		item = values.Index(0).Interface()
	case reflect.Struct:
		item = reflect.ValueOf(v).Interface()
	default:
		panic(fmt.Sprintf("type %v not support", reflect.TypeOf(v).Kind()))
	}
	typeOf := reflect.TypeOf(item)
	fieldNum := typeOf.NumField()
	for i := 0; i < fieldNum; i++ {
		resList = append(resList, typeOf.Field(i).Tag.Get(tag))
	}
	return resList
}

通過反射將結構體的值轉換成map[excelTag]strucVal

func getTagValMap(v interface{}, tag string) map[string]string {
	resMap := make(map[string]string)
	if v == nil {
		return resMap
	}
	typeOf := reflect.TypeOf(v)
	fieldNum := typeOf.NumField()
	for i := 0; i < fieldNum; i++ {
		structField := typeOf.Field(i)
		tagValue := structField.Tag.Get(tag)
		val := reflect.ValueOf(v).FieldByName(structField.Name)
		resMap[tagValue] = fmt.Sprintf("%v", val.Interface())
	}
	return resMap
}

利用反射將一個Silce，Array或者Struct轉換成[]map[excelTag]strucVal

func struct2MapTagList(v interface{}, tag string) []map[string]string {
	var resList []map[string]string
	switch reflect.TypeOf(v).Kind() {
	case reflect.Slice, reflect.Array:
		values := reflect.ValueOf(v)
		for i := 0; i < values.Len(); i++ {
			resList = append(resList, getTagValMap(values.Index(i).Interface(), tag))
		}
		break
	case reflect.Struct:
		val := reflect.ValueOf(v).Interface()
		resList = append(resList, getTagValMap(val, tag))
		break
	default:
		panic(fmt.Sprintf("type %v not support", reflect.TypeOf(v).Kind()))
	}
	return resList
}

通過tealeg將[]map[excelTag]strucVal轉換成Excel

通過上面兩步，已經可以將一個結構體，切片或者list轉換成瞭一個[]map[excelTag]strucVal類型的切片，下面我們隻需要調用tealeg轉換成excel

func Struct2Xlsx(v interface{}) (*xlsx.File, error) {
	var tag = "excel"
	tagList := getStructTagList(v, tag)
	mapTagList := struct2MapTagList(v, tag)
	excelFile := xlsx.NewFile()
	sheet, err := excelFile.AddSheet("Sheet1")
	if err != nil {
		return nil, err
	}
	headerRow := sheet.AddRow()
	for _, tagVal := range tagList {
		headerRow.SetHeightCM(0.5)
		headerRow.AddCell().Value = tagVal
	}
	for _, mapTagVal := range mapTagList {
		row := sheet.AddRow()
		for _, tagVal := range tagList {
			row.SetHeightCM(0.5)
			row.AddCell().Value = mapTagVal[tagVal]
		}
	}
	return excelFile, nil
}

運行測試用例驗證

type Username struct {
	Name string `excel:"姓名"`
	Age  int    `excel:"年齡"`
}

func TestStruct2Excet(t *testing.T) {
	var data = []Username{
		{
			Name: "張三",
			Age:  13,
		},
		{
			Name: "李四",
			Age:  14,
		},
		{
			Name: "王五",
			Age:  15,
		},
	}
	excel, err := Struct2Xlsx(data)
	if err != nil {
		t.Fatal(err)
	}
	if err := excel.Save("username.xlsx"); err != nil {
		t.Fatal(err)
	}
}

測試運行成功後，會在項目目錄創建一個username.xlsx的文件，這個文件就是我們的結構體轉換成excel的結果

到此這篇關於Go結合反射將結構體轉換成Excel的過程詳解的文章就介紹到這瞭,更多相關Go結構體轉換成Exce內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：