构建微服务的十大 Go 框架/库
liuian 2024-12-08 16:20 43 浏览
现在,很多开源库都支持构建应用程序。我应该向你推荐一些库,它们可以帮助启动具有简单设计、干净代码和良好性能的项目。
01 CLI 命令(spf13/cobra)
你想要构建一些 CLI 命令吗?
Cobra 既是一个用于创建强大的现代 CLI 应用程序的库,也是一个用于生成应用程序和命令文件的程序。
我使用这个库来管理命令应用程序,执行运行程序,初始化配置,并启动 Rest API。
基于 cobra 的应用组织结构:
├── app
│ ├── main.go
│ ├── cmd
│ └── root.go
app/main.go 的代码如下:
package main
import (
"app/cmd"
)
func main() {
cmd.Execute()
}
app/cmd/root.go 代码如下:
package cmd
var 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)
}
}
项目地址:https://github.com/spf13/cobra。
02 配置读取器(spf13/viper)
Viper 是 Go 应用程序的完整配置解决方案。
Viper 支持以下格式配置:
- JSON
- TOML
- YAML
- HCL
- INI
- envfile
- Java properties config files
例如 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 的值:
func main() {
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 框架。
安装
// go get github.com/labstack/echo/{version}
go get github.com/labstack/echo/v4
例子
package main
import (
"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"))
}
// Handler
func hello(c echo.Context) error {
return c.String(http.StatusOK, "Hello, World!")
}
项目地址:https://github.com/labstack/echo。
04 依赖注入(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,
)
}
项目地址: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 框架:
- gin
- echo
- buffalo
- net/http
Swag 已经处理了你那些 swagger 文件。所以你不再需要写 swagger.yml 或 swagger.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/v1
func main() {
...
r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
...
}
项目地址:https://github.com/swaggo/swag。
b、Swagger UI (swaggo/echo-swagger)
因为我正在使用 echo,所以我为 swagger 选择了这个 user interface。
使用示例:
package main
import (
"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 /v2
func main() {
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 规范。
安装:
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
项目地址:https://github.com/go-swagger/go-swagger。
06、自定义 Logger (sirupsen/logrus)
Logrus 是 Go (golang)的结构化 Logger,完全兼容标准库 Log。
例子:
package main
import (
log "github.com/sirupsen/logrus"
)
func main() {
log.WithFields(log.Fields{
"animal": "walrus",
}).Info("A walrus appears")
}
项目地址:https://github.com/sirupsen/logrus。
07、Mock 生成器 (vektra/mockery)
一个 Mock 代码自动生成器
安装:
go get github.com/vektra/mockery/v2/.../
生成 mock:
./bin/mockery --all
输出:
项目地址:https://github.com/vektra/mockery。
08、Migrate (golang-migrate/migrate)
用 Go 编写的数据库迁移工具。作为 CLI[3] 使用或作为库[4]导入。
支持如下数据库:
- 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
安装:
nbsp;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
项目地址:< 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/nsq
command: /nsqlookupd
ports:
- "4160:4160"
- "4161:4161"
nsqd:
image: nsqio/nsq
command: /nsqd --lookupd-tcp-address=nsqlookupd:4160
depends_on:
- nsqlookupd
ports:
- "4150:4150"
- "4151:4151"
nsqadmin:
image: nsqio/nsq
command: /nsqadmin --lookupd-http-address=nsqlookupd:4161
depends_on:
- nsqlookupd
ports:
- "4171:4171"
执行:
To run docker:
nbsp;docker-compose up -d
or if use name (docker-compose-nsq.yml):
nbsp;docker-compose -f docker-compose-nsq.yml up -d
To check container docker:
nbsp;docker-compose ps
To see logs:
nbsp;docker-compose logs
To check nsq web ui: (assuming port is 32770)
nbsp;curl http://127.0.0.1:32770/ping
Go 代码目录:
Create Folder:
├── consume
│ └── consume.go
└── publish
└── publish.go
consume.go 代码:
package main
import (
"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:
nbsp;go run consume/consume.go
publish.go 代码:
package main
import (
"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:
nbsp;go run publish/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("SELECT * FROM place")
for rows.Next() {
err := rows.StructScan(&place)
if err != 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。
以上就是我常用的 10 大 Go 框架/库和一些附加库。
我希望你喜欢我的推荐,如果你有其他的推荐,请留言!
原文链接:https://keccikun.medium.com/top-10-framework-golang-library-to-build-microservice-391a2bb4c2cb
作者:Kecci Kun
编译:polarisxu
参考资料
[1]
Go Webb 框架: https://github.com/swaggo/swag#supported-web-frameworks
[2]
OpenAPI 2.0: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md
[3]
CLI: https://github.com/golang-migrate/migrate#cli-usage
[4]
库: https://github.com/golang-migrate/migrate#use-in-your-go-project
相关推荐
- m2固态硬盘安装系统教程(m2固态如何装系统)
-
加装m.2固态硬盘后,重装系统的操作步骤如下:1、下载U盘启动盘制作工具,下载一个GHOST版最新的WIN7,准备一个足够大的U盘(16G足够了),用U盘启动盘制作工具将其制作成启动U盘;2、插入新电...
- 运行chkdsk工具(运行chkdsk工具怎么解决)
-
1、win+R键打开运行,输入cmd。2、输入并回车执行chkdsk/?命令,可以了解chkdsk命令的使用方法。3、比如一些常用的命令,输入并按回车执行chkdskm:/f命令,可以检...
- 办公软件2007官方下载免费完整版
-
office字体都变成了英文是因为设置了英文模式。具体的解决步骤如下:我们需要准备的材料分别是:电脑、Word文档。1、首先我们打开Word文档,点击打开左上角的文件中的“选项”。2、然后我们在弹出来...
- 手机u盘有必要买吗(手机u盘需要什么软件)
-
网上卖的手机U盘大都是各地的实体数码店进行发货和销售的。他们采用的U盘质量和工厂生产的质量是一致的。并没有什么区别对待。而且由于网上销售费用比较低,所以他在售卖比实体数码店售卖的价格更低,所以这种手机...
- 电脑系统怎么下载到u盘中(电脑系统win7纯净版下载官方免费版最新版)
-
下载电脑系统,可以到电脑系统资源下载网站,找到下载页面的下载点,右击下载点,选择迅雷下载,可以把系统文件下载到硬盘里,然后插上U盘,将下载好的系统文件复制到U盘。另一种方法是,将迅雷软件的默认下载路径...
- 小米主题安装器(红米主题商店app下载安装)
-
很抱歉,一加九手机无法直接安装小米主题。因为一加九和小米手机使用的是不同的操作系统和主题引擎,它们之间不兼容。一加九使用的是基于Android的OxygenOS操作系统,而小米手机使用的是基于Andr...
- hp电脑恢复出厂系统(hp电脑恢复出厂系统操作)
-
在开始菜单的【设置】中找到【重置此电脑】的选项即可开始重置恢复到出厂设置;如果您需要整个硬盘格式化,可以选择其中的【删除所有文件】的选项,等待系统设置完成之后会重新进入新系统设置。以下是详细介绍:...
- ghost做c盘镜像的步骤(ghost制作镜像步骤)
-
共9个步骤:1、一般GHOST工具是在PE启动后使用,这个就是PE中GHOST所在路径,找到这个软件并运行。2、界面是英文版本的,因为软件的易操作易学习性,所以这个软件基本没有中文版版本,然后在弹出的...
- win10家庭版怎么激活系统(win10家庭版激活步骤)
-
win10家庭中文版怎么激活1.在win10系统桌面上,点击左下角的开始按钮选择设置选项进入。2.进入设置列表菜单,点击更新和安全选项进入。3.点击激活选项继续下一步操作。4.在弹出输入产品密钥的对话...
- office2010和2016区别(office2010和2016差别大不大)
-
一、指代不同1、word2010:Word2010是Microsoft公司开发的Office2010办公组件之一,主要用于文字处理工作。2、word2016::Word2016是Microsoft公司...
- win10官网下载教程(windows官网下载win10)
-
步骤1首先打开360安全浏览器步骤2在搜索框中输入“微软官网”,点击“搜索”按钮步骤3点击进入微软官网步骤4下滑界面,在下方可以看到可以下载的系统,此处以windows10企业版下载为例,点击这个版本...
- 恢复帝app下载(恢复帝app官方)
-
微信删除好友一般是不能恢复的,有时候在网上会看到一些关于微信删除好友可以帮助恢复的黑客,大多数都是骗人的,因此,再着急恢复好友也需要理智、谨防上当受骗。1.电源:首先确认摄像头通电是否正常状态,指示灯...
- 系统之家下载安装(系统之家安装版)
-
是靠谱的。系统之家(HomeSystem)广义上包含了电脑系统安装和手机系统安装,在之前手机软件还不是很普及的时候一般特指电脑系统安装,可如今手机用户大量的出现,安卓系统可以说超过Windows系统...
- win10正版系统官网原版纯净版老电脑
-
一,纯净版Win10系统是根据正版系统制作的,没有夹杂其它软件和驱动,和正版系统一样安装完后需要打各种驱动和根据安装常用软件。二,本质上纯净版Win10也是盗版系统,这是和正版系统最大的区别,而且可能...
- 一周热门
- 最近发表
- 标签列表
-
- python判断字典是否为空 (50)
- crontab每周一执行 (48)
- aes和des区别 (43)
- bash脚本和shell脚本的区别 (35)
- canvas库 (33)
- dataframe筛选满足条件的行 (35)
- gitlab日志 (33)
- lua xpcall (36)
- blob转json (33)
- python判断是否在列表中 (34)
- python html转pdf (36)
- 安装指定版本npm (37)
- idea搜索jar包内容 (33)
- css鼠标悬停出现隐藏的文字 (34)
- linux nacos启动命令 (33)
- gitlab 日志 (36)
- adb pull (37)
- python判断元素在不在列表里 (34)
- python 字典删除元素 (34)
- vscode切换git分支 (35)
- python bytes转16进制 (35)
- grep前后几行 (34)
- hashmap转list (35)
- c++ 字符串查找 (35)
- mysql刷新权限 (34)
