Go-Excelize API源码阅读（二十一）——GetDefinedName()、DeleteDefinedName()

Regan Yue

发布于 2022-09-23 10:07:50

2420

发布于 2022-09-23 10:07:50

文章被收录于专栏：ReganYue's Blog

Go-Excelize API源码阅读（二十）——GetDefinedName()

开源摘星计划（WeOpen Star）是由腾源会 2022 年推出的全新项目，旨在为开源人提供成长激励，为开源项目提供成长支持，助力开发者更好地了解开源，更快地跨越鸿沟，参与到开源的具体贡献与实践中。

不管你是开源萌新，还是希望更深度参与开源贡献的老兵，跟随“开源摘星计划”开启你的开源之旅，从一篇学习笔记、到一段代码的提交，不断挖掘自己的潜能，最终成长为开源社区的“闪亮之星”。

我们将同你一起，探索更多的可能性！

项目地址： WeOpen-Star：https://github.com/weopenprojects/WeOpen-Star

一、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]后面。