你想生成一些 CLI 命令嗎?
Cobra 既是一個創建強大的現代 CLI 應用程式的庫,也是一個生成應用程式和命令文件的程序。
我使用這個庫來管理命令應用程式,執行 runner 應用程式,初始化配置,並啟動 Rest API。
基於 Cobra 的應用組織結構:
├── app│ ├── main.go│ ├── cmd│ └── root.go在 app/main.go 中:
package mainimport ( "app/cmd")func main() { cmd.Execute()}在 app/cmd/root.go 中:
package cmdvar rootCmd = &cobra.Command{ Use: "hugo", Short: "Hugo is a very fast static site generator", Long: `A Fast and Flexible Static Site Generator built with love by spf13 and friends in Go. Complete documentation is available at http://hugo.spf13.com`, Run: func(cmd *cobra.Command, args []string) { },}func Execute() { if err := rootCmd.Execute(); err != nil { fmt.Println(err) os.Exit(1) }}Cobra:https://github.com/spf13/cobra
Viper 是一個完整的 Go 應用配置解決方案。
Viper 可以讀取以下內容:
JSON
TOML
YAML
HCL
INI
envfile 以及Java 屬性配置文件
示例 config/config.toml :
address="localhost"port="9090"讀取 config.go:
func ReadConfig() { viper.SetConfigName("config/config.toml") viper.SetConfigType("toml") err := viper.ReadInConfig() if err != nil { panic(fmt.Errorf("Fatal error config file: %s \n", err)) }}在 main.go 中使用 config 中的 value:
func main() { address := viper.Get("address") port := viper.Get("port") fmt.Printf("address: %s", address) fmt.Printf("port: %s", port)}Viper:https://github.com/spf13/viper
高性能、極簡主義的 Go Web 框架
安裝:
// go get github.com/labstack/echo/{version}go get github.com/labstack/echo/v4示例:
package mainimport ( "net/http" "github.com/labstack/echo/v4" "github.com/labstack/echo/v4/middleware")func main() { e := echo.New() e.Use(middleware.Logger()) e.Use(middleware.Recover()) e.GET("/", hello) e.Logger.Fatal(e.Start(":1323"))}func hello(c echo.Context) error { return c.String(http.StatusOK, "Hello, World!")}我發現這個庫非常有用,你不需要生成任何東西。只是代碼。非常模塊化,層次清晰。
一個基於依賴注入的 Go 應用框架。
func main() { fx.New(injectModule()).Run()}func injectModule() fx.Option { return fx.Options( fx.Provide( NewTimeOutContext, NewDbConn, ), repository.Module, service.Module, outbound.Module, server.Module, controller.Module, )}Uber-go/fx: https://github.com/uber-go/fx
在 swagger 部分,我必須使用不同的 3 個庫,因為我找不到任何一個庫可以在一個庫中包含 3 個庫。
a. Swagger 生成器 (swaggo/swag)Swag 將 Go 注釋轉換為 Swagger 文檔 2.0。
我們已經為流行的 Go Web 框架 創建了各種插件。這使你可以快速地與現有的 Go 項目集成(使用 Swagger UI)。
支持的 Web 框架:
Swag 已經處理了你的 swagger 文檔。所以你不再需要寫swagger.yml或swagger.json。你需要做的就是寫注釋。這是一個例子:
func main() { ... r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler)) ...}swaggo/swag:https://github.com/swaggo/swag
b. Swagger UI (swaggo/echo-swagger)因為我用的是 echo,所以我選擇這個作為 swagger 的用戶界面。
使用示例:
package mainimport ( "github.com/labstack/echo/v4" "github.com/swaggo/echo-swagger" _ "github.com/swaggo/echo-swagger/example/docs" )func main() { e := echo.New() e.GET("/swagger/*", echoSwagger.WrapHandler) e.Logger.Fatal(e.Start(":1323"))}swaggo/echo-swagger:https://github.com/swaggo/echo-swagger
c. Swagger 驗證 (go-swagger/go-swagger)這個包包含了 Swagger 2.0(也就是 OpenAPI 2.0)的 golang 實現:它知道如何序列化和反序列化 swagger 規範。
安裝:
go get github.com/go-swagger/go-swagger/cmd/swagger鍵入此命令以驗證:
swagger validate api/docs/swagger.yaml輸出:
2021/01/30 22:47:01 The swagger spec at "api/docs/swagger.yaml" is valid against swagger specification 2.0go-swagger/go-swagger:https://github.com/go-swagger/go-swagger
6自定義記錄器 (sirupsen/logrus)Logrus 是一個適用於 Go(golang) 的結構化記錄器,與標準庫記錄器完全 API 兼容。
示例:
package mainimport ( log "github.com/sirupsen/logrus")func main() { log.WithFields(log.Fields{ "animal": "walrus", }).Info("A walrus appears")}sirupsen/logrus:https://github.com/sirupsen/logrus
Golang 的模擬代碼自動生成器
安裝:
go get github.com/vektra/mockery/v2/.../生成模擬:
輸出:
vektra/mockery:https://github.com/vektra/mockery
8遷移 (golang-migrate/migrate)用 Go 編寫的資料庫遷移。作為 CLI 使用或作為庫導入。
資料庫驅動程序運行遷移:
PostgreSQL
Redshift
Ql
Cassandra
SQLite(todo #165)
SQLCipher
MySQL/MariaDB
Neo4j
MongoDB
CrateDB(todo #170)
Shell(todo #171)
Google Cloud Spanner
CockroachDB
ClickHouse
Firebird
MS SQL Server
安裝:
$ go get -u -d github.com/golang-migrate/migrate/cmd/migrate鍵入命令創建遷移文件:
migrate create -ext sql -dir database/migrations -seq create_user鍵入命令運行遷移:
migrate -database "mysql://user:pass@tcp(localhost:3600)/user" -path=database/migrations up鍵入命令中斷遷移:
migrate -database "mysql://user:pass@tcp(localhost:3600)/user" -path=database/migrations downgolang-migrate/migrate:https://github.com/golang-migrate/migrate
NSQ 拓撲:
NSQ 組件:
docker-compose 示例:(nsqlookupd, nsqd, nsqadmin)
version: '3'services:nsqlookupd:image: nsqio/nsqcommand: /nsqlookupdports:- "4160:4160"- "4161:4161"nsqd:image: nsqio/nsqcommand: /nsqd --lookupd-tcp-address=nsqlookupd:4160depends_on:- nsqlookupdports:- "4150:4150"- "4151:4151"nsqadmin:image: nsqio/nsqcommand: /nsqadmin --lookupd-http-address=nsqlookupd:4161depends_on:- nsqlookupdports:- "4171:4171"執行:
運行 docker:$ docker-compose up -d或者,如果使用名稱 (docker-compose-nsq.yml):$ docker-compose -f docker-compose-nsq.yml up -d檢查容器 docker:$ docker-compose ps查看日誌:$ docker-compose logs檢查 nsq Web UI(假設埠為 32770):$ curl http://127.0.0.1:32770/ping在 golang 中:
創建文件夾:├── consume│ └── consume.go└── publish └── publish.goconsume.go:
package mainimport ("log""sync""github.com/nsqio/go-nsq")func main() {wg := &sync.WaitGroup{}wg.Add(1)decodeConfig := nsq.NewConfig()c, err := nsq.NewConsumer("My_NSQ_Topic", "My_NSQ_Channel", decodeConfig)if err != nil {log.Panic("Could not create consumer")}c.AddHandler(nsq.HandlerFunc(func(message *nsq.Message) error {log.Println("NSQ message received:")log.Println(string(message.Body))return nil}))err = c.ConnectToNSQD("127.0.0.1:4150")if err != nil {log.Panic("Could not connect")}log.Println("Awaiting messages from NSQ topic \"My NSQ Topic\"...")wg.Wait()}運行 consume.go:
$ go run consume/consume.gopublish.go:
package mainimport ("log""github.com/nsqio/go-nsq")func main() {config := nsq.NewConfig()p, err := nsq.NewProducer("127.0.0.1:4150", config)if err != nil {log.Panic(err)}err = p.Publish("My_NSQ_Topic", []byte("sample NSQ message"))if err != nil {log.Panic(err)}運行 publish.go:
$ go run publish/publish.gonsqio/go-nsq:https://github.com/nsqio/go-nsq
sqlx 是一個庫,它在 Go 的標準 database/sql 庫上提供了一組擴展。
我喜歡 sqlx 的一點是它們可以進行結構掃描。快速而簡單的使用。
結構掃描示例:
place := Place{} rows, err := db.Queryx("SELECT * FROM place") for rows.Next() { err := rows.StructScan(&place) if err != nil { log.Fatalln(err) } fmt.Printf("%#v\n", place) }jmoiron/sqlx:https://github.com/jmoiron/sqlx
Go 例程分組 (sync/errgroup)
https://pkg.go.dev/golang.org/x/sync/errgroup
為 golang 生成流暢的 SQL (Masterminds/squirrel)。
https://github.com/Masterminds/squirrel
Golang Linter (golangci/golangci-lint)
https://github.com/golangci/golangci-lint
斷路器 (gojek/heimdall)
https://github.com/gojek/heimdall
Go 工具生成標籤 (fatih/gomodifytags)
https://github.com/fatih/gomodifytags
要建立應用程式,我們應該知道我們有什麼特性,特別是如果我們想建立持續的應用程式和團隊之間的合作。我建議有一個堅實的、可讀性強的代碼,這樣在成為遺留代碼之前(也許 5~10 年後),它可以更容易維護。
構建應用的 3 個關鍵:
簡單設計(項目結構和依賴關係)
乾淨的代碼(可讀和可維護)
模塊化(實心骨架和柔性骨架)
為了把這些庫都包裝起來,我有一個設計簡單、代碼乾淨的模板或骨架項目。請看:https://github.com/kecci/goscription
作者介紹:
Kecci Kun,軟體工程師。
原文連結:
https://keccikun.medium.com/top-10-framework-golang-library-to-build-microservice-391a2bb4c2cb
快狗打車的業務架構設計迭代實踐
點個在看少個 bug 👇