為什么使用go-zero

可以有第三個選擇

• golang圈子不大,微服務(wù)框架框架屈指可數(shù):除了go-micro、go-kit,幾乎沒有其他選擇寿谴。go-zero為此提供第三個可能。
• go-micro 對webapi支持并不友好讶泰，需要運行micro指令,難以定制

創(chuàng)業(yè)產(chǎn)品需要一款支持業(yè)務(wù)成長的框架

我們到底需要什么樣的框架?我們需要一款可以支持業(yè)務(wù)成長的框架!產(chǎn)品運營初期,比如需求驗證階段，我們并不需要采取微服務(wù)架構(gòu)峻厚，因為運營成本太高。一款單體應(yīng)用足以應(yīng)付惠桃。隨著業(yè)務(wù)發(fā)展,微服務(wù)成為必要,此時我們希望不進行太多的代碼工作量，柔性升級辜王。這正是go-zero價值所在

go-zero是什么

以下安利是copy的的，具體參考https://github.com/tal-tech/go-zero
go-zero是一個集成了各種工程實踐的包含web和rpc框架呐馆，有如下主要特點：

• 強大的工具支持，盡可能少的代碼編寫
• 極簡的接口
• 完全兼容net/http
• 支持中間件汹来，方便擴展
• 高性能
• 面向故障編程改艇，彈性設(shè)計
• 內(nèi)建服務(wù)發(fā)現(xiàn)、負(fù)載均衡
• 內(nèi)建限流坟岔、熔斷、降載社付，且自動觸發(fā)，自動恢復(fù)
• API參數(shù)自動校驗
• 超時級聯(lián)控制
• 自動緩存控制
• 鏈路跟蹤鸥咖、統(tǒng)計報警等
• 高并發(fā)支撐，穩(wěn)定保障了曉黑板疫情期間每天的流量洪峰

怎么用

在閱讀本文檔前,請將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 復(fù)制到$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模板文件   模板文件名稱         指定生成代碼存放路徑     當(dāng)前文件夾

創(chuàng)建項目

生成go.mod文件

以如下指令創(chuàng)建項目

mkdir hello
cd hello
go mod init  hello

定義hello.api

本文設(shè)計API如下

根據(jù)以上描述,書寫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函數(shù)
        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里面模型為樣板生成各種結(jié)構(gòu)體,所以參數(shù)和結(jié)構(gòu)體保持一致即可
• 如果我們需要分文件夾管理業(yè)務(wù), 可以用folder屬性來定義

生成代碼

采用如下指令生成代碼

goctl api  go   -api   open.api   -dir  .

最后代碼結(jié)構(gòu)如下

#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":""}

集成明星產(chǎn)品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中添加參數(shù)DataSourceName,
在internal/config/config.go中添加DataSourceName

type Config struct {
    rest.RestConf
    DataSourceName string
}

關(guān)于配置文件,系統(tǒng)內(nèi)置了一部分關(guān)鍵字 如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` 的表名應(yīng)該是 `t_users`
            SingularTable: true,    // 使用單數(shù)表名，啟用該選項住涉，此時钠绍，`User` 的表名應(yīng)該是 `t_user`
        },
    })
    //如果出錯就GameOver了
    if err != nil {
        panic(err)
    }
    //自動同步更新表結(jié)構(gòu),不要建表了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)"`
}
//在創(chuàng)建前檢驗驗證一下密碼的有效性
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) // 保存在數(shù)據(jù)庫的密碼，雖然每次生成都不同柳爽，只需保存一份即可
    return encodePWD
}
//密碼校驗
func CheckPassword(plainpwd, cryptedpwd string) bool {
    err := bcrypt.CompareHashAndPassword([]byte(cryptedpwd), []byte(plainpwd)) //驗證（對比）
    return err == nil
}

實現(xiàn)業(yè)務(wù)邏輯

在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函數(shù)中實現(xiàn)邏輯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

建議默認(rèn)SingularTable屬性為true

NamingStrategy: schema.NamingStrategy{
            TablePrefix:   "tech_", // 表名前綴磷脯，`User` 的表名應(yīng)該是 `t_users`
            SingularTable: true,    // 使用單數(shù)表名，啟用該選項赵誓，此時，`User` 的表名應(yīng)該是 `t_user`
        },

建議增強緩存功能

建議提供緩存如redis/memcache/內(nèi)存緩存支持

本文代碼獲取

關(guān)注公眾號betaidea 輸入gozero或者gormv2即可獲得

廣而告之

送福利了uniapp用戶福音來啦俩功！
歷經(jīng)數(shù)十萬用戶考驗,我們的客服系統(tǒng)終于對外提供服務(wù)了幻枉。
你還在為商城接入客服煩惱嗎?只需一行代碼,即可接入啦!!
只需一行代碼!!!!

/*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
            }
        }
    }   

效果杠杠的

客服效果

開發(fā)文檔地址
http://kefu.techidea8.com/html/wiki/