Go to export excel form

One 、 summary

Use go Implement export excel The table code is relatively fixed , therefore , It can be extracted as a tool function , It is convenient for business layer reuse . Here is a simple encapsulation function , Support setting header 、 The data content , And simple style .

Two 、 Implementation steps

1. Import dependency package

import "github.com/xuri/excelize/v2"

Copy

Choose the mainstream here excel Tool library .

2. Create examples

Function signature ：

func WriteToExcel(headers []string, data [][]interface{}, options ExcelOptions)

Copy

create a file 、 Worksheet ：

file := excelize.NewFile()
sheetIndex := file.NewSheet(sheetName)
file.SetActiveSheet(sheetIndex) //  Default sheet

Copy

SetActiveSheet Used to set the default worksheet .

3. Set the header

//  Set the header 
for i, header := range headers {
   tempColAxis := firstColAxis + int32(i)
   writeCell(file, sheetName, tempColAxis, firstRowAxis, header)
}

Copy

Set cell contents to be encapsulated in sub functions writeCell.

4. Fill in the data

//  Set contents 
for i, line := range data {
   tempRowAxis := firstRowAxis + i + 1
   for j, item := range line {
      tempColAxis := firstColAxis + int32(j)
      writeCell(file, sheetName, tempColAxis, tempRowAxis, item)
   }
}
//  Set cell contents 
func writeCell(file *excelize.File, sheetName string, collAxis int32, rowAxis int,
	value interface{}) {
	err := file.SetCellValue(sheetName, getCellIndex(collAxis, rowAxis), value)
	if err != nil {
		log.LogError("excel set cell value error:%v", err)
	}
}
//  Get cell subscript 
func getCellIndex(colAxis int32, rowAxis int) string {
	return fmt.Sprintf("%c%d", colAxis, rowAxis)
}

Copy

SetCellValue： The subscript of the filled cell , List subscripts first , Re subscript . for example , First row, first column ：A1, The second row, the third column ：C2.

5. Set the style

//  Set the style 
func setStyle(file *excelize.File, sheetName string, maxCol int32, options ExcelOptions) {
   err := file.SetColWidth(sheetName, string(firstColAxis), string(maxCol), options.ColWidth) //  Set column width 
   if err != nil {
      log.LogError("excel SetColWidth error:%v", err)
   }
   err = file.SetRowHeight(sheetName, firstRowAxis, options.RowHeight) //  Set row height 
   if err != nil {
      log.LogError("excel SetRowHeight error:%v", err)
   }
   style := &excelize.Style{
      Font: &excelize.Font{
         Bold: true,
      },
   }
   styleId, err := file.NewStyle(style)
   if err != nil {
      log.LogError("excel NewStyle error:%v", err)
   }
   err = file.SetCellStyle(sheetName, getCellIndex(firstColAxis, firstRowAxis), getCellIndex(maxCol, maxRow),
      styleId)
   if err != nil {
      log.LogError("excel SetCellStyle error:%v", err)
   }
}

Copy

SetColWidth： Set column width , You need to specify the start and end columns .

SetRowHeight： Set row height , Here, set the row height of the header .

NewStyle： Definition of style .

SetCellStyle： For the specified area , Set cell style .

6. Write output stream

file.Write(httpWriter) 

Copy

Set here to http Output stream , If you write a local file, you can output it to a file , It's not commonly used .

3、 ... and 、 Be careful

1. adopt http export , Pay attention to the setting header.

Content-Disposition: fmt.Sprintf(`attachment; filename="%s"`, fileName)
Content-Type: application/vnd.ms-excel

Copy

2. Pay attention to setting style , Which styles can be used in what range , Styles don't work mostly because they are given to objects （ Such as cell ） Set a style that cannot be set to cells , For example, row height .