爲什麼使用go-zero
可以有第三個選擇
- golang圈子不大,微服務框架框架屈指可數:除了go-micro、go-kit,幾乎沒有其他選擇。go-zero爲此提供第三個可能。
- go-micro 對webapi支持並不友好,需要運行micro指令,難以定製
創業產品需要一款支持業務成長的框架
我們到底需要什麼樣的框架?我們需要一款可以支持業務成長的框架!產品運營初期,比如需求驗證階段,我們並不需要採取微服務架構,因爲運營成本太高。一款單體應用足以應付。隨着業務發展,微服務成爲必要,此時我們希望不進行太多的代碼工作量,柔性升級。這正是go-zero價值所在
go-zero是什麼
以下安利是copy的的,具體參考https://github.com/tal-tech/go-zero
go-zero是一個集成了各種工程實踐的包含web和rpc框架,有如下主要特點:
- 強大的工具支持,儘可能少的代碼編寫
- 極簡的接口
- 完全兼容net/http
- 支持中間件,方便擴展
- 高性能
- 面向故障編程,彈性設計
- 內建服務發現、負載均衡
- 內建限流、熔斷、降載,且自動觸發,自動恢復
- API參數自動校驗
- 超時級聯控制
- 自動緩存控制
- 鏈路跟蹤、統計報警等
- 高併發支撐,穩定保障了曉黑板疫情期間每天的流量洪峯
怎麼用
在閱讀本文檔前,請將golang 升級到go14
及以上版本,並開啓go module支持,GO14以上只是爲了支持Gorm
export GOPROXY=https://goproxy.io,direct
export GO111MODULE=on
安裝goctl
goctl是go-zero配套的代碼生成器,偷懶神器,畢竟寫代碼大多時間是體力活
如何安裝呢?先把源代碼下載下來吧!
git clone https://github.com/tal-tech/go-zero
cd go-zero/tools/goctl
go build goctl.go
最後生成goctl.exe 複製到$gopath/bin
下
goctl指令說明
自行瀏覽文檔吧https://github.com/tal-tech/go-zero/blob/master/tools/goctl/goctl.md
本文用到指令如下
goctl api go -api open.api -dir .
#代碼說明如下
goctl api go -api open.api -dir .
| | | | | | |
生成api go語言 指定api模板文件 模板文件名稱 指定生成代碼存放路徑 當前文件夾
創建項目
生成go.mod文件
以如下指令創建項目
mkdir hello
cd hello
go mod init hello
定義hello.api
本文設計API如下 |描述|格式|方法|參數|返回| |----|----|----|----|----| |用戶註冊|/open/register|post|mobile:手機號,passwd:密碼,code:圖片驗證碼|id:用戶ID,token:用戶token| |用戶登錄|/open/authorization|post|mobile:手機號,passwd:密碼,code:圖片驗證碼|id:用戶ID,token:用戶token| |圖片驗證碼請求|/open/verify|get|ticket:圖片驗證碼的id|data:base64格式的圖片|
根據以上描述,書寫api的模板文件如下
type (
UserOptReq struct {
mobile string `json:"mobile"`
passwd string `json:"passwd"`
code string `json:"code"`
}
UserOptResp struct {
id uint `json:"id"`
token string `json:"token"`
}
//圖片驗證碼支持
VerifyReq struct {
ticket string `json:"ticket"`
}
//圖片驗證碼支持
VerifyResp struct {
data string `json:"data"`
}
)
service open-api {
@doc(
summary: 公開的api函數
desc: >
register 用戶註冊,
authorization 用戶登錄,
verify 圖片驗證碼接口
)
@server(
handler: registerHandler
folder: open
)
post /open/register(UserOptReq) returns(UserOptResp)
@server(
handler: authorizationHandler
folder: open
)
post /open/authorization(UserOptReq) returns(UserOptResp)
@server(
handler: verifyHandler
folder: open
)
post /open/verify(VerifyReq) returns(VerifyResp)
}
注意
- 一個文件裏面只能有一個service
- 工具最後會以type裏面模型爲樣板生成各種結構體,所以參數和結構體保持一致即可
- 如果我們需要分文件夾管理業務, 可以用folder屬性來定義
生成代碼
採用如下指令生成代碼
goctl api go -api open.api -dir .
最後代碼結構如下
#tree /F /A
| go.mod
| go.sum
| hello.api
| open.go
|
+---etc
| open-api.yaml
|
\---internal
+---config
| config.go
|
+---handler
| | routes.go
| |
| \---open
| authorizationhandler.go
| registerhandler.go
| verifyhandler.go
|
+---logic
| \---open
| authorizationlogic.go
| registerlogic.go
| verifylogic.go
|
+---svc
| servicecontext.go
|
\---types
types.go
運行一下
go run open.go
測試一下
curl http://127.0.0.1:8888/open/register -X POST -H "Content-Type: application/json" -d {\"mobile\":\"15367151352\",\"passwd\":\"testpwd\",\"code\":\"asdf\"}
{"id":0,"token":""}
集成明星產品Gorm V2
金珠大佬升級了Gorm V2集成測試一下吧
配置文件
配置文件在etc/open-api.yaml
Name: open-api
Host: 0.0.0.0
Port: 8888
DataSourceName: root:1D007648b4f8@(127.0.0.1:3306)/gozero?charset=utf8
在etc/open-api.yaml
中添加參數DataSourceName, 在internal/config/config.go
中添加DataSourceName
type Config struct {
rest.RestConf
DataSourceName string
}
關於配置文件,系統內置了一部分關鍵字 如Cache,資料不多;基本上可以隨便配置,然後在Conf中定義同名變量即可。
啓動Gorm支持
修改svc/servicecontext.go
代碼如下
package svc
import (
"hello/internal/config"
"hello/internal/models"
"gorm.io/driver/mysql"
"gorm.io/gorm"
"gorm.io/gorm/schema"
)
type ServiceContext struct {
Config config.Config
DbEngin *gorm.DB
}
func NewServiceContext(c config.Config) *ServiceContext {
//啓動Gorm支持
db, err := gorm.Open(mysql.Open(c.DataSourceName), &gorm.Config{
NamingStrategy: schema.NamingStrategy{
TablePrefix: "tech_", // 表名前綴,`User` 的表名應該是 `t_users`
SingularTable: true, // 使用單數表名,啓用該選項,此時,`User` 的表名應該是 `t_user`
},
})
//如果出錯就GameOver了
if err != nil {
panic(err)
}
//自動同步更新表結構,不要建表了O(∩_∩)O哈哈~
db.AutoMigrate(&models.User{})
return &ServiceContext{Config: c, DbEngin: db}
}
新建模型文件
新建models\models.go
文件
//models\models.go文件
package models
import (
"errors"
"hello/internal/utils"
"gorm.io/gorm"
)
type User struct {
gorm.Model
Mobile string `gorm:"index:mobile;type:varchar(13)"`
Passwd string `gorm:"type:varchar(64)"`
}
//在創建前檢驗驗證一下密碼的有效性
func (u *User) BeforeCreate(db *gorm.DB) error {
if len(u.Passwd) < 6 {
return errors.New("密碼太簡單了")
}
//對密碼進行加密存儲
u.Passwd = utils.Password(u.Passwd)
return nil
}
utils.Password是我們編寫的工具包,代碼如下
package utils
import (
"fmt"
"golang.org/x/crypto/bcrypt"
)
//密碼加密
func Password(plainpwd string) string {
//谷歌的加密包
hash, err := bcrypt.GenerateFromPassword([]byte(plainpwd), bcrypt.DefaultCost) //加密處理
if err != nil {
fmt.Println(err)
}
encodePWD := string(hash) // 保存在數據庫的密碼,雖然每次生成都不同,只需保存一份即可
return encodePWD
}
//密碼校驗
func CheckPassword(plainpwd, cryptedpwd string) bool {
err := bcrypt.CompareHashAndPassword([]byte(cryptedpwd), []byte(plainpwd)) //驗證(對比)
return err == nil
}
實現業務邏輯
在logic\open\registerlogic.go
中修改代碼如下
package logic
import (
"context"
"hello/internal/models"
"hello/internal/svc"
"hello/internal/types"
"github.com/tal-tech/go-zero/core/logx"
)
type RegisterLogic struct {
ctx context.Context
logx.Logger
svcCtx *svc.ServiceContext
}
func NewRegisterLogic(ctx context.Context, svcCtx *svc.ServiceContext) RegisterLogic {
return RegisterLogic{
ctx: ctx,
Logger: logx.WithContext(ctx),
svcCtx: svcCtx,
}
}
func (l *RegisterLogic) Register(req types.UserOptReq) (*types.UserOptResp, error) {
user := models.User{
Mobile: req.Mobile,
Passwd: req.Passwd,
}
result := l.svcCtx.DbEngin.Create(&user)
return &types.UserOptResp{
Id: user.ID,
}, result.Error
}
- RegisterLogic中添加svcCtx *svc.ServiceContext,因爲需要用到裏面的DbEngin
- NewRegisterLogic 配置svcCtx
- 在Register函數中實現邏輯
result := l.svcCtx.DbEngin.Create(&user)
測試一下
>curl http://127.0.0.1:8888/open/register -X POST -H "Content-Type: application/json" -d {\"mobile\":\"15367151352\",\"passwd\":\"testpwd\"}
{"id":3,"token":""}
期待更新的功能點
go-zero
接口定義希望支持多種content-type
UserOptReq struct {
mobile string `json:"mobile" form:"mobile" xml:"mobile"`
passwd string `json:"passwd" form:"passwd" xml:"passwd"`
code string `json:"code" form:"code" xml:"code"`
}
一種可能的解決方法是 修改github.com/tal-tech/go-zero/rest/httpx/requests.go
中的Parse
成如下模型
func Parse(r *http.Request, v interface{}) error {
if err := ParsePath(r, v); err != nil {
return err
}
if strings.Contains(r.Header.Get(ContentType), multipartFormData) {
return ParseForm(r, v)
} else if strings.Contains(r.Header.Get(ContentType), urlencodeformdata) {
return ParseForm(r, v)
} else if strings.Contains(r.Header.Get(ContentType), applicationjson) {
return ParseJsonBody(r, v)
} else {
return errors.New("不支持的請求類型")
}
}
支持一個文件多個方法
比如如下寫法,則生成倆個方法在verifyHandler.go文件中
@server(
handler: verifyHandler
folder: open
)
post /open/verify(VerifyReq) returns(VerifyResp)
post /open/authorization(UserOptReq) returns(UserOptResp)
gorm v2
建議默認SingularTable
屬性爲true
NamingStrategy: schema.NamingStrategy{
TablePrefix: "tech_", // 表名前綴,`User` 的表名應該是 `t_users`
SingularTable: true, // 使用單數表名,啓用該選項,此時,`User` 的表名應該是 `t_user`
},
建議增強緩存功能
建議提供緩存如redis/memcache/內存緩存支持
本文代碼獲取
關注公衆號betaidea
輸入gozero或者gormv2即可獲得
廣而告之
送福利了uniapp用戶福音來啦! 歷經數十萬用戶考驗,我們的客服系統終於對外提供服務了。 你還在爲商城接入客服煩惱嗎?只需一行代碼,即可接入啦!! 只需一行代碼!!!!
/*kefu.vue*/
<template>
<view>
<IdeaKefu :siteid="siteId" ></IdeaKefu>
</view>
</template>
<script>
import IdeaKefu from "@/components/idea-kefu/idea-kefu.vue"
export default {
components:{
IdeaKefu
},
data() {
return {
siteId:2
}
}
}
效果槓槓的