Go - 一個對新手很友好的項目(帶界面)

時間 2021-04-24

標籤 git github web redis 算法數據庫 json api 跨域 cors 欄目 Git 简体版

原文原文鏈接

這個開源項目就是：go-gin-api ，目前 800+ Star。git

go-gin-api 是基於 Gin 進行模塊化設計的 API 框架，封裝了經常使用的功能，使用簡單，致力於進行快速的業務研發，同時增長了更多限制，約束項目組開發成員，規避混亂無序及自由隨意的編碼。github

下載後可直接運行

$ git clone https://github.com/xinliangnote/go-gin-api
$ cd go-gin-api
$ go run main.go -env fat  // -env fat 設置爲測試環境

首先進入到服務初始化界面。web

接下來填寫 MySQL、Redis 配置信息，填寫完成後，點擊初始化按鈕。redis

如上圖所示，表示服務初始化成功，須要再從新啓動服務，服務啓動後就會看到登陸界面。算法

使用默認用戶信息： admin，admin 登陸便可，登陸成功後就會看到儀表盤界面。數據庫

已集成哪些功能？

Panic 時郵件告警通知

在後臺可配置郵件發件人信息，以下圖所示：json

郵件模板以下：api

接口鑑權

在後臺可設置調用方 KEY、調用方 SECRET、調用方對接人、備註等信息。跨域

將建立的調用方的 KEY、SECRET 發給調用方便可，能夠對調用方進行啓用/禁用/刪除等操做，還能夠對其受權可訪問的接口。cors

接口鑑權是基於 HTTP Header 中的兩個參數 Authorization、Authorization-Date 存儲簽名信息，代碼中提供了 3 種語言的加密算法：Go、PHP、JS。

代碼生成工具

gormgen，基於數據表生成三個文件，以 admin 表爲例會生成：gen_table.md 表註釋的 MD 文檔、gen_model.go 表字段的結構體、gen_admin.go 表 CURD 操做代碼。

意義：在進行業務需求開發時，建立完數據表後，執行代碼生成工具，經常使用的 CURD 操做所有生成完畢，使用的時候只須要 . 後面的方法便可，這樣大大提升了業務開發效率。

handlergen，基於定義的 Handler 文件中 type interface{} 中接口方法，進行生成文件。

例如，定義的方法爲：

// Login 管理員登陸
// @Tags API.admin
// @Router /api/admin/login [post]
Login() core.HandlerFunc

生成後的方法爲：

type loginRequest struct {
    
}

type loginResponse struct {
    
}

// Login 管理員登陸
// @Summary 管理員登陸
// @Description 管理員登陸
// @Tags API.admin
// @Accept multipart/form-data
// @Produce json
// @Success 200 {object} loginResponse
// @Failure 400 {object} code.Failure
// @Router /api/admin/login [post]
func (h *handler) Login() core.HandlerFunc {
    return func(c core.Context) {
        
    }
}

意義：本次需求的研發負責人經過定義 type interface{} 的方式，定義出須要開發的方法，執行代碼生成工具，每一個方法的空實現都會生成在一個單獨的文件中，開發人員只需去實現各自方法便可，便於進行分工和代碼管理。