gin excel异步导出

最新推荐文章于 2024-07-18 15:29:36 发布
最新推荐文章于 2024-07-18 15:29:36 发布
阅读量767 收藏 1
点赞数 2
文章标签： gin excel
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/mercy_php/article/details/132081304
版权

前言 

        新项目需要具有据数据导出功能，整体功能设计为异步导出，包括添加导出任务并执行导出(本次设计为一步执行，也可以分两步执行)， 任务中心，文件下载功能。

 系统环境

 异步导出接口

        执行流程：添加导出任务(添加成功)->执行导出任务。

        不画流程图了直接上代码。

func Export(ctx *gin.Context) {
	var order ValidateRules.GetOrder
	err := ctx.ShouldBindQuery(&order)
	if err != nil {
		response.Error(ctx, http.StatusInternalServerError, err.Error())
		return
	}

	res := validator.BaseValidate(ctx, order)
	if !res {
		return
	}

    // 创建导出任务,成功执行异步导出,失败返回结果
	ret, taskId := common.CreateExportTask(order)
	if !ret {
		response.Error(ctx, http.StatusInternalServerError, "创建导出任务失败")
        return
	}
    
    // 另开一个线程执行导出任务
	go common.AsyncExport(order, taskId)
	response.Success(ctx, true)
}

Excel导出功能

        基础库引入

# 安装命令
go get github.com/xuri/excelize

# 如果您使用 Go Modules 管理软件包，请使用下面的命令来安装最新版本
go get github.com/xuri/excelize/v2

        测试代码

package test

import (
	"DeliciousTown/app/util/common"
	"fmt"
	"testing"
)

const defaultSheetName = "Sheet"

func TestExport(t *testing.T) {
	var specialWidth []*common.SpecialWidth
	specialWidth = common.InitSpecialWidth()
	list := common.InitData()
	title := common.InitTitle()
	res := common.Export(title, list, defaultSheetName, specialWidth)
	if res != nil {
		fmt.Print(res.Error())
	}
}

          数据导出代码，excel样式文档地址:样式 · Excelize 简体字文档

package common

import (
	"github.com/xuri/excelize/v2"
	"strconv"
	"time"
)

type Data struct {
	Id      int
	OrderNo string
	State   int
	Account string
	Amount  float64
	Time    time.Time
}

type SpecialWidth struct {
	Col   string
	Width float64
}

// 默认宽度
const defaultWidth = 15

func InitData() []*Data {
	payTime, _ := time.Parse("2006-01-02 15:04:05", "2023-08-04 12:00:00")
	return []*Data{
		{1, "OrderNo-20230803000000", 1, "xiaoming", 12.00, payTime},
		{2, "OrderNo-20230803000001", 2, "xiaoming", 0.01, payTime},
		{3, "OrderNo-20230803000002", 1, "xiaohong", 12.00, payTime},
		{4, "OrderNo-20230803000003", 1, "xiaohong", 15.00, payTime},
	}
}

func InitTitle() []string {
	return []string{"ID", "订单号", "状态", "用户", "金额", "时间"}
}

func InitSpecialWidth() []*SpecialWidth {
	return []*SpecialWidth{
		{"B", 30},
		{"F", 20},
	}
}

// 获取表头样式
func GetTitleStyle(file *excelize.File) (titleStyle int, err error) {
	return file.NewStyle(&excelize.Style{
		Border: []excelize.Border{
			{Type: "left", Color: "FF99CC", Style: 2},
			{Type: "top", Color: "FF99CC", Style: 2},
			{Type: "bottom", Color: "FF99CC", Style: 2},
			{Type: "right", Color: "FF99CC", Style: 2},
		},
		Alignment: &excelize.Alignment{
			Horizontal: "center",
			Vertical:   "center",
		},
		Fill: excelize.Fill{
			Type:    "pattern",
			Color:   []string{"#FFFFCC"},
			Pattern: 1,
		},
		Font: &excelize.Font{
			Bold: true,
			Size: 16,
		},
	})
}

// 获取数据样式
func GetDataStyle(file *excelize.File) (titleStyle int, err error) {
	return file.NewStyle(&excelize.Style{
		Alignment: &excelize.Alignment{
			Horizontal: "center",
			Vertical:   "center",
		},
		Border: []excelize.Border{
			{Type: "left", Color: "FFFFFF", Style: 9},
			{Type: "top", Color: "FFFFFF", Style: 9},
			{Type: "bottom", Color: "FFFFFF", Style: 9},
			{Type: "right", Color: "FFFFFF", Style: 9},
		},
		Fill: excelize.Fill{
			Type:    "pattern",
			Color:   []string{"#CCCCCC"},
			Pattern: 3,
		},
		Font: &excelize.Font{
			Size: 13,
		},
	})
}

// 设置表头及表头样式
func SetTitleWithStyle(eFile *excelize.File, sheetName string, title []string, titleLen int) error {
	style, err := GetTitleStyle(eFile)
	if err != nil {
		return err
	}

	hCell, _ := excelize.CoordinatesToCellName(1, 1)
	vCell, _ := excelize.CoordinatesToCellName(titleLen, 1)
	err = eFile.SetCellStyle(sheetName, hCell, vCell, style)
	if err != nil {
		return err
	}

	for key, val := range title {
		col := key + 1
		cellName, _ := excelize.CoordinatesToCellName(col, 1)
		err = eFile.SetCellValue(sheetName, cellName, val)
		if err != nil {
			panic(err)
		}
	}

	return nil
}

// 设置数据样式
func SetListStyle(eFile *excelize.File, sheetName string, dataLen int, titleLen int) error {
	style, err := GetDataStyle(eFile)
	if err != nil {
		return err
	}

	hCell, _ := excelize.CoordinatesToCellName(1, 2)
	vCell, _ := excelize.CoordinatesToCellName(titleLen, dataLen+1)
	err = eFile.SetCellStyle(sheetName, hCell, vCell, style)
	if err != nil {
		return err
	}

	return nil
}

// 设置列宽
func SetWidth(eFile *excelize.File, sheetName string, cellNum int, specialWidth []*SpecialWidth) {
	startCol, _ := excelize.ColumnNumberToName(1)
	endCol, _ := excelize.ColumnNumberToName(cellNum)
	_ = eFile.SetColWidth(sheetName, startCol, endCol, defaultWidth)
	if len(specialWidth) > 0 {
		for _, val := range specialWidth {
			_ = eFile.SetColWidth(sheetName, val.Col, val.Col, val.Width)
		}
	}
}

// 数据写入
func SetData(eFile *excelize.File, list []*Data, sheetName string)  {
	for key, val := range list {
		row := key + 2
		cell := "A" + strconv.Itoa(row)
		cells := []interface{}{val.Id, val.OrderNo, val.State, val.Account, val.Amount, val.Time}
		err := eFile.SetSheetRow(sheetName, cell, &cells)
		if err != nil {
			panic(err)
		}
	}
}

func Export(title []string, list []*Data, sheetName string, specialWidth []*SpecialWidth) error {
	dataLen := len(list)
	titleLen := len(title)
	eFile := excelize.NewFile()
	sheet, err := eFile.NewSheet(sheetName)
	if err != nil {
		return err
	}

	eFile.SetActiveSheet(sheet)
	SetWidth(eFile, sheetName, titleLen, specialWidth)
	err = SetTitleWithStyle(eFile, sheetName, title, titleLen)
	if err != nil {
		return err
	}

	err = SetListStyle(eFile, sheetName, dataLen, titleLen)
	if err != nil {
		return err
	}

	SetData(eFile, list, sheetName)
	if sheetName != "Sheet1" {
		_ = eFile.DeleteSheet("Sheet1")
	}

	err = eFile.SaveAs("test.xlsx")
	if err != nil {
		return err
	}

	return nil
}

         emmm~~~不知道要说些什么  看下效果图，表格时间是天数(excel使用的是格林威治时间,开始时间1900-01-01)，慎用time.Duration

 注意事项

  1. 关于Sheet，如果sheet名称不为Sheet1需要把默认的sheet删除掉，不然会多出默认的Sheet1
  2. 关于数据类型设置，如无类型修改不需要手动去设置excel表格列数据类型，excelize已经为我们处理过了，以下为相关源码 
    // 设置单元格值
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
}

// 设置一行的值
func (f *File) SetSheetRow(sheet, cell string, slice interface{}) error {
	return f.setSheetCells(sheet, cell, slice, rows)
}


// 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
}
  3. 数据表样式范围设定，根据左上，右下的传参方式，以下为相关源码
func (f *File) SetCellStyle(sheet, hCell, vCell string, styleID int) error {
	hCol, hRow, err := CellNameToCoordinates(hCell)
	if err != nil {
		return err
	}

	vCol, vRow, err := CellNameToCoordinates(vCell)
	if err != nil {
		return err
	}

	// Normalize the range, such correct C1:B3 to B1:C3.
	if vCol < hCol {
		vCol, hCol = hCol, vCol
	}

	if vRow < hRow {
		vRow, hRow = hRow, vRow
	}

	hColIdx := hCol - 1
	hRowIdx := hRow - 1

	vColIdx := vCol - 1
	vRowIdx := vRow - 1

	ws, err := f.workSheetReader(sheet)
	if err != nil {
		return err
	}
	prepareSheetXML(ws, vCol, vRow)
	makeContiguousColumns(ws, hRow, vRow, vCol)
	ws.Lock()
	defer ws.Unlock()

	s, err := f.stylesReader()
	if err != nil {
		return err
	}
	s.Lock()
	defer s.Unlock()
	if styleID < 0 || s.CellXfs == nil || len(s.CellXfs.Xf) <= styleID {
		return newInvalidStyleID(styleID)
	}

	for r := hRowIdx; r <= vRowIdx; r++ {
		for k := hColIdx; k <= vColIdx; k++ {
			ws.SheetData.Row[r].C[k].S = styleID
		}
	}
	return err
}

文件压缩

        如果有分很多文件又要一次性下载这种场景就需要生成压缩包了(我的业务场景)，以下是文件压缩相关的代码

// 获取文件夹下的所有文件信息
func GetFilesName(path string) []string {
	var files []string
	_ = filepath.Walk(path, func(path string, info os.FileInfo, err error) error {
		if info.IsDir() || err != nil {
			return nil
		}

		file, err := os.Open(path)
		if err != nil {
			return nil
		}

		defer file.Close()
		files = append(files, file.Name())
		return nil
	})

	return files
}

func Zip(name string, files []string) bool {
	zipPack, err := os.Create(name)
	if err != nil {
		fmt.Print("创建文件失败!!!")
		return false
	}

	defer zipPack.Close()
	z := zip.NewWriter(zipPack)
	for _, file := range files {
		src, err := os.Open(file)
		if err != nil {
			return false
		}

		info, err := src.Stat()
		if err != nil {
			return false
		}

		hdr, err := zip.FileInfoHeader(info)
		if err != nil {
			return false
		}

		// Write only the base name in the header
		hdr.Name = filepath.Base(file)
		dst, err := z.CreateHeader(hdr)
		if err != nil {
			return false
		}

		_, err = io.Copy(dst, src)
		if err != nil {
			return false
		}

		src.Close()
	}

	// 关闭 zip.Writer
	err = z.Close()
	if err != nil {
		fmt.Print("关闭写入失败!!!")
	}

	return true
}

下载文件接口

        直接上代码

func DownloadExportFile(ctx *gin.Context) {
	taskId := ctx.Query("id")
	Id, err := strconv.Atoi(taskId)
	if err != nil {
		response.Error(ctx, http.StatusInternalServerError, "传参类型错误")
		return
	}

    // 获取任务信息
	taskInfo, res := common.GetTaskInfo(Id)
	if res != nil {
		response.Error(ctx, http.StatusInternalServerError, "获取任务失败")
		return
	}

    // 校验状态
	if taskInfo.State != 2 {
		response.Error(ctx, http.StatusInternalServerError, "导出任务执行失败")
		return
	}

    // 校验文件
	file, msg := os.Open(taskInfo.FilePath)
	if msg != nil {
		response.Error(ctx, http.StatusInternalServerError, "文件不存在或文件已损坏")
		return
	}

	defer file.Close()
	fileName := path.Base(taskInfo.FilePath)
	ctx.Header("Content-Type", "application/octet-stream")
	ctx.Header("Content-Disposition", "attachment; filename="+fileName)
	ctx.Header("Content-Transfer-Encoding", "binary")
	ctx.File(taskInfo.FilePath)
	return
}

结束语

        以上就是gin+Excelize的简单使用，稍作修改即可使用，如有错误请指正，祝大家事事順遂，生活幸福愉快！！！

西局幼儿园扛把子
关注
  • 2
    点赞
  • 踩
  • 1
    收藏
    觉得还不错? 一键收藏
  • 2
    评论
golang gin 框架 异步同步 goroutine 并发
疯狂的鸭血
03-27 5328
goroutine机制可以方便地实现异步处理 package main import ( "log" "time" "github.com/gin-gonic/gin" ) func main() { // 1.创建路由 // 默认使用了2个中间件Logger(), Recovery() r := gin.Default() // 1....
gin go 更新缓存_golang gin 框架 异步同步 goroutine 并发操作
weixin_30324103的博客
01-13 638
goroutine机制可以方便地实现异步处理package mainimport ("log""time""github.com/gin-gonic/gin")func main() {// 1.创建路由// 默认使用了2个中间件Logger(), Recovery()r := gin.Default()// 1.异步r.GET("/long_async", func(c *gin.Context...
javaweb异步导出
01-20
javaweb异步导出
Go语言gin框架项目：按模板导出excel并在网页端下载,并将此接口完成swagger的配置
pyscl01的博客
05-22 2188
Go语言gin框架项目：按模板导出excel并在网页端下载,并将此接口完成swagger的配置的详细步骤
【go】Excelize处理excel表 带合并单元格、自动换行与固定列宽的文件导出
最新发布
微雨停了的博客
07-18 780
之前整理过使用Excelize导出原始excel文件与增加数据校验的excel导出。【go】Excelize处理excel表 带数据校验的文件导出本文整理使用Excelize导出带单元格合并的excel文件与导出增加自动换行和固定列宽的excel文件。
gin导出excel文件与cvs
小熙的博客
05-14 559
go可以通过excelize包实现对excel的操作。
Go 结合Gin导出Mysql数据到Excel表格
strom_xu
07-28 2035
Go 结合Gin导出Mysql数据到Excel表格
GoLang+gin框架导出Excel
qq_38556217的博客
02-03 4009
文章目录使用模块代码实现 使用模块 github.com/tealeg/xlsx 模块地址 官方文档地址 代码实现 核心代码func ToExcel、ResponseXls 篇幅原因这里只贴出核心代码 import ( "bytes" "fmt" "io" "net/http" "time" "github.com/gin-gonic/gin" "github.com/tealeg/xlsx" ) type DownloadRoleInfoBo struct { Name
vue中后端做Excel导出功能返回数据流前端的处理操作
10-14
在Vue项目中，当后端实现Excel导出功能并返回数据流时，前端需要进行相应的处理以将数据转化为可下载的Excel文件。本篇将详细解释这个过程。 首先，后端通常会通过HTTP响应返回一个Blob对象，Blob是Binary Large ...
go实现导出excel或csv文件
swan_tang的博客
12-23 5719
go实现导出excel或csv文件 很早之前的一个项目需求要，需要把公司信息列表和漏洞信息列表导出excel文件，没有很高要求，能看就行吧，就做了导出csv的两个接口。 最近看我的CSDN发现好久没有写了，惭愧啊！其实遇到的问题，我都有详细记录，自己能看懂，但分享给别人也能看懂就需要好好写了，尽量有空整吧，需要坚持！ 实现代码 我把实现代码简单写了一下，是用调用接口的方式实现的，用的gin 包。 package main import ( "encoding/csv" "fmt" "github.
用gin封装machinery对外提供异步任务队列接口
weixin_42189242的博客
09-17 4323
因为业务需要用到异步任务队列，在python里面可以用celery了，在异步任务方面很方便，可是go里面没有celery,找了一圈发现machinery符合预期。官方github。在网上想找一点可以参考的demo或者分享的文章很少，所以自己就研究了一下，分享一下。用过celery就知道celery也有worker，这里machinery也一样的有worker，还有send。顾名思义一个是往队列加任...
Golang Gin实践 连载十四 实现导出、导入 Excel
weixin_33912246的博客
06-14 1289
Golang Gin实践 连载十四 实现导出、导入 Excel 原文地址：Gin实践 连载十四 实现导出、导入 Excel项目地址：https://github.com/EDDYCJY/go... 如果对你有所帮助，欢迎点个 Star
Golang Gin导出excel
bingfengjiyi23的博客
01-25 5710
导出用的360的excelize，支持插入图表和图片 Gin框架没有提供方法供浏览器下载，所以这里我们用流 import ( "github.com/360EntSecGroup-Skylar/excelize" "github.com/gin-gonic/gin" ) // 导出 func Export(c *gin.Context) { xlsx := excelize.NewF...
java异步导出数据（避免长时间无互动等待）
weixin_42494979的博客
11-24 6982
问题概述： 使用java作为后台语言，用poi导出数据时无法异步，当数据量稍微大点，就会出现页面傻瓜式等待 （点击导出后，页面无任何反应和提示，还以为此功能无效。然则几秒后浏览器才响应。）这样体验非常 不好。 解决办法： 很简单，将下载数据分离为一个单独方法。在触发导出后，先获取并封装数据，完成后给前台返回一个状态，当前台收到返回正确返回状态后，再调用下载方法。 demo： 1、获取并封装数据 @RequestMapping("exportExcel") //用户数据导出
Excel 异步导出
巴啦啦的博客
07-06 8951
实现文件异步下载功能步骤：1、前端触发下载功能按钮， AJAX向后台发送请求下载；2、 public void exportExcelByByte(HttpServletResponse response, InputStream inputStream, String filename) throws Exception { filename = new String(filename....
excel winform 导入 导出_Go Web 框架 Gin 实践14—实现导出、导入 Excel
weixin_39562327的博客
11-28 202
Go语言中文网，致力于每日分享编码、开源等知识，欢迎关注我，会有意想不到的收获！项目地址：https://github.com/EDDYCJY/go-gin-example如果对你有所帮助，欢迎点个 Star前言在本节，我们将实现对标签信息的导出、导入功能，这是很标配功能了，希望你掌握基础的使用方式另外在本文我们使用了 2 个 Excel 的包，excelize 最初的 XML 格式文件的一些结构...
golang_gin csv导出
fuzhe_1的博客
07-12 620
gin 导出csv文件
异步导出(CompletableFuture异步任务+阿里云)
m0_68627854的博客
04-29 261
【代码】异步导出(CompletableFuture异步任务+阿里云)
java 异步表格导出
yang11qiang的博客
04-07 1185
前端传入查询数据的链接和参数（导出列表数据的情况下，url和参数一般和界面的列表查询接口相同，这样可以减少一个专门的导出接口，在返回对象中添加对应的Excel注解用于生成表头和数据转换），构建请求信息去调用其他服务的查询接口，一定要带上用户信息，因为大部分系统都有数据权限，防止用户看到无权查看的内容。具体不记得了，，，，），我们项目种用的最多的就是第一种方式，带来的问题就是，数据量过大，内存飙升也发生过几次oom，用户体验方面，导出任务比较慢的情况，用户不能离开当前界面需要保持连接，还很可能超时。
gin读取本地excel文件 前后端分离
06-06
如果你想要在前后端分离的情况下，让 Gin 读取本地 Excel 文件，你可以按照以下步骤： 1. 在前端页面中添加一个上传 Excel 文件的表单，并使用 Ajax 将文件上传到后端服务器。 2. 在后端服务器中，使用 Gin 的 multipart 中间件来处理上传的文件，将文件保存到本地磁盘上。 3. 在后端服务器中，使用第三方库（例如 go-xlsx）来读取本地 Excel 文件的数据，并将数据返回给前端页面。 下面是一个简单的示例代码，可以帮助你实现这个功能： ```go package main import ( "github.com/gin-gonic/gin" "github.com/tealeg/xlsx" "net/http" "os" ) func main() { r := gin.Default() // 处理上传的 Excel 文件 r.POST("/upload", func(c *gin.Context) { file, err := c.FormFile("file") if err != nil { c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) return } // 将上传的文件保存到本地磁盘上 filepath := "./" + file.Filename if err := c.SaveUploadedFile(file, filepath); err != nil { c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) return } // 读取本地 Excel 文件的数据，并返回给前端页面 xlFile, err := xlsx.OpenFile(filepath) if err != nil { c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) return } var data []string for _, sheet := range xlFile.Sheets { for _, row := range sheet.Rows { for _, cell := range row.Cells { data = append(data, cell.String()) } } } c.JSON(http.StatusOK, gin.H{"data": data}) // 删除本地磁盘上的文件 os.Remove(filepath) }) r.Run(":8080") } ``` 在这个示例中，我们首先使用 Gin 的 `FormFile` 方法来获取上传的 Excel 文件，并将其保存到本地磁盘上。然后，我们使用第三方库 go-xlsx 来读取本地 Excel 文件的数据，并将其返回给前端页面。最后，我们使用 `os.Remove` 方法来删除本地磁盘上的文件，以避免占用过多的磁盘空间。
评论 2
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值