Go-Excelize API源码阅读(二十六)——SetSheetName(source, target string)、DuplicateRow(sheet string, row int)

2022-10-25 19:44:19 浏览数 (1)

Go-Excelize API源码阅读(二十六)——SetSheetName(source, target string)、DuplicateRow(sheet string, row int)

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

二、SetSheetName(source, target string)
代码语言:javascript复制
func (f *File) SetSheetName(source, target string)

根据给定的新旧工作表名称重命名工作表。工作表名称最多允许使用 31 个字符,此功能仅更改工作表的名称,而不会更新与单元格关联的公式或引用中的工作表名称。因此使用此功能重命名工作表后可能导致公式错误或参考引用问题。

废话少说,直接上源码:

代码语言:javascript复制
func (f *File) SetSheetName(oldName, newName string) {
	oldName = trimSheetName(oldName)
	newName = trimSheetName(newName)
	if newName == oldName {
		return
	}
	content := f.workbookReader()
	for k, v := range content.Sheets.Sheet {
		if v.Name == oldName {
			content.Sheets.Sheet[k].Name = newName
			f.sheetMap[newName] = f.sheetMap[oldName]
			delete(f.sheetMap, oldName)
		}
	}
}

首先将oldName和newName进行“修剪”:

代码语言:javascript复制
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
}

通过上面的代码可以看出,通过trimSheetName操作我们能够将工作表的name中的:/?*[]去掉。

代码语言:javascript复制
	if newName == oldName {
		return
	}

然后进行比对,如果更改昵称前后一致的话,我们就直接return,结束设置工作表名称操作。

否则:

代码语言:javascript复制
	content := f.workbookReader()
	for k, v := range content.Sheets.Sheet {
		if v.Name == oldName {
			content.Sheets.Sheet[k].Name = newName
			f.sheetMap[newName] = f.sheetMap[oldName]
			delete(f.sheetMap, oldName)
		}
	}

我们会读取工作簿,然后遍历工作簿内的工作表,得到工作表索引和xlsxSheet工作表对象。 可能,这里用k和v可读性不是很好~ 然后比较找到与参数oldName一致的那张表,也就是我们要修改工作表名称的那张表。

然后将定位到的该张表的Name赋值为newName。

同时将oldName工作表映射表给到newName的工作表映射表。 然后从工作表映射表中删除oldName的映射表。

三、DuplicateRow(sheet string, row int)
代码语言:javascript复制
func (f *File) DuplicateRow(sheet string, row int) error

根据给定的工作表名称和行号,在该行后追加复制。例如,将名为 Sheet1 的工作表的第 2 行复制到第 3 行:

代码语言:javascript复制
err := f.DuplicateRow("Sheet1", 2)

请谨慎使用此方法,这将影响所有对该工作表中原有公式、图表等资源引用的更改。如果该工作表包含任何引用值,在使用此方法后使用 Excel 应用程序打开它时将可能导致文件错误。excelize 目前仅支持对工作表上部分引用的更新。

代码语言:javascript复制
func (f *File) DuplicateRow(sheet string, row int) error {
	return f.DuplicateRowTo(sheet, row, row 1)
}

使用的是 DuplicateRowTo ,这里我们直接调用即可。看看该函数的源代码: 该函数根据给定的工作表名称和行号,在指定行后复制该行。

代码语言:javascript复制
func (f *File) DuplicateRowTo(sheet string, row, row2 int) error {
	if row < 1 {
		return newInvalidRowNumberError(row)
	}

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

	if row2 < 1 || row == row2 {
		return nil
	}

	var ok bool
	var rowCopy xlsxRow

	for i, r := range ws.SheetData.Row {
		if r.R == row {
			rowCopy = deepcopy.Copy(ws.SheetData.Row[i]).(xlsxRow)
			ok = true
			break
		}
	}

	if err := f.adjustHelper(sheet, rows, row2, 1); err != nil {
		return err
	}

	if !ok {
		return nil
	}

	idx2 := -1
	for i, r := range ws.SheetData.Row {
		if r.R == row2 {
			idx2 = i
			break
		}
	}
	if idx2 == -1 && len(ws.SheetData.Row) >= row2 {
		return nil
	}

	rowCopy.C = append(make([]xlsxC, 0, len(rowCopy.C)), rowCopy.C...)
	f.adjustSingleRowDimensions(&rowCopy, row2)

	if idx2 != -1 {
		ws.SheetData.Row[idx2] = rowCopy
	} else {
		ws.SheetData.Row = append(ws.SheetData.Row, rowCopy)
	}
	return f.duplicateMergeCells(sheet, ws, row, row2)
}
代码语言:javascript复制
	if row < 1 {
		return newInvalidRowNumberError(row)

	if row2 < 1 || row == row2 {
		return nil
	}

如果要复制的行row小于1,就报错:newInvalidRowNumberError(row) 如果复制目的行小于1或者row与row2相等,我们就返回nil。

代码语言:javascript复制
	var ok bool
	var rowCopy xlsxRow

	for i, r := range ws.SheetData.Row {
		if r.R == row {
			rowCopy = deepcopy.Copy(ws.SheetData.Row[i]).(xlsxRow)
			ok = true
			break
		}
	}

该操作将工作表的所有行进行遍历,找到行数为row的那一行,然后使用deepcopy.Copy进行深拷贝。

代码语言:javascript复制
	if err := f.adjustHelper(sheet, rows, row2, 1); err != nil {
		return err
	}

	if !ok {
		return nil
	}

	idx2 := -1
	for i, r := range ws.SheetData.Row {
		if r.R == row2 {
			idx2 = i
			break
		}
	}
	if idx2 == -1 && len(ws.SheetData.Row) >= row2 {
		return nil
	}

adjustHelper实现在插入或删除行或列时,调整行和列的尺寸、超链接、合并的单元格和自动过滤。

如果前面没有进行deepcopy.Copy,这里就直接return nil。

然后查找到row2对应的索引。 如果找不到并且行数大于row2,idx2就会是-1。

代码语言:javascript复制
	rowCopy.C = append(make([]xlsxC, 0, len(rowCopy.C)), rowCopy.C...)
	f.adjustSingleRowDimensions(&rowCopy, row2)

	if idx2 != -1 {
		ws.SheetData.Row[idx2] = rowCopy
	} else {
		ws.SheetData.Row = append(ws.SheetData.Row, rowCopy)
	}
	return f.duplicateMergeCells(sheet, ws, row, row2)

将rowCopy的C放入一个[]xlsxC切片中,然后使用adjustSingleRowDimensions调整单行尺寸。

代码语言:javascript复制
	if idx2 != -1 {
		ws.SheetData.Row[idx2] = rowCopy
	} else {
		ws.SheetData.Row = append(ws.SheetData.Row, rowCopy)
	}
	return f.duplicateMergeCells(sheet, ws, row, row2)

如果idx2不等于-1,我们就将rowCopy给到idx2的那一行。 如果等于-1,说明没有这一行,那么我们就append进去。

最后使用duplicateMergeCells,如果在复制的行中有单行合并的单元格,则合并目标行中的单元格。

0 人点赞