Go-Zero微服務快速入門和最佳實踐

作者：王中陽Go 2024-04-28 14:46:55

開發架構

微服務進行服務拆分一個最好理解并且最基本的原則就是：每個服務對應一個單獨的數據庫。做到服務與服務之間的解耦，劃清邊界。

并發編程和分布式微服務是我們Gopher升職加薪的關鍵。

畢竟Go基礎很容易搞定，不管你是否有編程經驗，都可以比較快速的入門Go語言進行簡單項目的開發。

雖說好上手，但是想和別人拉開差距，提高自己的競爭力，搞懂分布式微服務和并發編程還是灰常重要的，這也是我今年簽約文章的重點。

Go-Zero

我想和大家說一下安利gozero的原因：

Go-zero [1]在GitHub中已經有27.2K的star，集成了各種工程實踐的 web 和 rpc 框架。通過彈性設計保障了大并發服務端的穩定性，經受了充分的實戰檢驗。

官網

Go-Zero官方地址[2]

一個神奇的事情，如果你直接在百度搜索gozero，前幾頁的檢索結果竟然都沒有gozero官網，而是各個技術社區作者的分享。

我建議你先認真學習Go-Zero官網資料，掃清知識盲點，然后再跟著我去實踐。

技巧 & 整體開發流程

為了吸引你繼續讀下去，我先分享技巧吧：“總結一句話：用好goctl開發就是快！”

先說技巧

goctl

能使用 goctl[3] 的一定要用 goctl , goctl 是 go-zero 的內置腳手架，是提升開發效率的一大利器，可以一鍵生成代碼、文檔、部署 k8s yaml、dockerfile 等。
gozero和go一樣也強調“少即是多”的思想，能用goctl生成的千萬不要手寫，不僅開發速度慢；在團隊開發中也難以保證統一的開發規范。
更重要的 goctl 支持我們自定義，后面我也會單獨整理文章出來，和你分享如何結合你的項目，定制適合自己的goctl，進一步提高效率。那具體goctl能生成什么呢？

api
grpc
MySQL
MongoDB
格式化
接口文檔
還支持自定義
甚至還支持生成php、Android等代碼

目錄結構

先帶你了解一下整體項目目錄，這樣你能更好的理解下文中的開發流程，這也是新手最頭疼的地方，不知道從哪里著手開發。

圖片

cmd

model model層方便cmd目錄中api和rpc調用

etc

internal

服務包名由goctl生成

main.go

desc

etc

internal

main.go

xxx.api

api api接口層對外提供服務，可以用goctl生成

rpc rpc層內部服務可以用goctl生成

user

mqueue 等不同的服務

common 服務共享的常量、工具類等統一封裝到這里
deploy 項目部署配置等比如Nginx配置
go.mod

歡迎關注我，下期內容會共享GitHub開源地址出來。

Go-Zero微服務項目開發流程

當你把go和gozero的開發環境安裝好之后，建議按照下面的順序進行開發：

首先設計數據庫和數據表
使用工具先生成model
先開發api層
再開發rpc層
在api層注冊rpc服務，調用rpc方法，對外提供接口
生成接口文檔

以上是整體的開發流程，請你按照這個順序開發，會非常清晰。

詳解

1）首先設計數據庫和數據表

微服務進行服務拆分一個最好理解并且最基本的原則就是：每個服務對應一個單獨的數據庫。做到服務與服務之間的解耦，劃清邊界。
這就要求我們明確項目（服務）需求之后，做好表結構設計。3.** 我們后續項目中用到的model、proto、甚至api層的結構體都可以通過工具根據數據庫生成，所以數據庫的設計至關重要！**

2）使用工具先生成model

使用goctl中的model命令生成即可：官網有講，不再贅述：mysql 代碼生成[4]

為了進一步提高效率，我們對此進行了封裝，方便我們更快更好的生成model，你也可以按照我們的方式來：

在項目根目錄下創建了script目錄，專門用于封裝各種常用的腳本
在script目錄下，我們創建了genModel目錄，用于生成model文件。
封裝genModel.sh腳本，內容如下：

#!/usr/bin/env bash  
  
# 使用方法：  
# ./genModel.sh 數據庫名 表名稱
# 比如：
# ./genModel.sh lottery lottery  
# 再將./genModel下的生成的文件剪切到對應服務的model目錄中即可  
  
#生成的表名  
tables=$2  
#表生成的genmodel目錄  
modeldir=./genModel  
  
# 數據庫配置  
host=127.0.0.1  
port=3306  
dbname=$1  
username=root  
passwd=xxxxx  
  
echo "開始創建庫：$dbname 的表：$2"  
goctl model mysql datasource -url="${username}:${passwd}@tcp(${host}:${port})/${dbname}" -table="${tables}" -dir="${modeldir}" -cache=true --home="${template}" --style=goZero

這樣，我們就可以很方便的使用./genModel.sh生成model，而不是需要拼接冗長的goctl命令

這個思路也同樣適用你使用goctl生成其他的代碼。

3）先開發api層

先定義xxx.api文件，可以參考 api demo 代碼生成[5]
使用goctl生成代碼：goctl api go -api main.api -dir ../ --style=goZero
配置生成代碼中的config目錄以及yaml文件，弄清它們兩者之間的聯系
配置生成代碼svc目錄中的文件（比如jwt之類的中間件）

4）再開發rpc層

再告訴你一個提效利器 sql2pb[6]，這個工具適合我們開發新服務時使用。見名之意，也就是可以把sql轉成pb文件
注意：一旦我們的xx.proto文件有自定義修改之后，就不建議使用sql2pb了。如果不使用sql2pb的話，就直接修改xxx.proto文件
使用goctl生成pb.go文件：goctl rpc protoc lottery.proto --go_out=../ --go-grpc_out=../ --zrpc_out=../ --style=goZero
配置svc，注冊model
編寫logic，調用model，寫業務代碼

5）在api層注冊rpc服務，調用rpc方法

api層配置svc，注冊rpc客戶端
調用rpc方法
返回restful api

6）生成接口文檔

注意：雖然goctl不直接支持生成swagger，但是goctl的插件支持。- goctl-swagger[7] 通過 api 文件生成 swagger 文檔
安裝好goctl-swagger插件之后，我們就可以在api層的xxx.api同級目錄下生成swagger了
參考命令如下：其中main.api是我在api層的desc目錄中定義的，我們也在同級目錄執行goctl命令即可：
goctl api plugin -plugin goctl-swagger="swagger -filename main.json" -api main.api -dir .

圖片