Go-Excelize API源码阅读三十五—

Go-Excelize API源码阅读（三十五）——SetSheetCol

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

二、SetSheetCol

func (f *File) SetSheetCol(sheet, cell string, slice interface{}) error

根据给定的工作表名称、起始坐标和 slice 类型引用按列赋值。例如，在名为 Sheet1 的工作表 B 列上，以 B6 单元格作为起始坐标按列赋值：

err := f.SetSheetCol("Sheet1", "B6", &[]interface{}{"1", nil, 2})

看代码：

// SetSheetCol writes an array to column by given worksheet name, starting
// cell reference and a pointer to array type 'slice'. For example, writes an
// array to column B start with the cell B6 on Sheet1:
//
//	err := f.SetSheetCol("Sheet1", "B6", &[]interface{}{"1", nil, 2})
func (f *File) SetSheetCol(sheet, cell string, slice interface{}) error {
	return f.setSheetCells(sheet, cell, slice, columns)
}

其实就是调用了File的setSheetCells方法：主要是为了传递了这样一个参数dir adjustDirection，其值如下。

// setSheetCells provides a function to set worksheet cells value.
func (f *File) setSheetCells(sheet, cell string, slice interface{}, dir adjustDirection) error {
	col, row, err := CellNameToCoordinates(cell)
	if err != nil {
		return err
	}
	// Make sure 'slice' is a Ptr to Slice
	v := reflect.ValueOf(slice)
	if v.Kind() != reflect.Ptr || v.Elem().Kind() != reflect.Slice {
		return ErrParameterInvalid
	}
	v = v.Elem()
	for i := 0; i < v.Len(); i++ {
		var cell string
		var err error
		if dir == rows {
			cell, err = CoordinatesToCellName(col+i, row)
		} else {
			cell, err = CoordinatesToCellName(col, row+i)
		}
		// Error should never happen here. But keep checking to early detect regressions
		// if it will be introduced in the future.
		if err != nil {
			return err
		}
		if err := f.SetCellValue(sheet, cell, v.Index(i).Interface()); err != nil {
			return err
		}
	}
	return err
}

	col, row, err := CellNameToCoordinates(cell)
	if err != nil {
		return err
	}

先根据cell参数获取行和列的数字序号。

	v := reflect.ValueOf(slice)
	if v.Kind() != reflect.Ptr || v.Elem().Kind() != reflect.Slice {
		return ErrParameterInvalid
	}
	v = v.Elem()

然后reflect.ValueOf(slice)利用反射进行相关操作，一个 reflect.Value 可以装载任意类型的值。函数 reflect.ValueOf 接受任意的 interface{} 类型，并返回一个装载着其动态值的 reflect.Value。

然后使用v.Elem()取类型的元素。

期间的判断语句，是判断v的类型是不是为反射的指针类型，并且v的元素的类型是不是为反射的切片类型。如果不是，就返回err：

	// ErrParameterInvalid defined the error message on receive the invalid
	// parameter.
	ErrParameterInvalid = errors.New("parameter is invalid")

下面来看最后一部分：

	for i := 0; i < v.Len(); i++ {
		var cell string
		var err error
		if dir == rows {
			cell, err = CoordinatesToCellName(col+i, row)
		} else {
			cell, err = CoordinatesToCellName(col, row+i)
		}
		// Error should never happen here. But keep checking to early detect regressions
		// if it will be introduced in the future.
		if err != nil {
			return err
		}
		if err := f.SetCellValue(sheet, cell, v.Index(i).Interface()); err != nil {
			return err
		}
	}

获取v的长度，然后判断dir是rows还是columns，其实就是布尔值。

然后调用CoordinatesToCellName获取列或行序号所代表的列或行。

		if err := f.SetCellValue(sheet, cell, v.Index(i).Interface()); err != nil {
			return err
		}

调用SetCellValue给单元格设置值。

结语

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

API 开源开源

Go-Excelize API源码阅读三十五——SetSheetCol