Go-Excelize API源码阅读三十—— SearchSheet(sheet, value string, reg ...bool)

Go-Excelize API源码阅读（三十）—— SearchSheet(sheet, value string, reg …bool)

开源摘星计划（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 或更高版本。

二、SearchSheet(sheet, value string, reg …bool)

func (f *File) SearchSheet(sheet, value string, reg ...bool) ([]string, error)

根据给定的工作表名称，单元格值或正则表达式来获取坐标。此函数仅支持字符串和数字的完全匹配，不支持公式计算后的结果、格式化数字和条件搜索。如果搜索结果是合并的单元格，将返回合并区域左上角的坐标。

例如，在名为 Sheet1 的工作表中搜索值 100 的坐标:

result, err := f.SearchSheet("Sheet1", "100")

例如，在名为 Sheet1 的工作表中搜索 0-9 范围内数值的坐标:

result, err := f.SearchSheet("Sheet1", "[0-9]", true)

然后我们来直接看看源码：

func (f *File) SearchSheet(sheet, value string, reg ...bool) ([]string, error) {
	var (
		regSearch bool
		result    []string
	)
	for _, r := range reg {
		regSearch = r
	}
	name, ok := f.sheetMap[trimsheetName(sheet)]
	if !ok {
		return result, ErrSheetNotExist{sheet}
	}
	if ws, ok := f.Sheet.Load(name); ok && ws != nil {
		// flush data
		output, _ := xml.Marshal(ws.(*xlsxWorksheet))
		f.saveFileList(name, f.replaceNameSpaceBytes(name, output))
	}
	return f.searchSheet(name, value, regSearch)
}

先看第一部分：

	var (
		regSearch bool
		result    []string
	)
	for _, r := range reg {
		regSearch = r
	}

设置bool类型变量regSearch 、[]string变量result。然后遍历reg，获取其所有bool值，然后赋值给regSearch。根据代码，似乎regSearch 的值是最后一个参数的bool值。

	name, ok := f.sheetMap[trimsheetName(sheet)]
	if !ok {
		return result, ErrSheetNotExist{sheet}
	}

然后在工作表映射中查找名字为sheet的工作表。这里使用trimsheetName对工作表名进行了处理：

// trimsheetName provides a function to trim invalid characters by given worksheet
// name.
func trimsheetName(name string) string {
	if strings.ContainsAny(name, ":\\/?*[]") || utf8.RuneCountInString(name) > 31 {
		r := make([]rune, 0, 31)
		for _, v := range name {
			switch v {
			case 58, 92, 47, 63, 42, 91, 93: // replace :\/?*[]
				continue
			default:
				r = append(r, v)
			}
			if len(r) == 31 {
				break
			}
		}
		name = string(r)
	}
	return name
}

将工作表名字中的:\/?*[]字符进行删除。再看第三部分：

	if ws, ok := f.Sheet.Load(name); ok && ws != nil {
		// flush data
		output, _ := xml.Marshal(ws.(*xlsxWorksheet))
		f.saveFileList(name, f.replaceNameSpaceBytes(name, output))
	}
	return f.searchSheet(name, value, regSearch)

此处和前面说的一样，加载工作表，如果加载成功，ok为true，否则返回false。加载成功之后，我们就会将ws使用类型断言成为xlsxWorksheet类型。

该断言表达式会返回 ws 的值和一个布尔值，可根据该布尔值判断 x 是否为 T 类型（此处为xlsxWorksheet）：如果 T 是具体某个类型，类型断言会检查 x 的动态类型是否等于具体类型 T。如果检查成功，类型断言返回的结果是 x 的动态值，其类型是 T。如果 T 是接口类型，类型断言会检查 x 的动态类型是否满足 T。如果检查成功，x 的动态值不会被提取，返回值是一个类型为 T 的接口值。无论 T 是什么类型，如果 x 是 nil 接口值，类型断言都会失败。

也可以省略布尔值，直接返回一个值，此处为worksheet。

然后将参数传到searchSheet()。

func (f *File) searchSheet(name, value string, regSearch bool) (result []string, err error) {
	var (
		cellName, inElement string
		cellCol, row        int
		d                   *xlsxsst
	)

	d = f.sharedStringsReader()
	decoder := f.xmlNewDecoder(bytes.NewReader(f.readBytes(name)))
	for {
		var token xml.Token
		token, err = decoder.Token()
		if err != nil || token == nil {
			if err == io.EOF {
				err = nil
			}
			break
		}
		switch xmlElement := token.(type) {
		case xml.StartElement:
			inElement = xmlElement.Name.Local
			if inElement == "row" {
				row, err = attrValToInt("r", xmlElement.Attr)
				if err != nil {
					return
				}
			}
			if inElement == "c" {
				colCell := xlsxC{}
				_ = decoder.DecodeElement(&colCell, &xmlElement)
				val, _ := colCell.getValueFrom(f, d, false)
				if regSearch {
					regex := regexp.MustCompile(value)
					if !regex.MatchString(val) {
						continue
					}
				} else {
					if val != value {
						continue
					}
				}
				cellCol, _, err = CellNametoCoordinates(colCell.R)
				if err != nil {
					return result, err
				}
				cellName, err = CoordinatesToCellName(cellCol, row)
				if err != nil {
					return result, err
				}
				result = append(result, cellName)
			}
		default:
		}
	}
	return
}

该函数通过给定的工作表名称、单元格值和正则表达式获得坐标。

Go-Excelize API源码阅读三十—— SearchSheet(sheet, value string, reg ...bool)