構建微服務的十大 Golang 框架和庫

現在已經有很多開源庫 golang 支持構建應用程序,這些庫設計簡單,代碼乾淨,性能良好,本文爲大家精心挑選了十個實用的框架和庫。

1CLI 命令 (spf13/cobra)

你想生成一些 CLI 命令嗎?

Cobra 既是一個創建強大的現代 CLI 應用程序的庫,也是一個生成應用程序和命令文件的程序。

我使用這個庫來管理命令應用程序,執行 runner 應用程序,初始化配置,並啓動 Rest API。

基於 Cobra 的應用組織結構:

1├── app
2│ ├── main.go
3│ ├── cmd
4│ └── root.go
5

在 app/main.go 中:

1package main
2import (
3   "app/cmd"
4)
5func main() {
6   cmd.Execute()
7}
8

在 app/cmd/root.go 中:

 1package cmd
 2var rootCmd = &cobra.Command{
 3   Use:   "hugo",
 4   Short: "Hugo is a very fast static site generator",
 5   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`,
 6   Run: func(cmd *cobra.Command, args []string) {
 7   },
 8}
 9func Execute() {
10   if err := rootCmd.Execute(); err != nil {
11      fmt.Println(err)
12      os.Exit(1)
13   }
14}
15

Cobra:https://github.com/spf13/cobra

2 配置讀取器 (spf13/viper)

Viper 是一個完整的 Go 應用配置解決方案。

Viper 可以讀取以下內容:

示例 config/config.toml :

1address="localhost"
2port="9090"
3

讀取 config.go:

1func ReadConfig() {
2   viper.SetConfigName("config/config.toml")
3   viper.SetConfigType("toml")
4   err := viper.ReadInConfig()
5   if err != nil {
6      panic(fmt.Errorf("Fatal error config file: %s \n", err))
7   }
8}
9

在 main.go 中使用 config 中的 value:

1func main() {
2   address := viper.Get("address")
3   port := viper.Get("port")
4   fmt.Printf("address: %s", address)
5   fmt.Printf("port: %s", port)
6}
7

Viper:https://github.com/spf13/viper

3Web 框架 (labstack/echo)

高性能、極簡主義的 Go Web 框架

安裝:

1// go get github.com/labstack/echo/{version}
2go get github.com/labstack/echo/v4
3

示例:

 1package main
 2import (
 3  "net/http"
 4  "github.com/labstack/echo/v4"
 5  "github.com/labstack/echo/v4/middleware"
 6)
 7func main() {
 8  e := echo.New()
 9  e.Use(middleware.Logger())
10  e.Use(middleware.Recover())
11  e.GET("/", hello)
12  e.Logger.Fatal(e.Start(":1323"))
13}
14func hello(c echo.Context) error {
15  return c.String(http.StatusOK, "Hello, World!")
16}
17

4 依賴注入 (uber-go/fx)

我發現這個庫非常有用,你不需要生成任何東西。只是代碼。非常模塊化,層次清晰。

一個基於依賴注入的 Go 應用框架。

 1func main() {
 2    fx.New(injectModule()).Run()
 3}
 4func injectModule() fx.Option {
 5    return fx.Options(
 6        fx.Provide( 
 7             NewTimeOutContext, 
 8             NewDbConn, 
 9        ),
10        repository.Module, 
11        service.Module, 
12        outbound.Module, 
13        server.Module, 
14        controller.Module,
15    )
16}
17

Uber-go/fx: https://github.com/uber-go/fx

5Swagger 生成器、UI 和驗證

在 swagger 部分,我必須使用不同的 3 個庫,因爲我找不到任何一個庫可以在一個庫中包含 3 個庫。

a. Swagger 生成器 (swaggo/swag)

Swag 將 Go 註釋轉換爲 Swagger 文檔 2.0。

我們已經爲流行的 Go Web 框架 創建了各種插件。這使你可以快速地與現有的 Go 項目集成(使用 Swagger UI)。

支持的 Web 框架:

Swag 已經處理了你的 swagger 文檔。所以你不再需要寫swagger.ymlswagger.json。你需要做的就是寫註釋。這是一個例子:

1func main() {
2    ...
3    r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
4    ...
5}
6

swaggo/swag:https://github.com/swaggo/swag

b. Swagger UI (swaggo/echo-swagger)

因爲我用的是 echo,所以我選擇這個作爲 swagger 的用戶界面。

使用示例:

 1package main
 2import (
 3    "github.com/labstack/echo/v4"
 4    "github.com/swaggo/echo-swagger"
 5    _ "github.com/swaggo/echo-swagger/example/docs" 
 6)
 7func main() {
 8    e := echo.New()
 9    e.GET("/swagger/*", echoSwagger.WrapHandler)
10    e.Logger.Fatal(e.Start(":1323"))
11}
12

swaggo/echo-swagger:https://github.com/swaggo/echo-swagger

c. Swagger 驗證 (go-swagger/go-swagger)

這個包包含了 Swagger 2.0(也就是 OpenAPI 2.0)的 golang 實現:它知道如何序列化和反序列化 swagger 規範。

安裝:

1go get github.com/go-swagger/go-swagger/cmd/swagger
2

鍵入此命令以驗證:

1swagger validate api/docs/swagger.yaml
2

輸出:

12021/01/30 22:47:01 
2The swagger spec at "api/docs/swagger.yaml" is valid against swagger specification 2.0
3

go-swagger/go-swagger:https://github.com/go-swagger/go-swagger

6 自定義記錄器 (sirupsen/logrus)

Logrus 是一個適用於 Go(golang) 的結構化記錄器,與標準庫記錄器完全 API 兼容。

示例:

 1package main
 2import (
 3  log "github.com/sirupsen/logrus"
 4)
 5func main() {
 6  log.WithFields(log.Fields{
 7    "animal": "walrus",
 8  }).Info("A walrus appears")
 9}
10

sirupsen/logrus:https://github.com/sirupsen/logrus

7 模擬生成器 (vektra/mockery)

Golang 的模擬代碼自動生成器

安裝:

1go get github.com/vektra/mockery/v2/.../
2

生成模擬:

1./bin/mockery 
2

輸出:

vektra/mockery:https://github.com/vektra/mockery

8 遷移 (golang-migrate/migrate)

用 Go 編寫的數據庫遷移。作爲 CLI 使用或作爲庫導入。

數據庫驅動程序運行遷移:

安裝:

1$ go get -u -d github.com/golang-migrate/migrate/cmd/migrate
2

鍵入命令創建遷移文件:

1migrate create -ext sql -dir database/migrations -seq create_user
2

鍵入命令運行遷移:

1migrate -database "mysql://user:pass@tcp(localhost:3600)/user" -path=database/migrations up
2

鍵入命令中斷遷移:

1migrate -database "mysql://user:pass@tcp(localhost:3600)/user" -path=database/migrations down
2

golang-migrate/migrate:https://github.com/golang-migrate/migrate

9 消息傳遞 (NSQ)

NSQ 拓撲:

NSQ 組件:

docker-compose 示例:(nsqlookupd, nsqd, nsqadmin)

 1version: '3'
 2services:
 3nsqlookupd:
 4image: nsqio/nsq
 5command: /nsqlookupd
 6ports:
 7- "4160:4160"
 8- "4161:4161"
 9nsqd:
10image: nsqio/nsq
11command: /nsqd --lookupd-tcp-address=nsqlookupd:4160
12depends_on:
13- nsqlookupd
14ports:
15- "4150:4150"
16- "4151:4151"
17nsqadmin:
18image: nsqio/nsq
19command: /nsqadmin --lookupd-http-address=nsqlookupd:4161
20depends_on:
21- nsqlookupd
22ports:
23- "4171:4171"
24

執行:

 1運行 docker:
 2$ docker-compose up -d
 3或者,如果使用名稱 (docker-compose-nsq.yml):
 4$ docker-compose -f docker-compose-nsq.yml up -d
 5檢查容器 docker:
 6$ docker-compose ps
 7查看日誌:
 8$ docker-compose logs
 9檢查 nsq Web UI(假設端口爲 32770):
10$ curl http://127.0.0.1:32770/ping
11

在 golang 中:

1創建文件夾:
2├── consume
3│   └── consume.go
4└── publish
5    └── publish.go
6

consume.go:

 1package main
 2import (
 3"log"
 4"sync"
 5"github.com/nsqio/go-nsq"
 6)
 7func main() {
 8wg := &sync.WaitGroup{}
 9wg.Add(1)
10decodeConfig := nsq.NewConfig()
11c, err := nsq.NewConsumer("My_NSQ_Topic", "My_NSQ_Channel", decodeConfig)
12if err != nil {
13log.Panic("Could not create consumer")
14}
15c.AddHandler(nsq.HandlerFunc(func(message *nsq.Message) error {
16log.Println("NSQ message received:")
17log.Println(string(message.Body))
18return nil
19}))
20err = c.ConnectToNSQD("127.0.0.1:4150")
21if err != nil {
22log.Panic("Could not connect")
23}
24log.Println("Awaiting messages from NSQ topic \"My NSQ Topic\"...")
25wg.Wait()
26}
27

運行 consume.go:

1$ go run consume/consume.go
2

publish.go:

 1package main
 2import (
 3"log"
 4"github.com/nsqio/go-nsq"
 5)
 6func main() {
 7config := nsq.NewConfig()
 8p, err := nsq.NewProducer("127.0.0.1:4150", config)
 9if err != nil {
10log.Panic(err)
11}
12err = p.Publish("My_NSQ_Topic", []byte("sample NSQ message"))
13if err != nil {
14log.Panic(err)
15}
16

運行 publish.go:

1$ go run publish/publish.go
2

nsqio/go-nsq:https://github.com/nsqio/go-nsq

10SQL (jmoiron/sqlx)

sqlx 是一個庫,它在 Go 的標準 database/sql 庫上提供了一組擴展。

我喜歡 sqlx 的一點是它們可以進行結構掃描。快速而簡單的使用。

結構掃描示例:

 1  place := Place{}
 2    rows, err := db.Queryx("SELECT * FROM place")
 3    for rows.Next() {
 4        err := rows.StructScan(&place)
 5        if err != nil {
 6            log.Fatalln(err)
 7        } 
 8        fmt.Printf("%#v\n", place)
 9    }
10

jmoiron/sqlx:https://github.com/jmoiron/sqlx

11 額外附加

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

12 總結

要建立應用程序,我們應該知道我們有什麼特性,特別是如果我們想建立持續的應用程序和團隊之間的合作。我建議有一個堅實的、可讀性強的代碼,這樣在成爲遺留代碼之前(也許 5~10 年後),它可以更容易維護。

構建應用的 3 個關鍵:

爲了把這些庫都包裝起來,我有一個設計簡單、代碼乾淨的模板或骨架項目。請看:https://github.com/kecci/goscription

作者介紹:

Kecci Kun,軟件工程師。

原文鏈接:

https://keccikun.medium.com/top-10-framework-golang-library-to-build-microservice-391a2bb4c2cb

本文由 Readfog 進行 AMP 轉碼,版權歸原作者所有。
來源https://mp.weixin.qq.com/s?__biz=MzU0MzQ5MDA0Mw==&mid=2247497958&idx=1&sn=6092fd4611d560e81455bd0da35f1b85&chksm=fb081272cc7f9b64b1e7317bcf89ff67b782b2e355e26f15d12445ef21dc696c114f148d3868&scene=132#wechat_redirect