Go语言快速的一键生成一个gRPC服务

2023-05-16

目录

 前言

介绍

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

安装:

创建项目:

安装 protobuf 和依赖项:

构建并运行服务:

总结


 前言

        由于近期因为一些事情很久没更了今天带来一个Go语言如何快速的一键生成一个gRPC服务的教程


1

介绍

Micro(Go开源项目)为我们提供了一套微服务解决方案,它主要包括两个部分,分别是微服务框架 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 自动创建一个模板项目。


2

 使用命令行工具 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 new 在 hello 目录中,为我们自动生成了模板代码。

安装 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.go 和 hello.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 目录下的文件后重试。


3

总结

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

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

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

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


参考资料:

https://micro.dev/getting-started#creating-a-service

https://github.com/go-micro

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

Go语言快速的一键生成一个gRPC服务 的相关文章

随机推荐

  • 【通信协议】IIC通信协议详解

    IIC的基本介绍 IIC总线的发展 xff1a 芯片间总线 xff08 Inter Interface Circuit xff0c IIC xff09 xff0c 是应用广泛的芯片间串行扩展总线 目前世界上采用的IIC总线一共有两个规范 x
  • 【通信协议】单总线协议详解——以DHT11为例

    单总线概述 1 单总线的介绍 xff08 1 xff09 单总线也称为1 Wire bus xff0c 它是由美国DALLAS xff08 达尔斯 xff09 公司推出的外围串行扩展总线 单总线系统中配置的各种器件 xff0c 由DALLA
  • 【STM32学习笔记】(4)—— STM32工程文件详解

    STM32工程文件构成 从下图可以看出我们的工程目录是由CORE OBJ STM32F10x FWLib USER SYSTEM以及HARDWARE文件夹组成的 此外还有一个文本文档README TXT 以及一个Windows 批处理文件
  • 【STM32学习笔记】(6)—— 跑马灯实验详解

    跑马灯实验 在前面五篇STM32学习笔记中 xff0c 我们已经初步认识了STM32芯片 xff0c 并且了解STM32的常用寄存器 xff0c 介绍了STM32的GPIO模式 xff0c STM32工程文件 xff0c 以及最终讲解了如何
  • 【STM32学习笔记】(9)——串口通讯(USART)详解

    本文主要参考了野火的零死角玩转STM32和正点原子的STM32F1 开发指南 V1 1 xff08 精英板 库函数版本 xff09 xff0c 文章中大部分知识都是从两本书中提取出来 xff0c 串口通信协议的知识主要参考野火的书籍 xff
  • 【STM32学习笔记】(12)——NVIC(嵌套向量中断控制器)详解

    NVIC xff08 嵌套向量中断控制器 xff09 简介 在讲如何配置中断优先级之前 xff0c 我们需要先了解下 NVIC NVIC 是嵌套向量中断控制器 xff0c 控制着整个STM32芯片中断相关的功能 xff0c 它跟Cortex
  • 【STM32学习笔记】(15)——窗口看门狗(WWDG)详解

    窗口看门狗 WWDG 概述 窗口看门狗通常被用来监测 xff0c 由外部干扰或不可预见的逻辑条件造成的应用程序背离正常的运行序列而产生的软件故障 除非递减计数器的值在T6位变成0前被刷新 xff0c 否则看门狗电路在达到预置的时间周期时 x
  • 【元器件学习笔记—电阻】(6)——电阻并联电路

    电阻串联和并联电路 任何复杂的电路经过各种等效和简化后都可以归纳为两种电路 xff1a 一是串联电路 xff0c 二是并联电路 电阻并联电路 并联电路与串联电路是完全不同的电路 xff0c 它们之间不能相互等效 xff0c 并联电路的一些特
  • 【元器件学习笔记—电阻】(7)——电阻串并联电路

    电阻串并联电路 电阻串并联电路是电阻串联电路与电阻并联电路的组合电路 下图所示是由 3 只电阻器构成的电阻器串并联电路 电路中的电阻 R1 和 R2 并联 xff0c 然后再与电阻 R3 串联 xff0c 这就是纯电阻的串并联电路 纯电阻器
  • 【元器件学习笔记—电阻】(8)——电阻分压电路

    电阻分压电路 电阻分压电路工作原理 下图所示是典型的电阻分压电路 xff08 没有接入负载电路 xff09 xff0c 电阻分压电路由 和 两只电阻构成 电路中有电压输入端和电压输出端 1 电路结构 输入电压 加在电阻 和 上 xff0c
  • 小程序验证手机号和身份证号码

    if isPhone params mobile Toast content 39 请填写正确的手机号 39 type 39 error 39 return false var idCardMsg 61 identityIDCard par
  • 神州战神笔记本清灰+换硅脂-记录

    文章目录 Introduction拆清灰涂抹硅脂安装开机测试 Introduction 笔记本购买于2020年4月份左右 xff0c 至今已使用2年半时间 CPU是i7 9750H xff0c 基准频率是2 6GHz 用control ce
  • 【PADS VX2.4下载与安装】

    PADS VX2 4下载与安装 电脑 xff1a Windows10 64bit 一 下载地址 链接 xff1a https pan baidu com s 1yTAU5Hymrc1i8MhALwbsrA 提取码 xff1a hljd 二
  • 【FreeRTOS】详细讲解FreeRTOS中消息队列并通过示例讲述其用法

    讲解FreeRTOS中消息队列及其用法 使用消息队列的原因消息队列函数解析示例遇到的问题 使用消息队列的原因 在裸机系统中 xff0c 两个程序间需要共享某个资源通常使用全局变量来实现 xff1b 但在含操作系统 下文就拿FreeRTOS举
  • 【FreeRTOS】详细讲解FreeRTOS里中断管理并通过示例讲述其用法

    文章目录 中断函数解析FreeRTOS中断使用示例 中断 大家看到中断后 xff0c 有没有想到一个名词 异常呢 xff1f 若大家想到了 xff0c 但是记不起相关概念 xff1b 或者是 xff0c 大家没想到这个名词 xff0c 没关
  • 【嵌入式软件开发实习】个人面试记录及其总结(一)

    文章目录 问题一 xff1a 使用宏定义完成两个数据的交换问题二 xff1a 制作一个函数接口判断函数参数输入是否符合要求 xff0c 如果符合要求就返回部分输入 xff0c 如果不符合就返回no result问题三 xff1a 什么是结构
  • 嵌入式经典通信总线协议——RS232和RS485

    UART 通信的不足 注意 xff1a TTL电平信号通信距离应该 lt 61 1 5米 两种电平标准 RS232协议 因为控制器一般使用 TTL 电平标准 xff0c 所以常常会使用 MA3232 芯片对 TTL 及 RS 232电平的信
  • 把所阅读的文章背景/主题变成白色

    今天在CSDN找SVD分解的资料 xff0c 找到了一篇写的很好的文章 xff0c 但是它的主题是黑色的 xff0c 是黑色的 xff01 作为黑色主题深恶痛绝人士 xff0c 于是我便想把这篇文章的主题改成白色 我们作为读者似乎并没有这个
  • 计算机保研专业课必备之数据结构

    数据结构保研面试准备 算法的五大特征 有穷性 有限的步骤确定性 不可二义性可行性 每一步都是通过执行有限次数完成的输入 零个或多个输入输出 至少有一个或多个输出 O n 的大O是什么意思 xff1f 什么是时间复杂度 大O表示的是最坏情况下
  • Go语言快速的一键生成一个gRPC服务

    目录 前言 介绍 使用命令行工具 micro 生成 gRPC 服务 安装 xff1a 创建项目 xff1a 安装 protobuf 和依赖项 xff1a 构建并运行服务 xff1a 总结 前言 由于近期因为一些事情很久没更了今天带来一个Go