go语言中使用excel template模板替换生成报表

作者: adm 分类: go 发布时间: 2023-07-29

最近要实现一个生成excel的报表服务,具体要实现的报表样子大概如下(暂时忽略样式Freezing):

功能描述
如上图所示,要实现这样一个报表每一个sheet中按照周去展示,每一周中显示对应的日、周、月、未执行的服务,并且标上执行人,而且对于不同时期的版本要记录不同的sheet

如果对应程序的角度,每个sheet中要循环周数据,每一周中对应的服务要各自循环输出每一个项目,对于单个excel文件要循环输出多个sheet。

循环套循环…,考虑到如果有这样一个模板文件支持特定标识符的内嵌,然后程序可以根据这些标识符输出对应的excel,功能就实现了。

功能实现
在github中发现了这样一个repo, github.com/ivahaev/go-xlsx-templater 的go语言实现库

Simple .xlsx (Excel XML document) template based document generator using handlebars.

Takes input .xlsx documents with mustache sippets in it and renders new document with snippets replaced by provided context.

Thanks to github.com/tealeg/xlsx and github.com/aymerick/raymond for useful libs

可以看到里边用到了 tealeg/xlsx 和 aymerick/raymod 这两个包,第一个是go语言实现的excel库,第二个是对于template的解析

具体的介绍可以去这两个包对应的repo中了解,这里就不在描述了。

使用方式也很简单

1. 预加载模板

2. 渲染(拷贝)

ctx := map[string]interface{}{
        "name": "Github User",
        "groupHeader": "Group name",
        "nameHeader": "Item name",
        "quantityHeader": "Quantity",
        "groups": []map[string]interface{}{
            {
                "name":  "Work",
                "total": 3,
                "items": []map[string]interface{}{
                    {
                        "name":     "Pen",
                        "quantity": 2,
                    },
                    {
                        "name":     "Pencil",
                        "quantity": 1,
                    },
                },
            },
            {
                "name":  "Weekend",
                "total": 36,
                "items": []map[string]interface{}{
                    {
                        "name":     "Condom",
                        "quantity": 12,
                    },
                    {
                        "name":     "Beer",
                        "quantity": 24,
                    },
                },
            },
        },
    }

3. 输出文件

 doc := xlst.New()
 doc.ReadTemplate("./template.xlsx")
 doc.Render(ctx) 4 doc.Save("./report.xlsx")

要实现文中开始描述的报表功能还需要修改package的源码,主要解决的问题是

当前的代码template包不支持一个数据集合输出多个sheet,当前支持的是按照模板文件中的sheet分别渲染。
当excel模板中cell设置了文字换行和高度自动适应时,输出的excel报表中文字会被遮盖。
不支持打印分隔符

   // RenderMultipleSheet 输出多个sheet
   func (m *Xlst) RenderMultipleSheet(options *Options ,in ...InParam) error {
   	if options == nil {
   		options = new(Options)
   	}
   	report := xlsx.NewFile()
   	//TODO: 模板中只考虑单个sheet
   	for si, sheet := range m.file.Sheets {
   		for idx,item:=range in{
  			ctx := getCtx(item.In, si)
  			if item.SheetName==""{
  				report.AddSheet(fmt.Sprintf("Sheet%d",idx))
  			}else{
  				_,e:=report.AddSheet(item.SheetName)
  				if e!=nil{
  					fmt.Errorf("%+v",e)
  				}
  			}
  			l:=len(report.Sheets)
 			fmt.Printf("%d",l)
  			cloneSheet(sheet, report.Sheets[idx])
  			err := renderRows(report.Sheets[idx], sheet.Rows, ctx, options)
  			if err != nil {
  				return err
  			}
  
 			for _, col := range sheet.Cols {
  				report.Sheets[idx].Cols = append(report.Sheets[idx].Cols, col)
  			}
  		}
  
  	}
 	m.report = report
 	return nil
  }
   //xlst
   // 高度自适应修改
   //to.SetHeight(from.Height)

打印分隔符的支持,我参考了 360EntSecGroup-Skylar/excelize包的实现(对应 InsertBreakPage),将打印分隔符相关的struct xml字段和方法迁移到了 tealeg/xlsx 库中,东拼西凑的感觉Sad smile。

   type Sheet struct {
   	Name        string
   	File        *File
   	Rows        []*Row
  	Cols        []*Col
  	MaxRow      int
   	MaxCol      int
   	Hidden      bool
   	Selected    bool
  	SheetViews  []SheetView
  	SheetFormat SheetFormat
  	AutoFilter  *AutoFilter
  	// 加入 分页符
  	RowBreaks       *XlsxBreaks
  	ColBreaks       *XlsxBreaks
  }

我的模板文件:

如果觉得我的文章对您有用,请随意赞赏。您的支持将鼓励我继续创作!