Go-Excelize API 源码阅读（二十一）——GetDefinedName()、DeleteDefinedName()
一、Go-Excelize 简介
Excelize 是 Go 语言编写的用于操作 Office Excel 文档基础库，基于 ECMA-376，ISO/IEC 29500 国际标准。可以使用它来读取、写入由 Microsoft Excel™ 2007 及以上版本创建的电子表格文档。支持 XLAM / XLSM / XLSX / XLTM / XLTX 等多种文档格式，高度兼容带有样式、图片(表)、透视表、切片器等复杂组件的文档，并提供流式读写 API，用于处理包含大规模数据的工作簿。可应用于各类报表平台、云计算、边缘计算等系统。使用本类库要求使用的 Go 语言为 1.15 或更高版本。
二、 GetDefinedName()
func (f *File) GetDefinedName() []DefinedName
复制代码
获取作用范围内的工作簿和工作表的名称列表。
废话少说，我们来看一看源代码：
// GetDefinedName provides a function to get the defined names of the workbook// or worksheet.func (f *File) GetDefinedName() []DefinedName { var definedNames []DefinedName wb := f.workbookReader() if wb.DefinedNames != nil { for _, dn := range wb.DefinedNames.DefinedName { definedName := DefinedName{ Name: dn.Name, Comment: dn.Comment, RefersTo: dn.Data, Scope: "Workbook", } if dn.LocalSheetID != nil && *dn.LocalSheetID >= 0 { definedName.Scope = f.GetSheetName(*dn.LocalSheetID) } definedNames = append(definedNames, definedName) } } return definedNames}
复制代码
该函数先是定义一个 DefinedName 数组，然后读取工作簿的 DefinedNames 看其是不是为空。
如果不为空，就遍历 wb.DefinedNames.DefinedName ，然后生成 DefinedName 结构体，其 Name、Comment、RefersTo 都是遍历 wb.DefinedNames.DefinedName 得到的 dn 现成的。而 Scope 则是设置为"Workbook"。
if dn.LocalSheetID != nil && *dn.LocalSheetID >= 0 { definedName.Scope = f.GetSheetName(*dn.LocalSheetID)}
复制代码
如果遍历得到的 dn 的 LocalSheetID 不为空，并且*dn.LocalSheetID 大于等于 0，即其指向的 DefinedName 的工作表 ID 大于或等于 0。那么我们就获取这张工作表的名字作为 definedName 的作用域 Scope。
definedNames = append(definedNames, definedName)
复制代码
最后将 definedName 放入之前定义的 definedNames 中，然后返回该数组即可。
三、DeleteDefinedName()
func (f *File) DeleteDefinedName(definedName *DefinedName) error
复制代码
根据给定的名称和名称作用范围删除已定义的名称，默认名称的作用范围为工作簿。例如：
f.DeleteDefinedName(&excelize.DefinedName{ Name: "Amount", Scope: "Sheet2",})
复制代码
废话少说，我们直接来看代码：
// DeleteDefinedName provides a function to delete the defined names of the// workbook or worksheet. If not specified scope, the default scope is// workbook. For example://// f.DeleteDefinedName(&excelize.DefinedName{// Name: "Amount",// Scope: "Sheet2",// })//func (f *File) DeleteDefinedName(definedName *DefinedName) error { wb := f.workbookReader() if wb.DefinedNames != nil { for idx, dn := range wb.DefinedNames.DefinedName { scope := "Workbook" deleteScope := definedName.Scope if deleteScope == "" { deleteScope = "Workbook" } if dn.LocalSheetID != nil { scope = f.GetSheetName(*dn.LocalSheetID) } if scope == deleteScope && dn.Name == definedName.Name { wb.DefinedNames.DefinedName = append(wb.DefinedNames.DefinedName[:idx], wb.DefinedNames.DefinedName[idx+1:]...) return nil } } } return ErrDefinedNameScope}
复制代码
先是判断 wb.DefinedNames 是不是为空，即查看是否有已定义的名称，如果没有就删除不了。
然后遍历 wb.DefinedNames.DefinedName，即遍历这些已定义的名称。
如果 deleteScope 即传来的参数的 Scope——definedName.Scope 为空，就将作用范围设置为工作簿"Workbook"。如果工作表 ID dn.LocalSheetID 不为空，我们就将其工作表名称作为 Scope。
if scope == deleteScope && dn.Name == definedName.Name {wb.DefinedNames.DefinedName = append(wb.DefinedNames.DefinedName[:idx], wb.DefinedNames.DefinedName[idx+1:]...)return nil}
复制代码
然后如果作用域 scope 是等于 deleteScope，并且遍历的 dn.Name 等于参数中的 definedName.Name，我们就使用 append 将 wb.DefinedNames.DefinedName 下标 idx 后面的元素全部接到 wb.DefinedNames.DefinedName[:idx]后面。
如果作用范围已定义的元素为空就会返回上面的错误。
三、结语
这里是老岳，这是 Go 语言相关源码的解读第二十一篇，我会不断努力，给大家带来更多类似的文章，恳请大家不吝赐教。
评论