3.14 实现导出、导入 Excel

知识点

    导出功能的实现

本文目标

在本节,我们将实现对标签信息的导出、导入功能,这是很标配功能了,希望你掌握基础的使用方式。
另外在本文我们使用了 2 个 Excel 的包,excelize 最初的 XML 格式文件的一些结构,是通过 tealeg/xlsx 格式文件结构演化而来的,因此特意在此都展示了,你可以根据自己的场景和喜爱去使用。

配置

首先要指定导出的 Excel 文件的存储路径,在 app.ini 中增加配置:
1
[app]
2
...
3
4
ExportSavePath = export/
Copied!
修改 setting.go 的 App struct:
1
type App struct {
2
JwtSecret string
3
PageSize int
4
PrefixUrl string
5
6
RuntimeRootPath string
7
8
ImageSavePath string
9
ImageMaxSize int
10
ImageAllowExts []string
11
12
ExportSavePath string
13
14
LogSavePath string
15
LogSaveName string
16
LogFileExt string
17
TimeFormat string
18
}
Copied!
在这里需增加 ExportSavePath 配置项,另外将先前 ImagePrefixUrl 改为 PrefixUrl 用于支撑两者的 HOST 获取
(注意修改 image.go 的 GetImageFullUrl 方法)

pkg

新建 pkg/export/excel.go 文件,如下:
1
package export
2
3
import "github.com/EDDYCJY/go-gin-example/pkg/setting"
4
5
func GetExcelFullUrl(name string) string {
6
return setting.AppSetting.PrefixUrl + "/" + GetExcelPath() + name
7
}
8
9
func GetExcelPath() string {
10
return setting.AppSetting.ExportSavePath
11
}
12
13
func GetExcelFullPath() string {
14
return setting.AppSetting.RuntimeRootPath + GetExcelPath()
15
}
Copied!
这里编写了一些常用的方法,以后取值方式如果有变动,直接改内部代码即可,对外不可见

尝试一下标准库

1
f, err := os.Create(export.GetExcelFullPath() + "test.csv")
2
if err != nil {
3
panic(err)
4
}
5
defer f.Close()
6
7
f.WriteString("\xEF\xBB\xBF")
8
9
w := csv.NewWriter(f)
10
data := [][]string{
11
{"1", "test1", "test1-1"},
12
{"2", "test2", "test2-1"},
13
{"3", "test3", "test3-1"},
14
}
15
16
w.WriteAll(data)
Copied!
在 Go 提供的标准库 encoding/csv 中,天然的支持 csv 文件的读取和处理,在本段代码中,做了如下工作:
1、os.Create:
创建了一个 test.csv 文件
2、f.WriteString("\xEF\xBB\xBF"):
\xEF\xBB\xBF 是 UTF-8 BOM 的 16 进制格式,在这里的用处是标识文件的编码格式,通常会出现在文件的开头,因此第一步就要将其写入。如果不标识 UTF-8 的编码格式的话,写入的汉字会显示为乱码
3、csv.NewWriter:
1
func NewWriter(w io.Writer) *Writer {
2
return &Writer{
3
Comma: ',',
4
w: bufio.NewWriter(w),
5
}
6
}
Copied!
4、w.WriteAll:
1
func (w *Writer) WriteAll(records [][]string) error {
2
for _, record := range records {
3
err := w.Write(record)
4
if err != nil {
5
return err
6
}
7
}
8
return w.w.Flush()
9
}
Copied!
WriteAll 实际是对 Write 的封装,需要注意在最后调用了 w.w.Flush(),这充分了说明了 WriteAll 的使用场景,你可以想想作者的设计用意

导出

Service 方法

打开 service/tag.go,增加 Export 方法,如下:
1
func (t *Tag) Export() (string, error) {
2
tags, err := t.GetAll()
3
if err != nil {
4
return "", err
5
}
6
7
file := xlsx.NewFile()
8
sheet, err := file.AddSheet("标签信息")
9
if err != nil {
10
return "", err
11
}
12
13
titles := []string{"ID", "名称", "创建人", "创建时间", "修改人", "修改时间"}
14
row := sheet.AddRow()
15
16
var cell *xlsx.Cell
17
for _, title := range titles {
18
cell = row.AddCell()
19
cell.Value = title
20
}
21
22
for _, v := range tags {
23
values := []string{
24
strconv.Itoa(v.ID),
25
v.Name,
26
v.CreatedBy,
27
strconv.Itoa(v.CreatedOn),
28
v.ModifiedBy,
29
strconv.Itoa(v.ModifiedOn),
30
}
31
32
row = sheet.AddRow()
33
for _, value := range values {
34
cell = row.AddCell()
35
cell.Value = value
36
}
37
}
38
39
time := strconv.Itoa(int(time.Now().Unix()))
40
filename := "tags-" + time + ".xlsx"
41
42
fullPath := export.GetExcelFullPath() + filename
43
err = file.Save(fullPath)
44
if err != nil {
45
return "", err
46
}
47
48
return filename, nil
49
}
Copied!

routers 入口

打开 routers/api/v1/tag.go,增加如下方法:
1
func ExportTag(c *gin.Context) {
2
appG := app.Gin{C: c}
3
name := c.PostForm("name")
4
state := -1
5
if arg := c.PostForm("state"); arg != "" {
6
state = com.StrTo(arg).MustInt()
7
}
8
9
tagService := tag_service.Tag{
10
Name: name,
11
State: state,
12
}
13
14
filename, err := tagService.Export()
15
if err != nil {
16
appG.Response(http.StatusOK, e.ERROR_EXPORT_TAG_FAIL, nil)
17
return
18
}
19
20
appG.Response(http.StatusOK, e.SUCCESS, map[string]string{
21
"export_url": export.GetExcelFullUrl(filename),
22
"export_save_url": export.GetExcelPath() + filename,
23
})
24
}
Copied!

路由

在 routers/router.go 文件中增加路由方法,如下
1
apiv1 := r.Group("/api/v1")
2
apiv1.Use(jwt.JWT())
3
{
4
...
5
//导出标签
6
r.POST("/tags/export", v1.ExportTag)
7
}
Copied!

验证接口

访问 http://127.0.0.1:8000/tags/export,结果如下:
1
{
2
"code": 200,
3
"data": {
4
"export_save_url": "export/tags-1528903393.xlsx",
5
"export_url": "http://127.0.0.1:8000/export/tags-1528903393.xlsx"
6
},
7
"msg": "ok"
8
}
Copied!
最终通过接口返回了导出文件的地址和保存地址

StaticFS

那你想想,现在直接访问地址肯定是无法下载文件的,那么该如何做呢?
打开 router.go 文件,增加代码如下:
1
r.StaticFS("/export", http.Dir(export.GetExcelFullPath()))
Copied!
若你不理解,强烈建议温习下前面的章节,举一反三

验证下载

再次访问上面的 export_url ,如:http://127.0.0.1:8000/export/tags-1528903393.xlsx,是不是成功了呢?

导入

Service 方法

打开 service/tag.go,增加 Import 方法,如下:
1
func (t *Tag) Import(r io.Reader) error {
2
xlsx, err := excelize.OpenReader(r)
3
if err != nil {
4
return err
5
}
6
7
rows := xlsx.GetRows("标签信息")
8
for irow, row := range rows {
9
if irow > 0 {
10
var data []string
11
for _, cell := range row {
12
data = append(data, cell)
13
}
14
15
models.AddTag(data[1], 1, data[2])
16
}
17
}
18
19
return nil
20
}
Copied!

routers 入口

打开 routers/api/v1/tag.go,增加如下方法:
1
func ImportTag(c *gin.Context) {
2
appG := app.Gin{C: c}
3
4
file, _, err := c.Request.FormFile("file")
5
if err != nil {
6
logging.Warn(err)
7
appG.Response(http.StatusOK, e.ERROR, nil)
8
return
9
}
10
11
tagService := tag_service.Tag{}
12
err = tagService.Import(file)
13
if err != nil {
14
logging.Warn(err)
15
appG.Response(http.StatusOK, e.ERROR_IMPORT_TAG_FAIL, nil)
16
return
17
}
18
19
appG.Response(http.StatusOK, e.SUCCESS, nil)
20
}
Copied!

路由

在 routers/router.go 文件中增加路由方法,如下
1
apiv1 := r.Group("/api/v1")
2
apiv1.Use(jwt.JWT())
3
{
4
...
5
//导入标签
6
r.POST("/tags/import", v1.ImportTag)
7
}
Copied!

验证

image
在这里我们将先前导出的 Excel 文件作为入参,访问 http://127.0.0.01:8000/tags/import,检查返回和数据是否正确入库

总结

在本文中,简单介绍了 Excel 的导入、导出的使用方式,使用了以下 2 个包:
你可以细细阅读一下它的实现和使用方式,对你的把控更有帮助 🤔

课外

    tag:导出使用 excelize 的方式去实现(可能你会发现更简单哦)
    tag:导入去重功能实现
    artice :导入、导出功能实现
也不失为你很好的练手机会,如果有兴趣,可以试试

参考

本系列示例代码

关于

修改记录

    第一版:2018年02月16日发布文章
    第二版:2019年10月02日修改文章

如果有任何疑问或错误,欢迎在 issues 进行提问或给予修正意见,如果喜欢或对你有所帮助,欢迎 Star,对作者是一种鼓励和推进。

我的公众号

image
Last modified 2yr ago