前言
最近有很多小伙伴私信我：在學完Go基礎后，想使用一個框架實戰一個商業項目，但是又苦于不知道選擇什么框架，更不知道做什么商業項目。
為了解決大家這些問題，我結合自己的項目經歷，為大家開源了一個簡單易上手的Go電商前后臺系統API，這個項目不僅有電商系統常用的功能點，還濃縮了我開發Go積累的一些經驗。
這篇文章適合學完了Go基礎，計劃基于成熟框架開發web項目的同學。
GoFrame簡介
GoFrame是類似PHP-Laravel, Java-SpringBoot的Go企業級開發框架，是一個非常值得學習的Go框架。
之前寫過文章介紹GoFrame為什么值得學習：??# PHP轉Go優選的框架：GoFrame???，以及??# 為什么我覺得GoFrame的garray比PHP的array還好用？??
大家可以閱讀一下，增加使用GoFrame進階實戰的動力。
經驗分享
我用GoFrame開發了不少商業項目，剛開始用的時候也有很多不順手的地方，基本是一邊看官方文檔一邊寫項目。
隨著做的項目多了，遇到的問題多了，發現剛開始寫的代碼實在很爛。
這套開源代碼不敢說多優雅，起碼很規范，在這套源碼基礎上可以快速進行功能模塊的開發，也封裝了常用的工具類。
對大家提高學習Go的效率，應該會有幫助。
官方示例
官方基于最新的v2.x版本提供了示例，從以下角度演示了如何快速搭建單體API Service：
- 接口定義
- 路由注冊
- 常量管理
- 控制器定義
- 數據庫訪問
- 創建業務模型
- 提供服務接口
- 業務實現
- 接口測試
官方的示例非常規范，但是過于簡單。基礎薄弱的小伙伴可以先實踐官方示例[1]，再實踐我的電商項目。
進階教程：電商前后臺系統
作為入門級電商系統包括了常規的功能點，下面我重點說一下能學到技術上的知識點：
- 如何使用gtoken實現單點登錄？
- 如何自定義中間件？
- 如何自定義服務？
- 如何定義路由組，明確接口邊界？
- 如何上傳圖片到云平臺？
- 如何靈活的設置搜索條件？
- 如何用一個項目，提供前后臺的2套API接口？
- 如何實現自動編譯？
- 如何使用shell腳本一鍵部署項目到遠程服務器？
說明：GoFrame的官方文檔和示例能帶你快速入門GoFrame框架和CLI工具的使用，不作為這篇文章的重點。
這篇文章的重點是：能帶你更進一步，基于良好的規范，開發比較復雜的商業項目。下面就和我一起學習吧，文章最后我會分享給大家這個項目的github地址以及對大家學習有幫助的文檔資料。
先看目錄
整體結構
項目結構
重點看app目錄
app目錄是我們要重點開發的部分
app目錄
開始實戰
提示：為了行文緊湊，方便大家理解。與核心知識點無關的代碼會直接省略或用會三個豎著的.簡化。文章最后會提供GitHub地址，開源項目。
1. GToken實現單點登錄
1. 查看自己的版本
首先，我們要確定自己安裝的gf版本，通過gf version命令就可以查看了。
查看版本
注意：gtoken v1.5.0全面適配GoFrame v2.0.0 ; GoFrame v1.X.X 請使用GfToken v1.4.X相關版本
根據自己的版本安裝合適的gtoken
2. 安裝最新版gtoken
go get github.com/goflyfox/gtoken
3. 安裝指定版本gtoken
@指定的版本號就可以了：
go get github.com/goflyfox/gtoken@v1.4.1
2. 自定義中間件
我們以編寫gtoken中間件為例，帶大家寫一個自己的中間件：
在我們的app/middleware目錄下新建token.go文件
編寫gtoken中間件的目的：
- 全局校驗用戶的登錄狀態
- 登錄后的用戶將用戶名、id這類用戶信息寫入到Context上下中，方便全局調用
- 在中間件中統一進行賬號判斷，比如：是否被拉黑等判斷操作
我們來看具體的實現：
package middleware
const (
CtxAccountId = "account_id" //token獲取
.
.
.
)
type TokenInfo struct {
Id int
Name string
.
.
.
}
var GToken *gtoken.GfToken
var MiddlewareGToken = tokenMiddleware{}
type tokenMiddleware struct{}
func (s *tokenMiddleware) GetToken(r *ghttp.Request) {
var tokenInfo TokenInfo
token := GToken.GetTokenData(r)
err := gconv.Struct(token.GetString("data"), &tokenInfo)
if err != nil {
response.Auth(r)
return
}
//賬號被凍結拉黑
if tokenInfo.Status == 2 {
response.AuthBlack(r)
return
}
r.SetCtxVar(CtxAccountId, tokenInfo.Id)
.
.
.
r.Middleware.Next()
}
3. 注冊中間件
我們在app/system/frontend/ 目錄下新建 router.go 文件，用來定義客戶端的路由：
- 首先編寫gtoken登錄注冊等方法
- 然后在路由文件中使用group.Middleware() 把自定義的中間件注冊到路由組中。
- 注意：不需要校驗登錄狀態的接口寫在 group.Middleware(middleware.MiddlewareGToken.GetToken) 之前，需要校驗登錄狀態的寫在之后。
package frontend
//前端項目登錄
func Login() {
// 啟動gtoken
middleware.GToken = >oken.GfToken{
//都用默認的
//Timeout: gconv.Int(g.Cfg().Get("gtoken.timeout")) * gconv.Int(gtime.M),
//MaxRefresh: 60 * 1000, //單位毫秒 登錄1分鐘后有請求操作則主動刷新token有效期
CacheMode: 2,
LoginPath: "/frontend/sso/login",
LogoutPath: "/frontend/sso/logout",
AuthPaths: g.SliceStr{},
//AuthPaths: g.SliceStr{"/backend"},
AuthExcludePaths: g.SliceStr{},
GlobalMiddleware: true, // 開啟全局攔截
//MultiLogin: g.Config().GetBool("gtoken.multi-login"),
LoginBeforeFunc: frontendLogin.FrontendLogin.Login,
LoginAfterFunc: frontendLogin.FrontendLogin.LoginAfterFunc,
LogoutAfterFunc: frontendLogin.FrontendLogin.Logout,
AuthAfterFunc: frontendLogin.FrontendLogin.AuthAfterFunc,
}
middleware.GToken.Start()
}
func Init(s *ghttp.Server) {
Login()
s.Group("/frontend/", func(group *ghttp.RouterGroup) {
//不需要登錄的
//上傳文件
group.Group("upload/", func(group *ghttp.RouterGroup) {
group.POST("img/", upload.Upload.Img)
})
//以下是需要登錄的
group.Middleware(middleware.MiddlewareGToken.GetToken)
//登錄賬號相關
group.Group("sso/", func(group *ghttp.RouterGroup) {
group.POST("password/update", frontendLogin.FrontendLogin.UpdatePassword)
})
})
}
4. 自定義服務
細心的小伙伴已經發現了問題：在路由文件中寫的 frontendLogin.FrontendLogin.Login是在哪里定義的呢？
沒錯，我們定義成了服務。
我們可以把登錄注冊這類通用的功能抽取出來，定義成通用的服務：
我們創建 app/service/frontendLogin 目錄，在這個目錄下再依次創建:
- define.go：用于定義登錄注冊需要的結構體
- service.go：用于編寫業務邏輯，比如校驗登錄密碼是否正確
- api.go：用于提供接口，比如frontendLogin.FrontendLogin.Login就是在這里定義的
define.go簡化示例
package frontendLogin
type RegisterReq struct {
Name string `json:"name" v:"required#用戶名必傳"`
PassWord string `json:"password" v:"required-if:type,0|password#password必須傳遞|密碼限定在6-18位之間"`
Avatar string `json:"avatar"`
Sex int `json:"sex"`
Sign string `json:"sign"`
SecretAnswer string `json:"secret_answer"`
UserSalt string `json:"user_salt,omitempty"`
}
type AccessTokenRes struct {
AccessToken string `json:"access_token"` //獲取到的憑證
ExpiresIn int `json:"expires_in"` //憑證有效時間，單位：秒
}
.
.
.
service.go簡化示例
package frontendLogin
import (
"context"
.
.
.
)
var service = frontendLoginService{}
type frontendLoginService struct {
}
.
.
.
//注冊
func (s *frontendLoginService) Register(ctx context.Context, req *RegisterReq) (err error) {
//查詢用戶名是否存在
count, err := dao.UserInfo.Ctx(ctx).Where("name", req.Name).Count()
if err != nil || count > 0 {
return gerror.New("用戶名已存在，請換個用戶名注冊賬號吧")
}
UserSalt := grand.S(10)
req.PassWord = library.EncryptPassword(req.PassWord, UserSalt)
req.UserSalt = UserSalt
//添加新用戶
_, err = dao.UserInfo.Ctx(ctx).Insert(req)
if err != nil {
return err
}
return
}
.
.
.
api.go簡化示例
package frontendLogin
import (
"github.com/goflyfox/gtoken/gtoken"
.
.
.
)
var FrontendLogin = new(frontendLogin)
type frontendLogin struct {
}
//注冊
func (s *frontendLogin) Register(r *ghttp.Request) {
var data *RegisterReq
if err := r.Parse(&data); err != nil {
response.ParamErr(r, err)
}
err := service.Register(r.Context(), data)
if err != nil {
response.JsonExit(r, 0, "注冊失敗")
} else {
response.SuccessWithData(r, nil)
}
}
.
.
.
好了，到這里我們就完成了gtoken的集成，并且自己編寫了中間件，編寫了服務。
對Gtoken實現原理感興趣的小伙伴可以閱讀這篇文章：??# 通過閱讀源碼解決項目難題：GToken替換JWT實現SSO單點登錄??
下面再帶大家重點看一下前面提到的路由文件：
4.定義路由組，明確接口邊界
建議大家使用分組路由進行路由的管理，能讓我們的路由管理更加的清晰規范。
我們根據業務邏輯拆分路由組，比如下面代碼中的商品管理，文章管理，點贊管理就很清晰。
能保證隨著項目的迭代也能在指定的路由組中進行管理，明確接口邊界。
func Init(s *ghttp.Server) {
Login()
s.Group("/frontend/", func(group *ghttp.RouterGroup) {
//商品
group.Group("goods/", func(group *ghttp.RouterGroup) {
group.POST("list/", goods.Goods.List)
group.POST("detail/", goods.Goods.Detail)
group.POST("category/", goods.Goods.Category)
})
//以下是需要登錄的
group.Middleware(middleware.MiddlewareGToken.GetToken)
//文章
group.Group("article/", func(group *ghttp.RouterGroup) {
group.POST("add/", article.Article.Add)
group.POST("update/", article.Article.Update)
group.POST("delete/", article.Article.Delete)
group.POST("list/", article.Article.List) //全部文章列表
group.POST("my/list/", article.Article.MyList) //我的文章列表
group.POST("detail/", article.Article.Detail) //文章詳情
})
//點贊
group.Group("praise/", func(group *ghttp.RouterGroup) {
group.POST("add/", praise.Praise.Add)
group.POST("delete/", praise.Praise.Delete)
group.POST("list/", praise.Praise.List)
})
})
}注意：我并沒有嚴格按照RESTful Api的規范設計接口，而是全部使用的POST請求。這里并沒有嚴格限制，使用什么API接口規范和框架、開發語言都沒有關系，適合自己的就是最好的。
5. 上傳圖片到云平臺
我們以上傳圖片到七牛云舉例：
- 首先我們使用goframe提供的r.GetUploadFiles("file") 上傳文件到本地（如果部署到服務器，就是服務器的本地）
- 按照云平臺提示，配置相關的AKSK
- 將本地文件地址上傳到云平臺
- 刪除本地文件
下面的關鍵代碼已加注釋，AKSK等配置信息在 /config/config.toml 文件中配置
package upload
var Upload = uploadApi{}
type uploadApi struct{}
// Upload uploads files to /tmp .
func (*uploadApi) Img(r *ghttp.Request) {
files := r.GetUploadFiles("file")
dirPath := "/tmp/"
names, err := files.Save(dirPath, true)
if err != nil {
r.Response.WriteExit(err)
}
for _, name := range names {
localFile := dirPath + name
bucket := g.Cfg().GetString("qiniu.bucket")
key := name
accessKey := g.Cfg().GetString("qiniu.accessKey")
secretKey := g.Cfg().GetString("qiniu.secretKey")
putPolicy := storage.PutPolicy{
Scope: bucket,
}
mac := qbox.NewMac(accessKey, secretKey)
upToken := putPolicy.UploadToken(mac)
cfg := storage.Config{}
// 空間對應的機房
cfg.Zone = &storage.ZoneHuabei
// 是否使用https域名
cfg.UseHTTPS = true
// 上傳是否使用CDN上傳加速
cfg.UseCdnDomains = false
// 構建表單上傳的對象
formUploader := storage.NewFormUploader(&cfg)
ret := storage.PutRet{}
// 可選配置
putExtra := storage.PutExtra{
Params: map[string]string{},
}
err = formUploader.PutFile(r.GetCtx(), &ret, upToken, key, localFile, &putExtra)
if err != nil {
response.FailureWithData(r, 0, err, "")
}
fmt.Println(ret.Key, ret.Hash)
//刪除本地文件
err = os.Remove(localFile)
if err != nil {
g.Dump("刪除本地文件失敗：", err)
}
fmt.Println("刪除本地文件成功", localFile)
//返回數據
response.SuccessWithData(r, g.Map{
"url": g.Cfg().GetString("qiniu.url") + ret.Key,
})
}
}
6.如何科學的寫搜索？
我來說明一個經典的搜索場景：
我們有多個搜索條件，這些搜索條件非必傳，傳了哪些條件就命中哪些條件，如何實現比較科學呢？
我的建議是使用map支持set方法的特點，靈活的設置查詢條件，避免在聲明的時候賦值，那么實現需要做復雜的判斷邏輯。
將查詢條件封裝為packListCondition方法，統一管理，方便多處復用。
func (s *goodsService) List(ctx context.Context, req *PageListReq) (res ListGoodsRes, err error) {
//實例化map
whereCondition := gmap.New()
//很好的理解了map是引用類型的特點 在這個函數中為查詢條件賦值
packListCondition(req, whereCondition)
//map是引用類型，在packListCondition函數中已經做了賦值操作，不需要在接收返回值
count, err := dao.GoodsInfo.Ctx(ctx).Where(whereCondition).Count()
if err != nil {
return
}
res.Count = count
err = dao.GoodsInfo.Ctx(ctx).Where(whereCondition).OrderDesc("id").Page(req.Page, req.Limit).Scan(&res.List)
if err != nil {
return
}
return
}
func packListCondition(req *PageListReq, whereCondition *gmap.Map) {
//使用map支持set的特性 避免在聲明的時候賦值，那么寫需要做的判斷太復雜了。
if req.Keyword != "" {
whereCondition.Set(dao.GoodsInfo.Columns.DetailInfo+" like ", "%"+req.Keyword+"%")
}
if req.Name != "" {
whereCondition.Set(dao.GoodsInfo.Columns.Name+" like ", "%"+req.Name+"%")
}
if req.Brand != "" {
whereCondition.Set(dao.GoodsInfo.Columns.Brand+" like ", "%"+req.Brand+"%")
}
}7.提供2套API接口
我們再來看一下目錄結構，有個整體的認識：
- app/system 目錄是我為了在一個項目中，同時開發前后臺系統，提高代碼復用率而創建的。
- 除了app/system 目錄，其他目錄都是通過goframe的 gf工具生成出來的。
- 所以實現一個項目提供2套API接口的核心是：如何在一個項目中啟動兩個服務，同時提供前后臺項目的所需的接口API?
我是這么做的：在我們main.go的入口文件中分別初始化前后臺項目的路由文件，啟動服務。
package main
import (
"github.com/gogf/gf/frame/g"
"shop/app/middleware"
"shop/app/system/backend"
"shop/app/system/frontend"
_ "shop/boot"
_ "shop/router"
)
func main() {
s := g.Server()
s.Use(middleware.Cors.CORS)
//后臺項目
backend.Init(s)
//前端項目
frontend.Init(s)
s.Run()
}
底層思路是：前后臺項目的路由基于路由組區分是哪個平臺的接口。接口的內部邏輯，如果可以復用就復用；如果不能復用，是獨立的功能就分別在system下的backend或者frontend下開發。
前臺接口路由文件
func Init(s *ghttp.Server) {
s.Group("/frontend/", func(group *ghttp.RouterGroup) {
.
.
.
}
}后臺接口路由文件
func Init(s *ghttp.Server) {
s.Group("/backend/", func(group *ghttp.RouterGroup) {
.
.
.
}
}小提示：如果你的需求只是開發一個項目，那么就可以把system目錄砍掉，直接在原生目錄下開發就可以了。
到這里，我們就完成了項目的整體搭建和開發，感興趣的小伙伴可以star、fork我開源到GitHub的項目源碼：GitHub基于GoFrame搭建的電商前后臺系統API[2]
8.自動編譯
自動編譯是GoFrame集成好的功能，我們不需要去安裝air自動編譯插件，只需要使用如下命令就可以實現自動編譯了：
效果如下：
執行效果
最后我們通過編寫shell腳本，實現項目的一鍵部署到遠程服務器：
9.一鍵部署腳本
RED_COLOR='\E[1;31m' #紅
GREEN_COLOR='\E[1;32m' #綠
YELOW_COLOR='\E[1;33m' #黃
BLUE_COLOR='\E[1;34m' #藍
PINK='\E[1;35m' #粉紅
RES='\E[0m'
echo -e "${GREEN_COLOR}****基于GoFrame搭建的電商前后臺API系統：開始執行自動化部署****${RES}\n\n"
echo -e "${YELOW_COLOR}---step1:合并代碼---${RES}"
git pull origin master
echo -e "${BLUE_COLOR}合并代碼成功 ${RES}\n"
echo -e "${YELOW_COLOR}---step2:編譯---${RES}"
go build
echo -e "${BLUE_COLOR}編譯完成 ${RES}\n"
echo -e "${YELOW_COLOR}---step3:更改權限---${RES}"
chmod -R 777 shop
echo -e "${BLUE_COLOR}更改權限完成 ${RES}\n"
echo -e "${YELOW_COLOR}---step4:殺掉進程并且運行---${RES}"
i1=$(ps -ef | grep -E "shop" | grep -v grep | awk '{print $2}')
echo -e "${BLUE_COLOR}殺掉進程 $i1${RES}\n"
kill -9 $i1 && nohup ./shop >/dev/null 2>&1 &
i2=$(ps -ef | grep -E "shop" | grep -v grep | awk '{print $2}')
echo -e "${GREEN_COLOR}****部署成功,部署的進程ID為:$i2${RES}****"
學習資料
下面是建議大家動手實踐的學習資料：
GitHub：基于GoFrame搭建的電商前后臺系統API[3]
GoFrame學習專欄[4]
GoFrame官方文檔[5]
Github：GoFrame入門官方示例項目[6]
總結
通過這篇文章我們基于GoFrame框架搭建了一個電商系統的前后臺API，實踐了如何集成gtoken實現登錄，如何自定義中間件和服務，如何定義路由組，如何上傳文件到云平臺，以及在開發的過程中如何實現自動編譯，當項目開發完畢，如何一鍵部署到遠程服務器。
歡迎大家動手實踐，歡迎在評論區探討。
關于版本
這期內容介紹的是基于GoFramev1.16版本開源的項目：https://github.com/wangzhongyang007/goframe-shop/
目前GoFrame的最新版本是v2.4，我也基于最新版本開源了電商實戰項目：https://github.com/wangzhongyang007/goframe-shop-v2
歡迎大家star這兩個開源項目，也歡迎大家給我提優化建議。
相關資料
[1]基礎薄弱的小伙伴可以先實踐官方示例: https://goframe.org/pages/viewpage.action?pageId=57183756
[2]GitHub基于GoFrame搭建的電商前后臺系統API: https://github.com/wangzhongyang007/goframe-shop/
[3]GitHub：基于GoFrame搭建的電商前后臺系統API: https://github.com/wangzhongyang007/goframe-shop/tree/master
[4]GoFrame學習專欄: https://juejin.cn/column/7146133427706658847
[5]GoFrame官方文檔: https://goframe.org/pages/viewpage.action?pageId=1114119
[6]Github：GoFrame入門官方示例項目: https://github.com/gogf/gf-demo-user
本文轉載自微信公眾號「 程序員升級打怪之旅」，作者「王中陽Go」，可以通過以下二維碼關注。
轉載本文請聯系「 程序員升級打怪之旅」公眾號。
