be.ems/src/framework/utils/file/excel.go

package file

import (
	"fmt"
	"mime/multipart"
	"os"
	"path/filepath"
	"time"

	"be.ems/src/framework/constants"
	"be.ems/src/framework/logger"
	"be.ems/src/framework/utils/date"

	"github.com/xuri/excelize/v2"
)

// TransferExeclUploadFile 表格文件上传保存
//
// file 上传文件对象
func TransferExeclUploadFile(file *multipart.FileHeader) (string, error) {
	// 上传文件检查
	err := isAllowWrite(file.Filename, []string{".xls", ".xlsx"}, file.Size)
	if err != nil {
		return "", err
	}
	// 上传资源路径
	_, dir := resourceUpload()
	// 新文件名称并组装文件地址
	filePath := filepath.Join(constants.UPLOAD_IMPORT, date.ParseDatePath(time.Now()))
	fileName := generateFileName(file.Filename)
	writePathFile := filepath.Join(dir, filePath, fileName)
	// 存入新文件路径
	err = transferToNewFile(file, writePathFile)
	if err != nil {
		return "", err
	}
	return filepath.ToSlash(writePathFile), nil
}

// 表格写入数据
//
// headerCells 第一行表头标题 "A1":"?"
//
// dataCells 从第二行开始的数据 "A2":"?"
//
// fileName 文件名称
//
// sheetName 工作簿名称， 空字符默认Sheet1
func WriteSheet(headerCells map[string]string, dataCells []map[string]any, fileName, sheetName string) (string, error) {
	f := excelize.NewFile()
	defer func() {
		if err := f.Close(); err != nil {
			logger.Errorf("WriteSheet to close worksheet file: %v", err)
		}
	}()

	// 创建一个工作表
	if sheetName == "" {
		sheetName = "Sheet1"
	}
	index, err := f.NewSheet(sheetName)
	if err != nil {
		return "", fmt.Errorf("failed to create worksheet %v", err)
	}
	// 设置工作簿的默认工作表
	f.SetActiveSheet(index)

	// 首个和最后key名称
	firstKey := "A"
	lastKey := "B"

	// 第一行表头标题
	for key, title := range headerCells {
		f.SetCellValue(sheetName, key, title)
		if key[:1] > lastKey {
			lastKey = key[:1]
		}
	}

	// 设置工作表上宽度为 20
	f.SetColWidth(sheetName, firstKey, lastKey, 20)

	// 从第二行开始的数据
	for _, cell := range dataCells {
		for key, value := range cell {
			f.SetCellValue(sheetName, key, value)
		}
	}

	// 上传资源路径
	_, dir := resourceUpload()
	filePath := filepath.Join(constants.UPLOAD_EXPORT, date.ParseDatePath(time.Now()))
	saveFilePath := filepath.Join(dir, filePath, fileName)

	// 创建文件目录
	if err := os.MkdirAll(filepath.Dir(saveFilePath), 0775); err != nil {
		return "", fmt.Errorf("failed to create save file %v", err)
	}

	// 根据指定路径保存文件
	if err := f.SaveAs(saveFilePath); err != nil {
		return "", fmt.Errorf("failed to save worksheet %v", err)
	}
	return saveFilePath, nil
}

// WriterFileExecl 写入xlsx文件
//
// 例如：
// headerCells := map[string]string{"A1": "姓名", "B1": "年龄", "C1": "城市"}
//
//	dataCells := []map[string]any{
//		{"A2": "1", "B2": "2", "C2": "3"},
//	}
//
// filePath := "example.xlsx"
// err := file.WriterFileExecl(headerCells, dataCells, filePath, "Sheet1")
func WriterFileExecl(headerCells map[string]string, dataCells []map[string]any, filePath, sheetName string) error {
	f := excelize.NewFile()
	defer func() {
		if err := f.Close(); err != nil {
			logger.Errorf("WriterFileExecl to close worksheet file: %v", err)
		}
	}()

	// 创建一个工作表
	if sheetName == "" {
		sheetName = "Sheet1"
	}
	index, err := f.NewSheet(sheetName)
	if err != nil {
		return fmt.Errorf("failed to create worksheet %v", err)
	}
	// 设置工作簿的默认工作表
	f.SetActiveSheet(index)

	// 首个和最后key名称
	firstKey := "A"
	lastKey := "B"

	// 第一行表头标题
	for key, title := range headerCells {
		f.SetCellValue(sheetName, key, title)
		if key[:1] > lastKey {
			lastKey = key[:1]
		}
	}

	// 设置工作表上宽度为 20
	f.SetColWidth(sheetName, firstKey, lastKey, 20)

	// 从第二行开始的数据
	for _, cell := range dataCells {
		for key, value := range cell {
			f.SetCellValue(sheetName, key, value)
		}
	}

	// 创建文件目录
	if err := os.MkdirAll(filepath.Dir(filePath), 0775); err != nil {
		return fmt.Errorf("failed to create save file %v", err)
	}

	// 根据指定路径保存文件
	if err := f.SaveAs(filePath); err != nil {
		return fmt.Errorf("failed to save worksheet %v", err)
	}
	return nil
}

// ReadFileExecl 读取xlsx文件 转换数组数据
func ReadFileExecl(filePath, sheetName string) ([]map[string]string, error) {
	data := make([]map[string]string, 0)
	// 打开 Excel 文件
	f, err := excelize.OpenFile(filePath)
	if err != nil {
		return data, err
	}
	defer func() {
		if err := f.Close(); err != nil {
			logger.Errorf("ReadSheet to close worksheet file : %v", err)
		}
	}()

	// 检查工作簿是否存在
	if sheetName == "" {
		sheetName = "Sheet1"
	}
	if visible, _ := f.GetSheetVisible(sheetName); !visible {
		return data, fmt.Errorf("failed to read workbook %s", sheetName)
	}

	// 获取工作簿记录
	rows, err := f.GetRows(sheetName)
	if err != nil {
		return data, err
	}

	for i, row := range rows {
		// 跳过第一行
		if i == 0 {
			continue
		}
		// 遍历每个单元格
		rowData := map[string]string{}
		for columnIndex, cellValue := range row {
			columnName, _ := excelize.ColumnNumberToName(columnIndex + 1)
			rowData[columnName] = cellValue
		}

		data = append(data, rowData)
	}
	return data, nil
}