Go-Excelize API源码阅读（九）——SetSheetBackground(sheet, picture string)

Go-Excelize API源码阅读（九）——SetSheetBackground(sheet, picture 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 或更高版本。

二、SetSheetBackground(sheet, picture string)

func (f *File) SetSheetBackground(sheet, picture string) error
1

根据给定的工作表名称和图片地址为指定的工作表设置平铺效果的背景图片。

看到这个API的功能，我还有点不敢相信，应该很少有人知道工作表能够设置背景图片的吧。

这效果是不是酷毙了~

废话少说，看看这个API是怎么实现的！

// SetSheetBackground provides a function to set background picture by given
// worksheet name and file path.
func (f *File) SetSheetBackground(sheet, picture string) error {
	var err error
	// Check picture exists first.
	if _, err = os.Stat(picture); os.IsNotExist(err) {
		return err
	}
	ext, ok := supportedImageTypes[path.Ext(picture)]
	if !ok {
		return ErrImgExt
	}
	file, _ := ioutil.ReadFile(filepath.Clean(picture))
	name := f.addMedia(file, ext)
	sheetRels := "xl/worksheets/_rels/" + strings.TrimPrefix(f.sheetMap[trimSheetName(sheet)], "xl/worksheets/") + ".rels"
	rID := f.addRels(sheetRels, SourceRelationshipImage, strings.Replace(name, "xl", "..", 1), "")
	f.addSheetPicture(sheet, rID)
	f.addSheetNameSpace(sheet, SourceRelationship)
	f.setContentTypePartImageExtensions()
	return err
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

下面这一步是检查文件路径的图片是否存在。

	if _, err = os.Stat(picture); os.IsNotExist(err) {
		return err
	}
1
2
3

这种方法可以说比较巧妙了，看能不能获取picture的文件信息，如果不能就会报错，然后看报错。
这个os.Stat()返回的err比较特别。

1、如果返回的错误为nil,说明文件或文件夹不存在或者没有权限
2、如果返回的错误类型使用os.IsNotExist()判断为true,说明文件或文件夹存在
3、如果返回的错误为其它类型,则不确定是否在存在

os.IsNotExist(err)正好返回一个布尔值，判断是否已知错误来报告文件或目录不存在。

	ext, ok := supportedImageTypes[path.Ext(picture)]
	if !ok {
		return ErrImgExt
	}
1
2
3
4

根据文件的扩展名判断文件是不是图片。

var supportedImageTypes = map[string]string{
	".gif": ".gif", ".jpg": ".jpeg",
	 ".jpeg": ".jpeg", ".png": ".png",
	 ".tif": ".tiff", ".tiff": ".tiff", 
	 ".emf": ".emf", ".wmf": ".wmf"
 }
1
2
3
4
5
6

上面是设定的能够识别的图片扩展名。

	file, _ := ioutil.ReadFile(filepath.Clean(picture))
	name := f.addMedia(file, ext)
1
2

将文件读取，ioutil.ReadFile适用于文件比较小的读入。

当文件较小(KB 级别)时，ioutil > bufio > os。
当文件大小比较常规(MB 级别)时，三者差别不大，但 bufio 比较好一点。
当文件较大(GB 级别)时，bufio > os > ioutil。

sheetRels := "xl/worksheets/_rels/" + strings.TrimPrefix(f.sheetMap[trimSheetName(sheet)], "xl/worksheets/") + ".rels"
rID := f.addRels(sheetRels, SourceRelationshipImage, strings.Replace(name, "xl", "..", 1), "")
f.addSheetPicture(sheet, rID)
f.addSheetNameSpace(sheet, SourceRelationship)
f.setContentTypePartImageExtensions()
return err
1
2
3
4
5
6

这些操作都应该是给xml文件做各种操作。

sheetRels := "xl/worksheets/_rels/" + strings.TrimPrefix(f.sheetMap[trimSheetName(sheet)], "xl/worksheets/") + ".rels"
rID := f.addRels(sheetRels, SourceRelationshipImage, strings.Replace(name, "xl", "..", 1), "")
1
2

是根据上面的rel路径生成一个rels文件，然后返回它的ID。

f.addSheetPicture(sheet, rID)是将改rels文件放入工作表。
addSheetNameSpace 为工作表添加 XML 属性。
setContentTypePartImageExtensions 功能是设置关系部分和主文档部分的内容类型。

三、结语

这里是老岳，这是Go语言相关源码的解读第九篇，我会不断努力，给大家带来更多类似的文章，恳请大家不吝赐教。