Golang Gin實踐 連載十四 實現導出、導入 Excel

原文地址：Gin實踐 連載十四 實現導出、導入 Excel
項目地址：https://github.com/EDDYCJY/go...

若是對你有所幫助，歡迎點個 Star 👍

前言

在本節，咱們將實現對標籤信息的導出、導入功能，這是很標配功能了，但願你掌握基礎的使用方式

另外在本文咱們使用了 2 個 Excel 的包，excelize 最初的 XML 格式文件的一些結構，是經過 tealeg/xlsx 格式文件結構演化而來的，所以特地在此都展現了，你能夠根據本身的場景和喜好去使用

配置

首先要指定導出的 Excel 文件的存儲路徑，在 app.ini 中增長配置：

[app]
...

ExportSavePath = export/

修改 setting.go 的 App struct：

type App struct {
    JwtSecret       string
    PageSize        int
    PrefixUrl string

    RuntimeRootPath string

    ImageSavePath  string
    ImageMaxSize   int
    ImageAllowExts []string

    ExportSavePath string

    LogSavePath string
    LogSaveName string
    LogFileExt  string
    TimeFormat  string
}

在這裏需增長 ExportSavePath 配置項，另外將先前 ImagePrefixUrl 改成 PrefixUrl 用於支撐二者的 HOST 獲取

（注意修改 image.go 的 GetImageFullUrl 方法）

pkg

新建 pkg/export/excel.go 文件，以下：

package export

import "github.com/EDDYCJY/go-gin-example/pkg/setting"

func GetExcelFullUrl(name string) string {
    return setting.AppSetting.PrefixUrl + "/" + GetExcelPath() + name
}

func GetExcelPath() string {
    return setting.AppSetting.ExportSavePath
}

func GetExcelFullPath() string {
    return setting.AppSetting.RuntimeRootPath + GetExcelPath()
}

這裏編寫了一些經常使用的方法，之後取值方式若是有變更，直接改內部代碼便可，對外不可見

嘗試一下標準庫

f, err := os.Create(export.GetExcelFullPath() + "test.csv")
if err != nil {
    panic(err)
}
defer f.Close()

f.WriteString("\xEF\xBB\xBF")

w := csv.NewWriter(f)
data := [][]string{
    {"1", "test1", "test1-1"},
    {"2", "test2", "test2-1"},
    {"3", "test3", "test3-1"},
}

w.WriteAll(data)

在 Go 提供的標準庫 encoding/csv 中，自然的支持 csv 文件的讀取和處理，在本段代碼中，作了以下工做：

一、os.Create：

建立了一個 test.csv 文件

二、f.WriteString("xEFxBBxBF")：

\xEF\xBB\xBF 是 UTF-8 BOM 的 16 進制格式，在這裏的用處是標識文件的編碼格式，一般會出如今文件的開頭，所以第一步就要將其寫入。若是不標識 UTF-8 的編碼格式的話，寫入的漢字會顯示爲亂碼

三、csv.NewWriter：

func NewWriter(w io.Writer) *Writer {
    return &Writer{
        Comma: ',',
        w:     bufio.NewWriter(w),
    }
}

四、w.WriteAll：

func (w *Writer) WriteAll(records [][]string) error {
    for _, record := range records {
        err := w.Write(record)
        if err != nil {
            return err
        }
    }
    return w.w.Flush()
}

WriteAll 實際是對 Write 的封裝，須要注意在最後調用了 w.w.Flush()，這充分了說明了 WriteAll 的使用場景，你能夠想一想做者的設計用意

導出

Service 方法

打開 service/tag.go，增長 Export 方法，以下：

func (t *Tag) Export() (string, error) {
    tags, err := t.GetAll()
    if err != nil {
        return "", err
    }

    file := xlsx.NewFile()
    sheet, err := file.AddSheet("標籤信息")
    if err != nil {
        return "", err
    }

    titles := []string{"ID", "名稱", "建立人", "建立時間", "修改人", "修改時間"}
    row := sheet.AddRow()

    var cell *xlsx.Cell
    for _, title := range titles {
        cell = row.AddCell()
        cell.Value = title
    }

    for _, v := range tags {
        values := []string{
            strconv.Itoa(v.ID),
            v.Name,
            v.CreatedBy,
            strconv.Itoa(v.CreatedOn),
            v.ModifiedBy,
            strconv.Itoa(v.ModifiedOn),
        }

        row = sheet.AddRow()
        for _, value := range values {
            cell = row.AddCell()
            cell.Value = value
        }
    }

    time := strconv.Itoa(int(time.Now().Unix()))
    filename := "tags-" + time + ".xlsx"

    fullPath := export.GetExcelFullPath() + filename
    err = file.Save(fullPath)
    if err != nil {
        return "", err
    }

    return filename, nil
}

routers 入口

打開 routers/api/v1/tag.go，增長以下方法：

func ExportTag(c *gin.Context) {
    appG := app.Gin{C: c}
    name := c.PostForm("name")
    state := -1
    if arg := c.PostForm("state"); arg != "" {
        state = com.StrTo(arg).MustInt()
    }

    tagService := tag_service.Tag{
        Name:  name,
        State: state,
    }

    filename, err := tagService.Export()
    if err != nil {
        appG.Response(http.StatusOK, e.ERROR_EXPORT_TAG_FAIL, nil)
        return
    }

    appG.Response(http.StatusOK, e.SUCCESS, map[string]string{
        "export_url":      export.GetExcelFullUrl(filename),
        "export_save_url": export.GetExcelPath() + filename,
    })
}

路由

在 routers/router.go 文件中增長路由方法，以下

apiv1 := r.Group("/api/v1")
apiv1.Use(jwt.JWT())
{
    ...
    //導出標籤
    r.POST("/tags/export", v1.ExportTag)
}

驗證接口

訪問 http://127.0.0.1:8000/tags/export，結果以下：

{
    "code": 200,
    "data": {
        "export_save_url": "export/tags-1528903393.xlsx",
        "export_url": "http://127.0.0.1:8000/export/tags-1528903393.xlsx"
    },
    "msg": "ok"
}

最終經過接口返回了導出文件的地址和保存地址

StaticFS

那你想一想，如今直接訪問地址確定是沒法下載文件的，那麼該如何作呢？

打開 router.go 文件，增長代碼以下：

r.StaticFS("/export", http.Dir(export.GetExcelFullPath()))

若你不理解，強烈建議溫習下前面的章節，觸類旁通

驗證下載

再次訪問上面的 export_url ，如：http://127.0.0.1:8000/export/tags-1528903393.xlsx，是否是成功了呢？

導入

Service 方法

打開 service/tag.go，增長 Import 方法，以下：

func (t *Tag) Import(r io.Reader) error {
    xlsx, err := excelize.OpenReader(r)
    if err != nil {
        return err
    }

    rows := xlsx.GetRows("標籤信息")
    for irow, row := range rows {
        if irow > 0 {
            var data []string
            for _, cell := range row {
                data = append(data, cell)
            }

            models.AddTag(data[1], 1, data[2])
        }
    }

    return nil
}

routers 入口

打開 routers/api/v1/tag.go，增長以下方法：

func ImportTag(c *gin.Context) {
    appG := app.Gin{C: c}

    file, _, err := c.Request.FormFile("file")
    if err != nil {
        logging.Warn(err)
        appG.Response(http.StatusOK, e.ERROR, nil)
        return
    }

    tagService := tag_service.Tag{}
    err = tagService.Import(file)
    if err != nil {
        logging.Warn(err)
        appG.Response(http.StatusOK, e.ERROR_IMPORT_TAG_FAIL, nil)
        return
    }

    appG.Response(http.StatusOK, e.SUCCESS, nil)
}

路由

在 routers/router.go 文件中增長路由方法，以下

apiv1 := r.Group("/api/v1")
apiv1.Use(jwt.JWT())
{
    ...
    //導入標籤
    r.POST("/tags/import", v1.ImportTag)
}

驗證

在這裏咱們將先前導出的 Excel 文件做爲入參，訪問 http://127.0.0.01:8000/tags/import，檢查返回和數據是否正確入庫

總結

在本文中，簡單介紹了 Excel 的導入、導出的使用方式，使用瞭如下 2 個包：

• tealeg/xlsx
• 360EntSecGroup-Skylar/excelize

你能夠細細閱讀一下它的實現和使用方式，對你的把控更有幫助 🤔

課外

• tag：導出使用 excelize 的方式去實現（可能你會發現更簡單哦）
• tag：導入去重功能實現
• artice ：導入、導出功能實現

也不失爲你很好的練手機會，若是有興趣，能夠試試

參考

本系列示例代碼

• go-gin-example

本系列目錄

• 連載一 Golang介紹與環境安裝
• 連載二 搭建Blog API's（一）
• 連載三 搭建Blog API's（二）
• 連載四 搭建Blog API's（三）
• 連載五 使用JWT進行身份校驗
• 連載六 編寫一個簡單的文件日誌
• 連載七 Golang優雅重啓HTTP服務
• 連載八 爲它加上Swagger
• 連載九 將Golang應用部署到Docker
• 連載十 定製 GORM Callbacks
• 連載十一 Cron定時任務
• 連載十二 優化配置結構及實現圖片上傳
• 連載十三 優化你的應用結構和實現Redis緩存
• 連載十四 實現導出、導入 Excel
• 連載十五 生成二維碼、合併海報
• 連載十六 在圖片上繪製文字
• 連載十七 用 Nginx 部署 Go 應用
• 番外 Golang交叉編譯
• 番外 請入門 Makefile