Go 语言怎么一键生成一个 gRPC 服务?

简介: Go 语言怎么一键生成一个 gRPC 服务?

介绍

Go 开源项目 Micro 为我们提供一套微服务解决方案,它主要包含两个部分,分别是微服务框架 go-micro 和命令行工具 micro

其中, go-micro 是一个易用且强大的框架,很多在生产环境运行的项目中在使用 go-micro v1.x 或 v2.x 版本,因为 v3 版本的变动较大,所以很少项目会选择升级到 v3 版本。

命令行工具 micro 也是基于 go-micro 开发的,它提供了很多便捷功能。

虽然命令行工具不是必须的,我们不使用它,也可以使用 go-micro 创建一个 gRPC 服务。但是,使用命令行工具 micro 可以更加便捷的开发和管理项目。

此外,官方还提供了一些插件 go-pluginsgo-micro 使用插件架构设计,可以非常灵活地组合各种功能,我们也可以自己开发插件,满足我们自己的个性化需求。本文不涉及插件,暂时不做详细介绍。

我们在之前的文章中介绍过不借助命令行工具 micro,直接使用 go-micro 手动编写代码创建一个 gRPC 服务,本文我们介绍怎么使用命令行工具 micro 自动创建一个模板项目。

使用命令行工具 micro 生成 gRPC 服务

安装:

GO111MODULE=on go get github.com/micro/micro/v2@v2.4.0

创建项目:

micro new --namespace=com.foo --gopath=false hello

阅读上面这段命令行代码,我们使用命令行工具 micro 创建一个项目,服务名称是 hello

命令行参数:

  • micro new 使用命令行工具 micro 和其子命令 new 创建一个 gRPC 服务。
  • --namespcae=com.foo 指定服务的命名空间。
  • --gopath=fase 在当前目录生成代码,而不是生成到 GOPATH 目录。
  • hello 指定服务名称。

注意:micro new 的其他参数,感兴趣的读者朋友们请查阅文档。

我们在运行上面这段命令行代码之后,终端会输出以下内容:

Creating service com.foo.service.hello in hello
.
├── main.go
├── generate.go
├── plugin.go
├── handler
│   └── hello.go
├── subscriber
│   └── hello.go
├── proto/hello
│   └── hello.proto
├── Dockerfile
├── Makefile
├── README.md
├── .gitignore
└── go.mod
download protobuf for micro:
brew install protobuf
go get -u github.com/golang/protobuf/{proto,protoc-gen-go}
go get -u github.com/micro/protoc-gen-micro/v2
compile the proto file hello.proto:
cd hello
protoc --proto_path=.:$GOPATH/src --go_out=. --micro_out=. proto/hello/hello.proto

阅读上面终端输出的内容,我们可以发现,micro newhello 目录中,为我们自动生成了模板代码。

安装 protobuf 和依赖项:

因为 micro 使用 protobuf 定义服务接口,所以我们需要先安装 protobuf 和依赖项。

brew install protobuf
go get -u github.com/golang/protobuf/{proto,protoc-gen-go}
GO111MODULE=on go get -u github.com/micro/protoc-gen-micro/v2

在我们运行 micro new 命令之后,终端中已经为我们输出安装 protobuf 和依赖项的提示,并且提供了安装命令,我们只需运行安装命令即可。

需要注意的是,protoc-gen-micro 是由 micro 官方开发的 protobuf 的扩展,用于生成 micro 的相关代码,我们在安装时,需要显式开启 Go Module

注意:关于 protobuf 的相关内容,我们在之前的文章中介绍过,限于篇幅,本文不再赘述。

构建并运行服务:

虽然 micro new 在生成代码时,为我们生成了一个 Makefile 文件,其中,包含一些常用的任务,我们可以使用 make 命令运行该文件中定义好的任务。

但是我决定在本文中不使用 make 命令,原因是读者朋友们可能有人不熟悉 make,为了避免增加这部分读者的学习成本,我仍然使用 go 命令。

需要注意的是,我们需要先运行 go get 安装指定版本的 go-micro,目的是避免在代码编译期间,自动安装最新版本的 go-micro

cd hello
GO111MODULE=on go get github.com/micro/go-micro/v2@v2.4.0

注意:指定 go-micro 的版本,目的是避免因为版本问题,导致不可预知的陷阱。

在我们使用 go build 构建项目之前,我们先编译 hello.proto 文件。

编译 hello.proto 文件:

cd hello
protoc --proto_path=.:$GOPATH/src --go_out=. --micro_out=. proto/hello/hello.proto

运行编译 hello.proto 文件的命令之后,我们可以发现在 proto/hello 目录中多出两个文件,分别是 hello.pb.gohello.pb.micro.go

构建:

go build -o hello-service *.go

运行构建命令之后,我们可以发现目录中多出一个二进制文件 hello-service

运行服务:

./hello-service
2023-03-04 17:00:54  level=info Starting [service] com.foo.service.hello
2023-03-04 17:00:54  level=info Server [grpc] Listening on [::]:50669
2023-03-04 17:00:54  level=info Broker [eats] Connected to [::]:50671
2023-03-04 17:00:54  level=info Registry [mdns] Registering node: com.foo.service.hello-e0057b02-6432-4d0d-b1e4-2b87ea1034a3
2023-03-04 17:00:54  level=info Subscribing to topic: com.foo.service.hello

到此,我们已经完成使用命令行工具 micro new 创建一个服务名称为 hello 的 gRPC 服务,并且成功构建并运行该服务。

注意:如果遇到一些无法解决的问题,可以尝试删除 GOPATH/pkg/mod 目录下的文件后重试。

03

总结

本文我们介绍怎么使用命令行工具 micro new 创建一个 gRPC 服务,并且怎么构建和运行服务。

需要注意的是,在构建之前,我们先指定 go-micro 版本,避免在代码编译时使用最新版本,掉入不可预知的陷阱。

在安装 micro 官方开发的 protobuf 扩展 protoc-gen-micro 时,我们一定要显式开启 Go Module。

我们安装命令行工具 micro之前,需要先设置代理。因为官方已不维护 go-micro 的 v1 和 v2 版本,所以,我们需要使用代理安装,推荐使用 https://goproxy.cn

推荐阅读:

参考资料:

  1. https://micro.dev/getting-started#creating-a-service
  2. https://github.com/go-micro
目录
相关文章
|
14天前
|
Go
go语言中的数据类型
go语言中的数据类型
13 0
|
20天前
|
存储 安全 Go
掌握Go语言:Go语言类型转换,无缝处理数据类型、接口和自定义类型的转换细节解析(29)
掌握Go语言:Go语言类型转换,无缝处理数据类型、接口和自定义类型的转换细节解析(29)
|
16小时前
|
程序员 Go API
【Go语言快速上手(二)】 分支与循环&函数讲解
【Go语言快速上手(二)】 分支与循环&函数讲解
|
18小时前
|
Go
Golang深入浅出之-Go语言基础语法:变量声明与赋值
【4月更文挑战第20天】本文介绍了Go语言中变量声明与赋值的基础知识,包括使用`var`关键字和简短声明`:=`的方式,以及多变量声明与赋值。强调了变量作用域、遮蔽、初始化与零值的重要性,并提醒读者注意类型推断时的一致性。了解这些概念有助于避免常见错误,提高编程技能和面试表现。
6 0
|
19小时前
|
编译器 Go 开发者
Go语言入门|包、关键字和标识符
Go语言入门|包、关键字和标识符
8 0
|
2天前
|
数据采集 存储 Go
使用Go语言和chromedp库下载Instagram图片:简易指南
Go语言爬虫示例使用chromedp库下载Instagram图片,关键步骤包括设置代理IP、创建带代理的浏览器上下文及执行任务,如导航至用户页面、截图并存储图片。代码中新增`analyzeAndStoreImage`函数对图片进行分析和分类后存储。注意Instagram的反爬策略可能需要代码适时调整。
使用Go语言和chromedp库下载Instagram图片:简易指南
|
4天前
|
API Go
使用Go语言通过API获取代理IP并使用获取到的代理IP
使用Go语言通过API获取代理IP并使用获取到的代理IP
|
5天前
|
前端开发 Java Go
开发语言详解(python、java、Go(Golong)。。。。)
开发语言详解(python、java、Go(Golong)。。。。)
|
14天前
|
存储 Java 编译器
go语言基础语法
go语言基础语法
|
20天前
|
存储 缓存 安全
掌握Go语言:Go语言Map,高效键值对集合的应用与注意事项详解(26)
掌握Go语言:Go语言Map,高效键值对集合的应用与注意事项详解(26)

热门文章

最新文章