Go Excelize API源碼閱讀Close及NewSheet方法示例解析

Posted on by

一、Go-Excelize簡介

Excelize 是 Go 語言編寫的用於操作 Office Excel 文檔基礎庫，基於 ECMA-376，ISO/IEC 29500 國際標準。可以使用它來讀取、寫入由 Microsoft Excel™ 2007 及以上版本創建的電子表格文檔。

支持 XLAM / XLSM / XLSX / XLTM / XLTX 等多種文檔格式，高度兼容帶有樣式、圖片(表)、透視表、切片器等復雜組件的文檔，並提供流式讀寫 API，用於處理包含大規模數據的工作簿。可應用於各類報表平臺、雲計算、邊緣計算等系統。

使用本類庫要求使用的 Go 語言為 1.15 或更高版本。

二、Close()

func (f *File) Close() error

此API的作用是關閉工作簿並清理打開文檔時可能產生的系統磁盤緩存。

下面來看看具體代碼：

func (f *File) Close() error {
	var err error
	if f.sharedStringTemp != nil {
		if err := f.sharedStringTemp.Close(); err != nil {
			return err
		}
	}
	f.tempFiles.Range(func(k, v interface{}) bool {
		if err = os.Remove(v.(string)); err != nil {
			return false
		}
		return true
	})
	return err
}

先判斷sharedStringTemp 是不是為空，這是一個*os.File類型的變量。應該是關閉某個重要的緩存文件。

接下來就是遍歷臨時文件，os.Remove(v.(string))會刪除這些臨時文件和文件夾。 以上步驟清理瞭打開文檔時可能產生的系統磁盤緩存。

三、NewSheet()

func (f *File) NewSheet(sheet string) int

該API的作用是根據給定的工作表名稱來創建新工作表，並返回工作表在工作簿中的索引。請註意，在創建新的工作簿時，將包含名為 Sheet1 的默認工作表。

func (f *File) NewSheet(name string) int {
	// Check if the worksheet already exists
	index := f.GetSheetIndex(name)
	if index != -1 {
		return index
	}
	f.DeleteSheet(name)
	f.SheetCount++
	wb := f.workbookReader()
	sheetID := 0
	for _, v := range wb.Sheets.Sheet {
		if v.SheetID > sheetID {
			sheetID = v.SheetID
		}
	}
	sheetID++
	// Update docProps/app.xml
	f.setAppXML()
	// Update [Content_Types].xml
	f.setContentTypes("/xl/worksheets/sheet"+strconv.Itoa(sheetID)+".xml", ContentTypeSpreadSheetMLWorksheet)
	// Create new sheet /xl/worksheets/sheet%d.xml
	f.setSheet(sheetID, name)
	// Update workbook.xml.rels
	rID := f.addRels(f.getWorkbookRelsPath(), SourceRelationshipWorkSheet, fmt.Sprintf("/xl/worksheets/sheet%d.xml", sheetID), "")
	// Update workbook.xml
	f.setWorkbook(name, sheetID, rID)
	return f.GetSheetIndex(name)
}

請註意，工作表名稱是不區分大小寫的。

先檢查給定名字的工資表是否存在，如果不存在GetSheetIndex就會返回-1，否則返回工作表索引。

func (f *File) GetSheetIndex(name string) int {
	for index, sheet := range f.GetSheetList() {
		if strings.EqualFold(sheet, trimSheetName(name)) {
			return index
		}
	}
	return -1
}

如果GetSheetIndex就會返回-1，也就是工作表存在，就調用DeleteSheet把該工作表刪除。 然後建立一個wb := f.workbookReader()工作簿讀取器。

for _, v := range wb.Sheets.Sheet {
		if v.SheetID > sheetID {
			sheetID = v.SheetID
		}
	}

這段代碼的意思應該是求工作表的最大SheetID ，賦值給sheetID。

然後再創建或更新docProps/app.xml、[Content_Types].xml、/xl/worksheets/sheet%d.xml、 workbook.xml.rels、workbook.xml這些文件。

	// Update docProps/app.xml
	f.setAppXML()
	// Update [Content_Types].xml
	f.setContentTypes("/xl/worksheets/sheet"+strconv.Itoa(sheetID)+".xml", ContentTypeSpreadSheetMLWorksheet)
	// Create new sheet /xl/worksheets/sheet%d.xml
	f.setSheet(sheetID, name)
	// Update workbook.xml.rels
	rID := f.addRels(f.getWorkbookRelsPath(), SourceRelationshipWorkSheet, fmt.Sprintf("/xl/worksheets/sheet%d.xml", sheetID), "")
	// Update workbook.xml
	f.setWorkbook(name, sheetID, rID)

最後返回這個Sheet。

以上就是Go Excelize API源碼閱讀Close及NewSheet方法示例解析的詳細內容，更多關於Go-Excelize API的資料請關註WalkonNet其它相關文章！

推薦閱讀：