构建微服务的十大 Golang 框架和库

架构头条 2021-02-23 11:27
作者 | Kecci Kun
译者 | Sambodhi
策划 | 田晓旭
现在已经有很多开源库 golang 支持构建应用程序,这些库设计简单,代码干净,性能良好,本文为大家精心挑选了十个实用的框架和库。
1CLI 命令 (spf13/cobra)

你想生成一些 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) {      // Do Stuff Here   },}func Execute() {   if err := rootCmd.Execute(); err != nil {      fmt.Println(err)      os.Exit(1)   }}

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

2配置读取器 (spf13/viper)

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

3Web 框架 (labstack/echo)

高性能、极简主义的 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() {  // Echo instance  e := echo.New()  // Middleware  e.Use(middleware.Logger())  e.Use(middleware.Recover())  // Routes  e.GET("/", hello)  // Start server  e.Logger.Fatal(e.Start(":1323"))}// Handlerfunc hello(c echo.Context) error {  return c.String(http.StatusOK, "Hello, World!")}
4依赖注入 (uber-go/fx)

我发现这个库非常有用,你不需要生成任何东西。只是代码。非常模块化,层次清晰。

一个基于依赖注入的 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

5Swagger 生成器、UI 和验证

在 swagger 部分,我必须使用不同的 3 个库,因为我找不到任何一个库可以在一个库中包含 3 个库。

 a. Swagger 生成器 (swaggo/swag)

Swag 将 Go 注释转换为 Swagger 文档 2.0。

我们已经为流行的 Go Web 框架 创建了各种插件。这使你可以快速地与现有的 Go 项目集成(使用 Swagger UI)。

支持的 Web 框架:

  • gin

  • echo

  • buffalo

  • net/http

Swag 已经处理了你的 swagger 文档。所以你不再需要写swagger.ymlswagger.json。你需要做的就是写注释。这是一个例子:

// @title Blueprint Swagger API// @version 1.0// @description Swagger API for Golang Project Blueprint.// @termsOfService http://swagger.io/terms/// @contact.name API Support// @contact.email martin7.heinz@gmail.com// @license.name MIT// @license.url https://github.com/MartinHeinz/go-project-blueprint/blob/master/LICENSE// @BasePath /api/v1func 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" // docs is generated by Swag CLI, you have to import it.)// @title Swagger Example API// @version 1.0// @description This is a sample server Petstore server.// @termsOfService http://swagger.io/terms/// @contact.name API Support// @contact.url http://www.swagger.io/support// @contact.email support@swagger.io// @license.name Apache 2.0// @license.url http://www.apache.org/licenses/LICENSE-2.0.html// @host petstore.swagger.io// @BasePath /v2func 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.0

go-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

7模拟生成器 (vektra/mockery)

Golang 的模拟代码自动生成器

安装:

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

生成模拟:

./bin/mockery --all

输出:

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 down

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

9消息传递 (NSQ)

NSQ 拓扑:

NSQ 组件:

  • nsqlookupd (守护进程管理拓扑 / 路由)

  • nsqd(守护进程管理接收、排队和传递消息)

  • nsqadmin(nsq 的默认 Web UI)

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.go

consume.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.go

publish.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.go

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

10SQL (jmoiron/sqlx)

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

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

 今日文章推荐:

快狗打车的业务架构设计迭代实践

点个在看少个 bug 👇