【Golang】实现 Excel 文件下载功能

在当今的网络应用开发中，提供数据导出功能是一项常见的需求。Excel 作为一种广泛使用的电子表格格式，通常是数据导出的首选格式之一。在本教程中，我们将学习如何使用 Go 语言和 Gin Web 框架来创建一个 Excel 文件，并允许用户通过 HTTP 请求下载该文件。

准备工作

在开始之前，请确保您的开发环境中已经安装了 Go 语言和相关的开发工具。此外，您还需要安装 Gin Web 框架和 excelize 包，这两个包都将用于我们的示例中。

go get -u github.com/gin-gonic/gin
go get -u github.com/xuri/excelize/v2

创建 Excel 文件

首先，我们将创建一个名为 “Sheet1” 的工作表，并向其中写入一些数据。这可以通过使用 excelize 包来实现。以下是一个简单的示例，展示了如何创建一个 Excel 文件并向其中写入数据。

package main
import (
	"fmt"
	"net/http"
	"time"
	"github.com/gin-gonic/gin"
	"github.com/xuri/excelize/v2"
)
func main() {
	r := gin.Default()
	r.GET("/export", func(c *gin.Context) {
		file := excelize.NewFile()
		sheetName := "Sheet1"
		// 向工作表中写入数据
		for row := 1; row <= 10; row++ {
			for col := 1; col <= 5; col++ {
				cell, err := excelize.CoordinatesToCellName(col, row)
				if err != nil {
					c.JSON(http.StatusInternalServerError, gin.H{"error": "Failed to get cell name"})
					return
				}
				if err := file.SetCellValue(sheetName, cell, fmt.Sprintf("Row %d, Col %d", row, col)); err != nil {
					c.JSON(http.StatusInternalServerError, gin.H{"error": "Failed to set cell value"})
					return
				}
			}
		}
		// 设置 HTTP 响应的头信息
		c.Header("Content-Type", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet")
		filename := fmt.Sprintf("Report_%v.xlsx", time.Now().Format("2006-01-02T15:04:05"))
		c.Header("Content-Disposition", "attachment; filename="+filename)
		// 将 Excel 文件写入 HTTP 响应
		if err := file.Write(c.Writer); err != nil {
			c.JSON(http.StatusOK, "failed")
			return
		}
		c.JSON(http.StatusOK, "success")
	})
	r.Run(":8080")
}

在上面的代码中，我们首先创建了一个新的 Excel 文件，并设置了工作表的名称为 “Sheet1”。然后，我们使用嵌套的 for 循环向工作表中写入数据。每个单元格的值都是 “Row x, Col y” 的格式，其中 x 和 y 分别是当前行和列的编号。
接下来，我们设置了 HTTP 响应的 “Content-Type” 头，将其设置为 “application/vnd.openxmlformats-officedocument.spreadsheetml.sheet”，这将告诉浏览器响应是一个 Excel 文件。我们还设置了 “Content-Disposition” 头，将文件名设置为 “Report_当前时间.xlsx” 的格式。
最后，我们使用 excelize 包的 Write() 方法将 Excel 文件写入 HTTP 响应的主体中。如果写入成功，我们返回 “success”，否则返回 “failed”。

启动服务器

现在，我们已经创建了一个简单的 Web 服务器，该服务器提供了一个名为 “/export” 的路由。当用户访问这个路由时，服务器将创建一个 Excel 文件并将其作为 HTTP 响应发送给用户，允许用户下载该文件。
要启动服务器，请运行以下命令：

go run main.go

服务器将开始在本地端口 8080 上监听请求。

测试下载功能

要测试下载功能，请在浏览器中访问以下 URL：

http://localhost:8080/export

您应该会看到一个文件下载提示，允许您下载名为 “Report_当前时间.xlsx” 的 Excel 文件。

总结

在本教程中，我们学习了如何使用 Go 语言和 Gin Web 框架来创建一个 Excel 文件，并允许用户通过 HTTP 请求下载该文件。我们使用了 excelize 包来创建和写入 Excel 文件，并使用 Gin 来处理 HTTP 请求和响应。这个示例可以作为一个基础模板，用于在实际项目中实现更复杂的数据导出功能。