Go-Excelize API源码阅读（二十九）—— Rows(sheet string)

Go-Excelize API源码阅读（二十九）—— Rows(sheet string)

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

二、Rows(sheet string)

func (f *File) Rows(sheet string) (*Rows, error) 根据给定的工作表名称获取该工作表的行迭代器。此功能是并发安全的。使用行迭代器进行流式读取遍历单元格： 下面看一个使用该API的例子。

rows, err := f.Rows("Sheet1")
if err != nil {
    fmt.Println(err)
    return
}
for rows.Next() {
    row, err := rows.Columns()
    if err != nil {
        fmt.Println(err)
    }
    for _, colCell := range row {
        fmt.Print(colCell, "\t")
    }
    fmt.Println()
}
if err = rows.Close(); err != nil {
    fmt.Println(err)
}

我们可以通过代码了解该API：

func (f *File) Rows(sheet string) (*Rows, error) {
	name, ok := f.sheetMap[trimSheetName(sheet)]
	if !ok {
		return nil, ErrSheetNotExist{sheet}
	}
	if ws, ok := f.Sheet.Load(name); ok && ws != nil {
		worksheet := ws.(*xlsxWorksheet)
		worksheet.Lock()
		defer worksheet.Unlock()
		// flush data
		output, _ := xml.Marshal(worksheet)
		f.saveFileList(name, f.replaceNameSpaceBytes(name, output))
	}
	var err error
	rows := Rows{f: f, sheet: name}
	rows.needClose, rows.decoder, rows.tempFile, err = f.xmlDecoder(name)
	return &rows, err
}

先来看第一部分：

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

先从工作表映射sheetMap中查找工作表，如果创建失败返回ErrSheetNotExist{sheet}。

type ErrSheetNotExist struct {
	SheetName string
}

func (err ErrSheetNotExist) Error() string {
	return fmt.Sprintf("sheet %s is not exist", err.SheetName)
}

会输出sheet 工作表名 is not exist。

	if ws, ok := f.Sheet.Load(name); ok && ws != nil {
		worksheet := ws.(*xlsxWorksheet)
		worksheet.Lock()
		defer worksheet.Unlock()
		// flush data
		output, _ := xml.Marshal(worksheet)
		f.saveFileList(name, f.replaceNameSpaceBytes(name, output))
	}

然后加载工作表，如果加载成功，ok为true，否则返回false。 加载成功之后，我们就会将ws使用类型断言成为xlsxWorksheet类型。 该断言表达式会返回 ws 的值和一个布尔值，可根据该布尔值判断 x 是否为 T 类型（此处为xlsxWorksheet）： 如果 T 是具体某个类型，类型断言会检查 x 的动态类型是否等于具体类型 T。如果检查成功，类型断言返回的结果是 x 的动态值，其类型是 T。 如果 T 是接口类型，类型断言会检查 x 的动态类型是否满足 T。如果检查成功，x 的动态值不会被提取，返回值是一个类型为 T 的接口值。 无论 T 是什么类型，如果 x 是 nil 接口值，类型断言都会失败。

也可以省略布尔值，直接返回一个值，此处为worksheet。 然后给worksheet加上锁，所以有之前API描述所说的并发安全。 然后对worksheet进行xml序列化操作，并使用replaceNameSpaceBytes通过给定的组件部分路径和XML内容替换XML根元素属性，然后再更新电子表格的文件列表中的指定文件内容。

接下来看最后一部分代码：

	var err error
	rows := Rows{f: f, sheet: name}
	rows.needClose, rows.decoder, rows.tempFile, err = f.xmlDecoder(name)
	return &rows, err

其还有如下几种操作：

建立一个Rows对象，然后解码之前保存的xml文件，然后将内容存入rows中。 返回&rows即可。

行迭代器 - 单行操作 func (rows *Rows) Columns(opts …Options) ([]string, error) 此函数流式逐行读取工作表，返回当前行中各列单元格的值，不会跳过工作表尾部的有效空白行。

行迭代器 - 遍历操作 func (rows *Rows) Next() bool 如果下一行有值存在将返回 true。

行迭代器 - 错误处理 func (rows *Rows) Error() error 当查找下一行出现错误时将返回 error。

行迭代器 - 读取行属性 func (rows *Rows) GetRowOpts() RowOpts 返回当前行的行高、可见性和样式 ID 属性。

行迭代器 - 关闭数据流 func (rows *Rows) Close() error 关闭数据流并清理打开工作表时可能产生的系统磁盘缓存。

三、总结

通过此篇文章，我们可以掌握此API的代码逻辑，顺带可以掌握类型断言、xml序列化操作等操作的基本用法。