Go-Excelize API源码阅读(三十八)——SetCellValue

2022-12-03 08:58:13 浏览数 (1)

Go-Excelize API源码阅读(三十八)——SetCellValue

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

二、SetCellValue
代码语言:javascript复制
func (f *File) SetCellValue(sheet, cell string, value interface{}) error

根据给定的工作表名和单元格坐标设置单元格的值。此功能是并发安全的。指定的坐标不应在表格的第一行范围,使用字符文本设置复数。

支持的数据类型: int int8 int16 int32 int64 uint uint8 uint16 uint32 uint64 float32 float64 string []byte time.Duration time.Time bool nil 请注意,此函数默认为 time.Time 类型的单元格的值设置 m/d/yy h:mm 数字格式,您可通过 SetCellStyle 更改该设置。若您需设置无法通过 Go 语言 time.Time 类型表示的 Excel 特殊日期,例如 1900 年 1 月 0 日或 1900 年 2 月 29 日,请先设置单元格的值为 0 或 60,再为其设置具有日期数字格式的样式。

废话少说,直接上代码:

代码语言:javascript复制
func (f *File) SetCellValue(sheet, cell string, value interface{}) error {
	var err error
	switch v := value.(type) {
	case int, int8, int16, int32, int64, uint, uint8, uint16, uint32, uint64:
		err = f.setCellIntFunc(sheet, cell, v)
	case float32:
		err = f.SetCellFloat(sheet, cell, float64(v), -1, 32)
	case float64:
		err = f.SetCellFloat(sheet, cell, v, -1, 64)
	case string:
		err = f.SetCellStr(sheet, cell, v)
	case []byte:
		err = f.SetCellStr(sheet, cell, string(v))
	case time.Duration:
		_, d := setCellDuration(v)
		err = f.SetCellDefault(sheet, cell, d)
		if err != nil {
			return err
		}
		err = f.setDefaultTimeStyle(sheet, cell, 21)
	case time.Time:
		err = f.setCellTimeFunc(sheet, cell, v)
	case bool:
		err = f.SetCellBool(sheet, cell, v)
	case nil:
		err = f.SetCellDefault(sheet, cell, "")
	default:
		err = f.SetCellStr(sheet, cell, fmt.Sprint(value))
	}
	return err
}

该API的主体是使用一个语法糖:

代码语言:javascript复制
switch v: = x.(type)

注意,在 Type Switch 语句的 case 子句中不能使用fallthrough。

这个语法糖有什么用?比如在如下一个场景,你在调用前端的接口,前端发来一些JSON数据,你发现这个前端开发者将接口进行了微调,却没给你说,将原来的float类型换成了string类型,你需要写出兼容该2种方式的代码来解析JSON。

代码语言:javascript复制
case int, int8, int16, int32, int64, uint, uint8, uint16, uint32, uint64:
		err = f.setCellIntFunc(sheet, cell, v)

如果是整型,就调用setCellIntFunc(sheet, cell, v)

可以看到,底层也是转换成为了int类型,不知为何,可能是怕调用此方法时传进来的value是非整型的,所以又调用了switch type的语法糖。

代码语言:javascript复制
	case float32:
		err = f.SetCellFloat(sheet, cell, float64(v), -1, 32)
	case float64:
		err = f.SetCellFloat(sheet, cell, v, -1, 64)

此处float32在传入之前就转为了float64类型,不过bitSize参数为32。

该操作是并发安全的,使用了锁。

代码语言:javascript复制
	case string:
		err = f.SetCellStr(sheet, cell, v)
	case []byte:
		err = f.SetCellStr(sheet, cell, string(v))

接下来是string和[]byte,同样的操作,不过是将v转换为string。

代码语言:javascript复制
	case time.Duration:
		_, d := setCellDuration(v)
		err = f.SetCellDefault(sheet, cell, d)
		if err != nil {
			return err
		}
		err = f.setDefaultTimeStyle(sheet, cell, 21)

看源码:

代码语言:javascript复制
// A Duration represents the elapsed time between two instants
// as an int64 nanosecond count. The representation limits the
// largest representable duration to approximately 290 years.
type Duration int64

由源码可知,Duration本质上是一个int64的类型。从注释可知,代表的是两个时间点之间持续的纳秒数 。

setCellDuration通过给定的Go time.Duration类型的时间长度来准备单元格类型和值。然后再通过SetCellDefault可以将一个单元格的字符串类型的值设置为默认格式,而不用转义,默认格式的值就是前面setCellDuration获取的值。

setDefaultTimeStyle设置时间的默认数字格式。时间类型的单元格值通过给定的工作表名称、单元格引用和数字格式代码来设置。

代码语言:javascript复制
	case time.Time:
		err = f.setCellTimeFunc(sheet, cell, v)
	case bool:
		err = f.SetCellBool(sheet, cell, v)
	case nil:
		err = f.SetCellDefault(sheet, cell, "")
	default:
		err = f.SetCellStr(sheet, cell, fmt.Sprint(value))

setCellTimeFunc提处理时间类型的值,用于 SetCellValue。

SetCellBool通过给定的工作表名称、单元格引用和单元格值来设置单元格的bool类型值。

SetCellDefault可以将一个单元格的字符串类型值设置为默认格式,而不需要对单元格进行转义。

如果为nil,就好办,直接调用fmt.Sprint将其转换为string类型。

结语

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

0 人点赞