Go-Zero基础入门2:快速构建API与RPC服务

Go-Zero微服务快速入门和最佳实践(一) 这篇文章带你梳理了使用gozero开发微服务项目的步骤和技巧,请你按我建议的方式开发和debug,会很清晰。下一篇文章将通过一个完整的功能,带你跑通一个微服务的开发,包括:需求分析+表结构设计+api+rpc+goctl+apifox调试+细节处理。如果你对Go语言或者微服务感兴趣,欢迎关注我的公众号:王中阳Go,也欢迎直接私信我。 阅读详情

纲要

  • 认识 go-zero 框架
    • 设计理念与核心特性
    • 环境依赖:Go、Redis、etcd
    • 核心组件:goctl 工具与核心库 github.com/zeromicro/go-zero
  • 快速安装与项目初始化
    • 安装 goctl
    • 获取核心依赖
  • 实践案例:构建 User 服务的 RPC 与 API
    • 整体流程:编写 .proto → 生成 RPC → 编写 .api → 生成 API → 联调
    • 使用 goctl 生成 RPC 服务
    • 使用 goctl 根据 .proto 生成代码
    • RPC 服务目录结构与设计意图
    • 编写业务逻辑与启动 RPC
    • 使用 goctl 生成 API 服务
    • API 目录结构与控制器
    • 在 API 中调用 RPC 服务
    • 联调验证
  • 总结

认识 go-zero 框架

go-zero 是一个集成了各种工程实践的 Web 和 RPC 框架,设计上充分吸收了微服务项目在实际开发中的痛点,并通过弹性设计、内置熔断、负载均衡等机制,让开发者可以更专注于业务逻辑本身。它的核心亮点可以概括为两点:

  • 声明式 API 定义:类似 Protocol Buffers 的 .api 文件,用来描述 HTTP 接口的请求/响应结构,通过工具即可生成完整的 API 服务代码。
  • 微服务治理能力内建:无需手动引入第三方库,框架自带了自适应熔断、服务发现、负载均衡等功能,开箱即用。

除了这些设计理念,go-zero 还配备了一个强大的命令行工具 goctl,能够自动生成 RPC、API、模型等样板代码,大幅缩短从需求到上线的距离。

在开始使用之前,需要确保本地环境满足以下依赖:

  • Go(1.16+)
  • Redis:go-zero 在模型缓存中默认使用 Redis 作为缓存存储
  • etcd:go-zero 默认使用 etcd 作为服务注册与发现中心

go-zero 体系中的两个关键元素:

  • goctl:代码生成工具,可快速创建项目骨架。
  • github.com/zeromicro/go-zero:框架核心依赖库。

快速安装与项目初始化

安装 goctl

推荐直接下载预编译二进制文件,并放置到 $GOPATH/bin 目录下,以便全局使用。

# 使用 go install 安装(推荐)
$ go install github.com/zeromicro/go-zero/tools/goctl@latest 

安装完成后,执行 goctl --version 确认可用。

获取核心依赖

在项目根目录执行:

$ go mod init <your-module-name>
$ go get -u github.com/zeromicro/go-zero@latest 

这会将框架依赖写入 go.mod。

实践案例:构建 User 服务的 RPC 与 API

本节将通过一个简单的 User 服务来演示如何用 go-zero 快速搭建 RPC 和 API,并实现两者间的调用。整体流程如下:

编写 user.proto

goctl 生成 RPC 代码

实现业务逻辑

启动 RPC 服务

编写 user.api

goctl 生成 API 代码

在 API 中集成 RPC 客户端

启动 API 服务

联调测试

使用 goctl 创建 RPC 服务骨架

首先创建一个空目录作为项目根目录,然后进入该目录,使用 goctl 快速生成一个名为 user 的 RPC 服务:

$ mkdir user-service && cd user-service 
$ goctl rpc new user 

执行后,目录中会出现一个基础的 RPC 项目结构。此时可以先查看一下,然后将其删除,因为我们通常会基于已有的 .proto 文件重新生成。

编写 .proto 并生成代码

在项目根目录下创建 rpc/user.proto,内容如下:

syntax = "proto3";
 
package user;
 
option go_package = "./user";
 
message GetUserReq {
  string id = 1;
}
 
message GetUserResp {
  string id = 1;
  string name = 2;
}
 
service User {
  rpc GetUser(GetUserReq) returns (GetUserResp);
}

然后使用 goctl 根据该 .proto 生成代码。假设当前位于 user-service 目录下,且 user.proto 放在 rpc/user.proto:

$ cd rpc 
$ goctl rpc protoc user.proto --go_out=./types --go-grpc_out=./types --zrpc_out=.

其中:

  • --go_out 和 --go-grpc_out 生成 protobuf 相关代码
  • --zrpc_out=. 生成 go-zero 的 RPC 服务框架代码,输出到当前目录

生成的目录结构如下:

rpc/
├── etc/
│   └── user.yaml            # 配置文件 
├── internal/
│   ├── config/
│   │   └── config.go        # 配置结构体 
│   ├── logic/
│   │   └── getuserlogic.go  # 业务逻辑 
│   ├── server/
│   │   └── userserver.go    # gRPC 服务实现 
│   └── svc/
│       └── servicecontext.go # 服务上下文 
├── types/
│   └── user/                # protobuf 生成的消息类型 
├── user.go                  # 入口文件 
├── user.proto 
└── userclient/
    └── user.go              # 客户端代码 

RPC 目录结构设计意图

  • etc:存放服务的配置文件(YAML),便于运维调整。
  • internal:服务内部实现,不对外暴露。
    • config:配置结构映射。
    • logic:核心业务逻辑,每个 RPC 方法对应一个 logic 文件。
    • server:实现 gRPC 接口,调用 logic 处理请求。
    • svc:服务上下文,集中管理依赖(如数据库连接、其他 RPC 客户端等)。
  • types:protobuf 生成的消息结构,供服务内外使用。
  • userclient:提供给外部调用的客户端封装,其他服务只需引用该包即可轻松调用本服务。

这种分层设计的核心思想是:“内核”逻辑集中在 internal 中,而可被外部引用的客户端、类型等则放在与 internal 同级的目录下,职责清晰,便于团队协作。

编写业务逻辑并启动 RPC

打开 internal/logic/getuserlogic.go,实现 GetUser 方法:

func (l *GetUserLogic) GetUser(in *user.GetUserReq) (*user.GetUserResp, error) {
    // 模拟业务逻辑:根据 ID 返回用户信息 
    return &user.GetUserResp{
        Id:   in.Id,
        Name: "Alice",
    }, nil 
}

然后进入 rpc 目录,启动服务:

$ go run user.go 

服务默认监听在配置文件中指定的地址(例如 0.0.0.0:8080),并且会向 etcd 注册。

使用 goctl 生成 API 服务

在项目根目录(user-service)下创建 api/user.api 文件:

syntax = "v1"
 
info (
    title:   "User API"
    desc:    "用户服务 HTTP 接口"
)
 
type (
    GetUserReq {
        Id string `json:"id"`
    }
    GetUserResp {
        Id   string `json:"id"`
        Name string `json:"name"`
    }
)
 
@server (
    prefix: /api/v1 
)
service user-api {
    @handler GetUser 
    get /user (GetUserReq) returns (GetUserResp)
}

.api 文件的语法类似 Protocol Buffers,但专为 HTTP 接口设计。其中 @server 定义路由前缀,@handler 标注处理器名称,get /user 则定义了具体的 HTTP 方法和路径。

生成 API 代码:

$ cd api 
$ goctl api go -api user.api -dir .

生成的目录结构如下:

api/
├── etc/
│   └── user-api.yaml 
├── internal/
│   ├── config/
│   ├── handler/
│   │   └── getuserhandler.go   # HTTP 处理器 
│   ├── logic/
│   │   └── getuserlogic.go     # 业务逻辑 
│   ├── svc/
│   │   └── servicecontext.go   # 服务上下文 
│   └── types/
│       └── types.go            # 请求/响应结构体 
├── user.api 
└── user.go                     # 入口文件 

在 API 中集成 RPC 客户端

为了让 API 服务能够调用 RPC 服务,需要先配置 RPC 客户端。编辑 api/etc/user-api.yaml,添加 RPC 服务发现配置:

Name: user-api 
Host: 0.0.0.0 
Port: 8888 
 
UserRpc:
  Etcd:
    Hosts:
      - 127.0.0.1:2379 
    Key: user.rpc 

然后在 internal/config/config.go 中增加对应的配置结构:

type Config struct {
    rest.RestConf 
    UserRpc zrpc.RpcClientConf 
}

在 internal/svc/servicecontext.go 中创建 RPC 客户端实例:

type ServiceContext struct {
    Config  config.Config 
    UserRpc userclient.User 
}
 
func NewServiceContext(c config.Config) *ServiceContext {
    return &ServiceContext{
        Config:  c,
        UserRpc: userclient.NewUser(zrpc.MustNewClient(c.UserRpc)),
    }
}

最后在 internal/logic/getuserlogic.go 中实现业务逻辑,调用 RPC:

func (l *GetUserLogic) GetUser(req *types.GetUserReq) (resp *types.GetUserResp, err error) {
    rpcResp, err := l.svcCtx.UserRpc.GetUser(l.ctx, &user.GetUserReq{
        Id: req.Id,
    })
    if err != nil {
        return nil, err 
    }
    return &types.GetUserResp{
        Id:   rpcResp.Id,
        Name: rpcResp.Name,
    }, nil 
}

联调测试

确保 RPC 服务已在运行,然后启动 API 服务:

$ cd api 
$ go run user.go 

使用 curl 测试:

$ curl "http://127.0.0.1:8888/api/v1/user?id=1"
{"id":"1","name":"Alice"}

可以看到,API 服务成功调用了 RPC 服务并返回了用户信息。

总结

通过上述实践可以看到,go-zero 借助 goctl 工具,能够极快地生成 RPC 和 API 服务骨架,开发者只需填充业务逻辑即可完成微服务搭建。其目录结构的设计也充分体现了关注点分离和团队协作的最佳实践:

  • 外层为服务暴露的客户端和类型;
  • 内层(internal)集中管理配置、上下文和业务逻辑;
  • 每个 RPC 方法独立为一个 logic 文件,职责单一。

这种风格不仅降低了初学者的上手门槛,也使得项目在规模扩大后依然能够保持良好的可维护性。后续还可以进一步探索 go-zero 的缓存、限流、队列等高级特性,但掌握 API 与 RPC 的协作模式,已经足以应对大多数微服务开发场景。

go-zero微服务入门教程 《Go-zero 微服务开发完全指南》摘要 本文是一份全面的Go-zero微服务开发指南,覆盖1.6.4+版本,提供从入门到进阶的系统学习路径。 阅读详情

相关推荐

go-zero微服务实战:从零搭建API网关与RPC服务调用链路

微服务架构在拆分服务后,往往面临服务注册、配置管理、负载均衡、熔断降级等基础设施的搭建难题。而Go语言生态中,go-zero框架通过“约定优于配置”的设计理念,配合goctl代码生成工具,将这套复杂的微服务基础设施封装成开箱即用的能力,大幅降低了工程落地的门槛。本文从微服务基础设施的核心概念出发,讲解API网关与RPC服务在go-zero中的角色分工,并通过实际搭建一个HTTP API服务调用底层RPC用户服务的完整过程,展示从环境准备、goctl安装、API与proto文件编写、代码生成到etcd服务注册

weixin_30702441的博客 182

go-zero框架快速入门

go-zero 是一个集成了各种工程实践的 web 和 rpc 框架。通过弹性设计保障了大并发服务端的稳定性,经受了充分的实战检验。go-zero 包含极简的 API 定义和生成工具 goctl,可以根据定义的 api 文件一键生成代码。

码农兴哥的技术笔记 3743

笔记本摄像头模拟监控推送RTSP流

FFmpeg软件:选择Windows builds by BtbN一个完整的跨平台解决方案,用于录制、转换和流式传输音频和视频。选择Windows版本EasyDarwin开源流媒体服务器 支持Windows、Linux、macOS平台;支持RTSP推流分发(推模式转发);支持RTSP拉流分发(拉模式转发);VLC Media Player软件:选择Windows64bit支持众多与及文件格式,并支持DVD影音光盘,VCD影音光盘及各类协议。

IT_LittleBaby的博客 3875

使用go-zero从0到1快速构建高并发的短链服务

go-zero 关于go-zero介绍请看上一篇博文《好未来晓黑板go-zero微服务框架: 你不需要懂微服务,懂业务就行》 使用go-zero从0到1快速构建高并发的短链服务 0. 什么是短链服务? 短链服务就是将长的URL网址,通过程序计算等方式,转换为简短的网址字符串。 写此短链服务是为了从整体上演示go-zero构建完整微服务的过程,算法和实现细节尽可能简化了,所以这不是一个高阶的短链服务。 1. 短链微服务架构图 2. 准备工作 安装etcd, mysql, redis 准备goctl工具 直

Keson 4905

课程复习---分析空间数据的细胞空间关系(python版本的mistyR)

课程复习---分析空间数据的细胞空间关系(python版本的mistyR)

weixin_53637133的博客 1222

别再让电池充不满!用CN3791芯片设计太阳能充电电路,这几个调试坑我帮你踩了

本文详细解析了使用CN3791芯片设计太阳能充电电路时的常见调试问题及解决方案。从RCS电阻的选择到MPPT电压偏差的修正,再到线路损耗和温度补偿的优化,提供了全面的避坑指南。通过实测数据和优化方案,帮助工程师提升锂电池充电效率,确保太阳能充电电路的稳定性和可靠性。

weixin_42528191的博客 244

go-zero学习 第一章 基础

go-zero学习 第一章 基础

Mr_XiMu的博客 4076

Apollo control模块横向控制原理及核心代码逐行解析

看完这篇文章,你会对apollo横向控制有一个整体的概念

weixin_39199083的博客 2万+

go-zero微服务框架入门教程

为什么使用go-zero 你还在手撕微服务?快试试 go-zero 的微服务自动生成神器,这可能是我见过最简单好用的微服务框架。 还有比它更简单好用的吗?欢迎留言评论和推荐。 几分钟搞定个接口和微服务,还不用担心稳定性和高并发,这不香吗?还有比这更简单和高效的吗? 工具大于约定和文档的理念,编码自动化,大幅度的提高效率和生产力,这会是个趋势,让精力更多的放在业务和创新上。 接口一分钟搞定,稳定性和并发性也不必担心。 推荐下go-zero 微服务框架,致力于打造国内最简单好用的框架。 为什么使用go

猫哥 的沉淀、积累、总结。天天学习,好好向上...c/c++,嵌入式 linux,Android,HarmonyOS,AIOT) 2万+

哈希拓展攻击CTF题做法

kali下载相关工具hash-ext-attack:hash拓展题目特征:2023楚慧杯upload_shell实验吧之让我进去:前言:具体怎么加密解密补位的原理我不懂,深入理解的部分我在文末挂了链接,以下也只是我做题的结论和通解,可能不准确(但是做题还挺准确),有错误欢迎指出:是在密码加密过程中引入的一个随机值,它与密码结合使用,目的是增加密码的复杂性和安全性。在密码加密中,常见的做法是将用户提供的密码进行哈希处理,然后存储哈希值而不是明文密码

2301_76690905的博客 2422

vue-vben-admin 打包编译报错Failed to resolve entry for package “@vben-core/design“ 的解决方法

如果你在你是不是在 apps/子目录下执行了 build?# 项目根目录 pnpm build而不是在下面单独打包。这个问题本身不复杂,但非常容易被误导去“怀疑依赖、怀疑配置、怀疑人生”。实际上,只要理解vue-vben-admin 是 monorepo 架构,很多类似问题都会迎刃而解。如果你后面还遇到 vben-admin 的构建、部署、权限或性能相关问题,这一套思路都很有用。希望这篇记录,能帮你节省至少半小时的排坑时间。

代码简单说 Vue、JAVA、PHP、Node.js 熟练运用,接口、架构、性能全搞定。 425

go-zero入门

本文简单介绍了go-zero,以及go-zero相关的安装配置。通过go-zero的hello world级别的一个的单体应用和一个包含两个服务的微服务应用,以实践的方式展示了go-zero项目的入门级搭建。

qq_47997583的博客 1771

破盾实录|Vueling航空阿卡迈防护逆向:从503挑战到Cookie生成的全流程拆解

摘要:文章分享了作者在爬取西班牙伏林航空(Vueling)机票数据时,遭遇阿卡迈(Akamai)防护系统的实战经历。起初简单的请求被拦截返回503错误,分析发现阿卡迈通过混淆JS代码实施"挑战-验证"机制,需模拟真实浏览器环境才能获取有效Cookie。作者详细拆解了逆向过程:从抓包分析JS挑战流程,到破解代码混淆和控制流平坦化,最终用Python+Pyppeteer成功模拟浏览器特征,突破防护获取数据。整个过程涉及JS反混淆、环境检测绕过和Cookie生成验证等关键技术点,为类似防护系统

专注于Python爬虫开发,分享爬虫技巧、项目实战与反爬经验,使用Scrapy、BeautifulSoup等工具,解决数据抓取难题。 1644

go-zero的快速实战(完整)

go-zero实例

m0_66316879的博客 4439

CXSMILES细则-用于在 SMILES 字符串后存储分子的特殊特征

Chemaxon 扩展 SMILES/SMARTS 用于在 SMILES 字符串后存储分子的特殊特征。任何信息都可以存储在 SMILES 字符串后,只要它们由空格或制表符字符分隔,因为 SMILES 解析器会忽略这些信息,或者将它们作为注释使用。扩展特征以以下格式存储:Chemaxon 的扩展 SMILES/SMARTS 不包含非 ASCII 字符,它们通常以字符代码 n 的形式被转义为 &#n;。在 S-group 中,ASCII 字符“,”、“;”、“|”、“{”、“}”也以这种方式转义。此外,符号“$

ASKCOS博客 404

jre9下载 jdk9

(Java SE Runtime Environment 9.0) 9.0u175 官方最新版 【x86|x64】

Go-Zero RPC + API 网关示例

本文介绍了一个基于Go-Zero框架的微服务示例项目,演示了如何在一个模块中同时构建gRPC服务端和HTTP API网关。项目采用RPC+API网关架构,通过etcd实现服务注册与发现,主要功能包括用户查询。文章详细阐述了项目结构、协议定义、配置体系、核心流程和分层设计理念,并提供了完整的运行指南和扩展建议。技术栈包含Go-Zero、gRPC、Protobuf和etcd,强调类型分层独立和最小化依赖原则。注意事项包括启动顺序、配置文件和端口管理等,为开发者提供了一个清晰的微服务实践范例。

wtt234的专栏 635

计算机控制技术及应用

《计算机控制技术及应用》通过总结作者的科研成果和吸收国内外的先进理论、方法和技术,以计算机控制系统的网络化、开放化、智能化和集成化发展趋势为主线索,主要介绍计算机控制系统的基本概念和计算机控制系统的典型形式,计算机控制系统的数学描述与基本分析方法,以及数字PID控制器、最少拍控制系统、达林算法、状态变量设计法等设计方法及其各种改进算法。重点突出计算机控制系统输入输出通道接口的设计方法和典型控制系统的设计案例与实现方法等。

go-zero超强工具goctl的常用命令api,rpc,model及其构建的服务解析

goctl rpc 是 goctl 中的核心模块之一,其可以通过 .proto 文件一键快速生成一个 rpc 服务;api用于快速搭建web服务,model集成数据库操作,使用半orm框架完成CURD。

个人学习笔记库,一篇一篇记录成长的足迹 4380

Data-Structures-and-Algorithm-Analysis-in-Java.pdf

作者: Weiss, Mark A. 出版社: Addison Wesley Data Structures and Algorithm Analysis in Java is an “advanced algorithms” book that fits between traditional CS2 and Algorithms Analysis courses. In the old ACM Curriculum Guidelines, this course was known as CS7. This text is for readers who want to learn good programming and algorithm analysis skills simultaneously so that they can develop such programs with the maximum amo...

怀旧版电脑GBC模拟器

再现原版GBC掌机的界面,电脑运行连游戏界面都一样大小,很怀旧,很真实,(英文版)强烈推荐,很小的文件,很难才找到的。

go的微服务框架go-zero

1.微服务 单一的模块无法再支撑大量的用户请求,如果一个功能挂了很可能导致整个项目奔溃,所以要将一个项目按照不同的功能分成多个模块进行部署,每个模块之间低耦合,每个模块通过RPC进行内部通讯。     微服务的好处:将复杂的项目模块化、有利于程序员开发、有利于提高项目健壮性、也有利于测试和维护     微服务的坏处:拆分项目需要一定的工足量、要部署多个模块、每个模块沟通需要成本、项目整体架构复杂了、还需要保证模块数据的一致性

k393393的博客 8156

go-zero项目快速搭建流程

goctl 是 go-zero 的内置脚手架, 是提升 go-zero 开发的一大利器, 可以一键生成代码、文档、部署 k8s yaml、dockerfile 等。api 是 go-zero 自研的领域特性语言, 作为生成 http 服务最基本的描述语言. api 领域特性语言包含语法版本, info 块, 结构体声明, 服务描述等几大块语言组成, 其中结构体和 golang 结构体语法几乎一样, 只是移除了 struct 关键字在bookstore下创建 rpc/model目录。

omdox的博客 1579

【go-zero】api与rpc使用etcd服务发现

go-zero api与rpc使用etcd服务发现

weixin_44102152的博客 926

微服务框架 go-zero 快速实战

go-zero 是一个集成了各种工程实践的 web 和 rpc 框架。通过弹性设计保障了大并发服务端的稳定性,经受了充分的实战检验。go-zero 中的 api,rpc,数据库等涉及的代码,都可以给我们一键生成,无需耗费我们什么精力只需要在生成的代码中填入自己的配置以及逻辑即可,轻松获得支撑千万日活服务的稳定性内建级联超时控制、限流、自适应熔断、自适应降载等微服务治理能力,无需配置和额外代码微服务治理中间件可无缝集成到其它现有框架使用极简的 API 描述,一键生成各端代码。

m0_37322399的博客 1669

go-zero学习 — 基础

api配置。

2501_90228903的博客 1188

Go-zero 安装与使用(详细流程)

go-zero 是一个集成了:API 网关 + RPC + 中间件 + 代码生成 + 微服务治理 的 Go 微服务框架。编辑type (// 登录请求LoginReq {Username string `json:"username"` // 用户名Password string `json:"password"` // 密码// 登录响应UserInfo UserInfo `json:"userInfo"` // 用户信息// 用户信息UserInfo {// 登录接口。

卡尔特斯 1282

go-zero知识汇总

要求安装了 go sdk, go > 1.13, 配置了 goroot, gopath。建议一个block结束空一行,如if、for等。@service 关键key描述说明。单行import不建议用圆括号包裹。注意 gopath 在环境变量中。中间件中调用其他 中间件。return前空一行。

eric dong的博客 1245

go-zero微服务框架终极指南:10分钟构建高可用API服务

还在为微服务开发中的重复劳动而烦恼吗?go-zero框架的代码生成工具goctl能让你在10分钟内快速构建高性能API服务。本文将为你揭示go-zero如何通过极简的API定义和智能代码生成,将开发效率提升10倍,同时保障系统的高可用性和稳定性。 go-zero是一个云原生Go微服务框架,集成了丰富的工程实践,通过弹性设计确保高并发服务的稳定性。框架内置的goctl工具可以根据API定义文件一键

gitblog_00806的博客 829

云原生 go-zero 微服务框架介绍

0. go-zero 介绍go-zero 是一个集成了各种工程实践的 web 和 rpc 框架。通过弹性设计保障了大并发服务端的稳定性,经受了充分的实战检验。go-zero 包含极简的 ...

Go中国 4543
上一篇: Go-Zero基础入门1: 微服务框架与选型分析
下一篇: Go-Zero基础入门3: 实践数据库读写与中间件
Wang's Blog
博客等级 码龄12年 7440粉丝 2427原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Wang's Blog

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值