Go-Excelize API源码阅读（三十四）——RemoveRow

Go-Excelize API源码阅读（三十四）——RemoveRow

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

二、RemoveRow

func (f *File) RemoveRow(sheet string, row int) error
根据给定的工作表名称和行号删除指定行。例如，删除名为 Sheet1 的第 3 行：
err := f.RemoveRow("Sheet1", 3)
请谨慎使用此方法，这将影响所有对该工作表中原有公式、图表等资源引用的更改。如果该工作表包含任何引用值，在使用此方法后使用 Excel 应用程序打开它时将可能导致文件错误。Excelize 目前仅支持对工作表上部分引用的更新。

直接来看源码：

// RemoveRow provides a function to remove single row by given worksheet name
// and Excel row number. For example, remove row 3 in Sheet1:
//
//    err := f.RemoveRow("Sheet1", 3)
//
// Use this method with caution, which will affect changes in references such
// as formulas, charts, and so on. If there is any referenced value of the
// worksheet, it will cause a file error when you open it. The excelize only
// partially updates these references currently.
func (f *File) RemoveRow(sheet string, row int) error {
	if row < 1 {
		return newInvalidRowNumberError(row)
	}

	ws, err := f.workSheetReader(sheet)
	if err != nil {
		return err
	}
	if row > len(ws.SheetData.Row) {
		return f.adjustHelper(sheet, rows, row, -1)
	}
	keep := 0
	for rowIdx := 0; rowIdx < len(ws.SheetData.Row); rowIdx++ {
		v := &ws.SheetData.Row[rowIdx]
		if v.R != row {
			ws.SheetData.Row[keep] = *v
			keep++
		}
	}
	ws.SheetData.Row = ws.SheetData.Row[:keep]
	return f.adjustHelper(sheet, rows, row, -1)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

	if row < 1 {
		return newInvalidRowNumberError(row)
	}
1
2
3

如果参数的行数row小于1，我们就返回newInvalidRowNumberError：

	ws, err := f.workSheetReader(sheet)
	if err != nil {
		return err
	}
1
2
3
4

读取工作表，获取工作表对象，如果err不为空，则返回err。

	if row > len(ws.SheetData.Row) {
		return f.adjustHelper(sheet, rows, row, -1)
	}
1
2
3

如果参数row大于工作表的行数，就执行File类型的adjustHelper方法：

该方法能够在插入或删除行或列时，调整行和列的尺寸、超链接、合并的单元格和自动过滤。
也就是不执行后续的删除操作，直接调整。
下面是重点代码段：

遍历工作表的行切片，得到行对象的指针。
然后判断行对象的R属性，即当前行数是否与我们要找的行数row相等：
如果不等，我们就将当前的行对象放入Row切片，索引keep加一。
这样的目的是将所有行对象放入Row切片，除了行数为row的对象。
最后，再截取去掉最后一个冗余元素。
妙~~啊

结语

这是Excelize API阅读的第三十四篇，鉴于本人技术水平有限，如有错误，烦请指出斧正！感谢！