Go-Excelize API 源码阅读（二十）——SetDefinedName
一、Go-Excelize 简介
Excelize 是 Go 语言编写的用于操作 Office Excel 文档基础库，基于 ECMA-376，ISO/IEC 29500 国际标准。可以使用它来读取、写入由 Microsoft Excel™ 2007 及以上版本创建的电子表格文档。支持 XLAM / XLSM / XLSX / XLTM / XLTX 等多种文档格式，高度兼容带有样式、图片(表)、透视表、切片器等复杂组件的文档，并提供流式读写 API，用于处理包含大规模数据的工作簿。可应用于各类报表平台、云计算、边缘计算等系统。使用本类库要求使用的 Go 语言为 1.15 或更高版本。
二、 SetDefinedName
func (f *File) SetDefinedName(definedName *DefinedName) error
复制代码
根据给定的名称和引用区域设置名称，默认范围是工作簿。例如：
f.SetDefinedName(&excelize.DefinedName{ Name: "Amount", RefersTo: "Sheet1!$A$2:$D$5", Comment: "defined name comment", Scope: "Sheet2",})
复制代码
工作表的打印区域和打印标题设置:
f.SetDefinedName(&excelize.DefinedName{ Name: "_xlnm.Print_Area", RefersTo: "Sheet1!$A$1:$Z$100", Scope: "Sheet1",})f.SetDefinedName(&excelize.DefinedName{ Name: "_xlnm.Print_Titles", RefersTo: "Sheet1!$A:$A,Sheet1!$1:$1", Scope: "Sheet1",})
复制代码
上面的代码就是实现的下列操作：
废话少说，下面直接上源码：
func (f *File) SetDefinedName(definedName *DefinedName) error { wb := f.workbookReader() d := xlsxDefinedName{ Name: definedName.Name, Comment: definedName.Comment, Data: definedName.RefersTo, } if definedName.Scope != "" { if sheetIndex := f.GetSheetIndex(definedName.Scope); sheetIndex >= 0 { d.LocalSheetID = &sheetIndex } } if wb.DefinedNames != nil { for _, dn := range wb.DefinedNames.DefinedName { var scope string if dn.LocalSheetID != nil { scope = f.GetSheetName(*dn.LocalSheetID) } if scope == definedName.Scope && dn.Name == definedName.Name { return ErrDefinedNameDuplicate } } wb.DefinedNames.DefinedName = append(wb.DefinedNames.DefinedName, d) return nil } wb.DefinedNames = &xlsxDefinedNames{ DefinedName: []xlsxDefinedName{d}, } return nil}
复制代码
wb := f.workbookReader() d := xlsxDefinedName{ Name: definedName.Name, Comment: definedName.Comment, Data: definedName.RefersTo, }
复制代码
这段代码先是读取工作簿，然后使用参数 definedName 里面的 Name、Comment、RefersTo 创建一个 xlsxDefinedName 结构体。
if definedName.Scope != "" { if sheetIndex := f.GetSheetIndex(definedName.Scope); sheetIndex >= 0 { d.LocalSheetID = &sheetIndex } }
复制代码
如果 definedName.Scope 不为空，就去获取 definedName.Scope 所指工作表的索引，如果工作表索引大于等于 0，说明索引合法，就将该索引赋给之前新建的 xlsxDefinedName 结构体。
if wb.DefinedNames != nil { for _, dn := range wb.DefinedNames.DefinedName { var scope string if dn.LocalSheetID != nil { scope = f.GetSheetName(*dn.LocalSheetID) } if scope == definedName.Scope && dn.Name == definedName.Name { return ErrDefinedNameDuplicate } } wb.DefinedNames.DefinedName = append(wb.DefinedNames.DefinedName, d) return nil } wb.DefinedNames = &xlsxDefinedNames{ DefinedName: []xlsxDefinedName{d}, } return nil
复制代码
如果工作簿 DefinedNames 成员不为空，就遍历 wb.DefinedNames.DefinedName。
type xlsxDefinedNames struct { DefinedName []xlsxDefinedName `xml:"definedName"`}
复制代码
xlsxDefinedNames 直接映射 definedNames 元素。 此元素定义此工作簿的已定义名称的集合。 定义的名称是表示单元格、单元格区域、公式或常数值的描述性名称。 定义的名称可用于表示任何工作表上的范围。
对遍历得到的每一个 DefinedName 元素，我们命名为 dn。如果 dn 的 LocalSheetID 不为空，就根据工作表 ID 获取其工作表名称。如果 scope 和 name 都已经存在了，就报错：
如果不存在，就把 d append 到 wb.DefinedNames.DefinedName 内。
如果 wb.DefinedNames 为空，说明队列不存在，我们直接新建然后放入即可。
三、结语
这里是老岳，这是 Go 语言相关源码的解读第二十篇，我会不断努力，给大家带来更多类似的文章，恳请大家不吝赐教。
评论