jspstructstags构建微办事的十年夜 Go 框架/库

现在，很多开源库都支持构建运用程序。
我该当向你推举一些库，它们可以帮助启动具有大略设计、干净代码和良好性能的项目。

01 CLI 命令(spf13/cobra)

你想要构建一些 CLI 命令吗？

Cobra 既是一个用于创建强大的当代 CLI 运用程序的库，也是一个用于天生运用程序和命令文件的程序。

jspstructstags构建微办事的十年夜 Go 框架/库 GraphQL

我利用这个库来管理命令运用程序，实行运行程序，初始化配置，并启动 Rest API。

基于 cobra 的运用组织构造：

├──app│├──main.go│├──cmd│└──root.go

app/main.go 的代码如下：

packagemainimport("app/cmd")funcmain(){cmd.Execute()}

app/cmd/root.go 代码如下：

packagecmdvarrootCmd=&cobra.Command{Use:"hugo",Short:"Hugoisaveryfaststaticsitegenerator",Long:`AFastandFlexibleStaticSiteGeneratorbuiltwithlovebyspf13andfriendsinGo.Completedocumentationisavailableathttp://hugo.spf13.com`,Run:func(cmdcobra.Command,args[]string){//DoStuffHere},}funcExecute(){iferr:=rootCmd.Execute();err!=nil{fmt.Println(err)os.Exit(1)}}

项目地址：https://github.com/spf13/cobra。

02 配置读取器(spf13/viper)

Viper 是 Go 运用程序的完全配置办理方案。

Viper 支持以下格式配置：

JSONTOMLYAMLHCLINIenvfileJava properties config files

例如 config/config.toml：

address="localhost"port="9090"

相应操作的文件 config.go：

funcReadConfig(){viper.SetConfigName("config/config.toml")viper.SetConfigType("toml")err:=viper.ReadInConfig()iferr!=nil{panic(fmt.Errorf("Fatalerrorconfigfile:%s\n",err))}}

然后在 main.go 中利用 config 的值：

funcmain(){address:=viper.Get("address")port:=viper.Get("port")fmt.Printf("address:%s",address)fmt.Printf("port:%s",port)}

项目地址：https://github.com/spf13/viper。

03 Web 框架(labstack/echo)

Echo 是一个高性能、极简主义的 Go Web 框架。

安装

//gogetgithub.com/labstack/echo/{version}gogetgithub.com/labstack/echo/v4

例子

packagemainimport("net/http""github.com/labstack/echo/v4""github.com/labstack/echo/v4/middleware")funcmain(){//Echoinstancee:=echo.New()//Middlewaree.Use(middleware.Logger())e.Use(middleware.Recover())//Routese.GET("/",hello)//Startservere.Logger.Fatal(e.Start(":1323"))}//Handlerfunchello(cecho.Context)error{returnc.String(http.StatusOK,"Hello,World!")}

项目地址：https://github.com/labstack/echo。

04 依赖注入(uber-go/fx)

我创造这个库非常有用，你不须要天生任何东西。
只有代码。
非常模块化和清晰的层次。

一个依赖注入的 Go 运用框架。

funcmain(){fx.New(injectModule()).Run()}funcinjectModule()fx.Option{returnfx.Options(fx.Provide(NewTimeOutContext,NewDbConn,),repository.Module,service.Module,outbound.Module,server.Module,controller.Module,)}

项目地址：https://github.com/uber-go/fx。

04 Swagger Generator, UI 和 Validation

在 swagger 部分，我必须利用不同的 3 个库，由于我没有找到 1 个库同时包含这个 3 个库功能的。
如果你有推举，请评论奉告。

a、Swagger generator (swaggo/swag)

Swag 将 Go 注释转换为 Swagger Documentation 2.0。

我们为盛行的 Go Webb 框架[1]创建了各种各样的插件。
这许可你快速集成一个现有的 Go 项目（利用 Swagger UI）。

支持的 Web 框架：

ginechobuffalonet/http

Swag 已经处理了你那些 swagger 文件。
以是你不再须要写 swagger.yml 或 swagger.json。
你须要做的只是编写注释。
看一个例子：

//@titleBlueprintSwaggerAPI//@version1.0//@descriptionSwaggerAPIforGolangProjectBlueprint.//@termsOfServicehttp://swagger.io/terms///@contact.nameAPISupport//@contact.emailmartin7.heinz@gmail.com//@license.nameMIT//@license.urlhttps://github.com/MartinHeinz/go-project-blueprint/blob/master/LICENSE//@BasePath/api/v1funcmain(){...r.GET("/swagger/any",ginSwagger.WrapHandler(swaggerFiles.Handler))...}

项目地址：https://github.com/swaggo/swag。

b、Swagger UI (swaggo/echo-swagger)

由于我正在利用 echo，以是我为 swagger 选择了这个 user interface。

利用示例：

packagemainimport("github.com/labstack/echo/v4""github.com/swaggo/echo-swagger"_"github.com/swaggo/echo-swagger/example/docs"//docsisgeneratedbySwagCLI,youhavetoimportit.)//@titleSwaggerExampleAPI//@version1.0//@descriptionThisisasampleserverPetstoreserver.//@termsOfServicehttp://swagger.io/terms///@contact.nameAPISupport//@contact.urlhttp://www.swagger.io/support//@contact.emailsupport@swagger.io//@license.nameApache2.0//@license.urlhttp://www.apache.org/licenses/LICENSE-2.0.html//@hostpetstore.swagger.io//@BasePath/v2funcmain(){e:=echo.New()e.GET("/swagger/",echoSwagger.WrapHandler)e.Logger.Fatal(e.Start(":1323"))}

项目地址：https://github.com/swaggo/echo-swagger。

c、Swagger validation (go-swagger/go-swagger)

这个包包含了 Swagger 2.0（别号 OpenAPI 2.0[2]）的 golang 实现: 它知道如何序列化和反序列化 Swagger 规范。

安装：

gogetgithub.com/go-swagger/go-swagger/cmd/swagger

运行以验证：

swaggervalidateapi/docs/swagger.yaml

输出如下：

2021/01/3022:47:01Theswaggerspecat"api/docs/swagger.yaml"isvalidagainstswaggerspecification2.0

项目地址：https://github.com/go-swagger/go-swagger。

06、自定义 Logger (sirupsen/logrus)

Logrus 是 Go (golang)的构造化 Logger，完备兼容标准库 Log。

例子：

packagemainimport(log"github.com/sirupsen/logrus")funcmain(){log.WithFields(log.Fields{"animal":"walrus",}).Info("Awalrusappears")}

项目地址：https://github.com/sirupsen/logrus。

07、Mock 天生器 (vektra/mockery)

一个 Mock 代码自动天生器

安装：

gogetgithub.com/vektra/mockery/v2/.../

天生 mock：

./bin/mockery--all

输出：

项目地址：https://github.com/vektra/mockery。

08、Migrate (golang-migrate/migrate)

用 Go 编写的数据库迁移工具。
作为 CLI[3] 利用或作为库[4]导入。

支持如下数据库：

PostgreSQLRedshiftQlCassandraSQLite (todo #165)SQLCipherMySQL/ MariaDBNeo4jMongoDBCrateDB (todo #170)Shell (todo #171)Google Cloud SpannerCockroachDBClickHouseFirebirdMS SQL Server

安装：

$goget-u-dgithub.com/golang-migrate/migrate/cmd/migrate

创建迁移文件：

migratecreate-extsql-dirdatabase/migrations-seqcreate_user

运行升级版本：

migrate-database"mysql://user:pass@tcp(localhost:3600)/user"-path=database/migrationsup

降版本：

migrate-database"mysql://user:pass@tcp(localhost:3600)/user"-path=database/migrationsdown

项目地址：< https://github.com/golang-migrate/migrate>。

09、Messaging (NSQ)

NSQ 拓扑：

NSQ 组件：

nsqlookupd (daemon manage topologies / routes)nsqd (daemon manage receives, queues, and delivers messages)nsqadmin (default Web UI of 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"

实行：

Torundocker:$docker-composeup-dorifusename(docker-compose-nsq.yml):$docker-compose-fdocker-compose-nsq.ymlup-dTocheckcontainerdocker:$docker-composepsToseelogs:$docker-composelogsTochecknsqwebui:(assumingportis32770)$curlhttp://127.0.0.1:32770/ping

Go 代码目录：

CreateFolder:├──consume│└──consume.go└──publish└──publish.go

consume.go 代码：

packagemainimport("log""sync""github.com/nsqio/go-nsq")funcmain(){wg:=&sync.WaitGroup{}wg.Add(1)decodeConfig:=nsq.NewConfig()c,err:=nsq.NewConsumer("My_NSQ_Topic","My_NSQ_Channel",decodeConfig)iferr!=nil{log.Panic("Couldnotcreateconsumer")}c.AddHandler(nsq.HandlerFunc(func(messagensq.Message)error{log.Println("NSQmessagereceived:")log.Println(string(message.Body))returnnil}))err=c.ConnectToNSQD("127.0.0.1:4150")iferr!=nil{log.Panic("Couldnotconnect")}log.Println("AwaitingmessagesfromNSQtopic\"MyNSQTopic\"...")wg.Wait()}

运行 consume.go：

$gorunconsume/consume.go

publish.go 代码：

packagemainimport("log""github.com/nsqio/go-nsq")funcmain(){config:=nsq.NewConfig()p,err:=nsq.NewProducer("127.0.0.1:4150",config)iferr!=nil{log.Panic(err)}err=p.Publish("My_NSQ_Topic",[]byte("sampleNSQmessage"))iferr!=nil{log.Panic(err)}}

运行 publish：

$gorunpublish/publish.go

项目地址：https://github.com/nsqio/go-nsq。

10、SQL (jmoiron/sqlx)

sqlx 是一个库，它为 go 的标准 database/sql 库供应了一组扩展。

我喜好的 sqlx 是由于它们可以 scan 构造！
利用大略。

StrucScan 的例子：

place:=Place{}rows,err:=db.Queryx("SELECTFROMplace")forrows.Next(){err:=rows.StructScan(&place)iferr!=nil{log.Fatalln(err)}fmt.Printf("%#v\n",place)}

项目地址：https://github.com/jmoiron/sqlx。

11、附加的一些库

1）Go routine grouping (sync/errgroup)：https://pkg.go.dev/golang.org/x/sync/errgroup

2）Fluent SQL generation for golang (Masterminds/squirrel)：https://github.com/Masterminds/squirrel

3）Golang Linter (golangci/golangci-lint)：https://github.com/golangci/golangci-lint

4）Circuit Breaker (gojek/heimdall)：https://github.com/gojek/heimdall

5）Go tool generate tags (fatih/gomodifytags)：https://github.com/fatih/gomodifytags

12、总结

要构建运用程序，我们该当知道有什么功能，特殊是如果我们是团队协作，建议利用可读性强的代码，这样在成为遗留代码之前（大概 5-10 年之后），代码可以更随意马虎掩护。

构建运用程序的三个关键：

大略设计（项目构造和依赖关系）Clean Code (可读性和可掩护性)Modular（模块化） (Solid & flexible skeleton)

为了封装所有这些库，我有一个模板或框架项目，其设计大略，代码清晰。
看看这个：https://github.com/kecci/goscription。