go-zero

<p align="center"> <img align="center" width="150px" src="https://yellow-cdn.veclightyear.com/2b54e442/f2e8541a-224b-4157-8225-40e73b901a15.png"> </p>

go-zero 是一个集成了大量工程实践的 Web 和 RPC 框架。它的诞生是为了确保高负载服务的稳定性,通过弹性设计,多年来一直为拥有数千万用户的网站提供服务。

<div align=center">

</div>

🤷‍ 什么是 go-zero?

English | 简体中文

<a href="https://trendshift.io/repositories/3263" target="_blank"><img src="https://trendshift.io/api/badge/repositories/3263" alt="zeromicro%2Fgo-zero | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a> <a href="https://www.producthunt.com/posts/go-zero?utm_source=badge-featured&utm_medium=badge&utm_souce=badge-go&#0045;zero" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=334030&theme=light" alt="go&#0045;zero - A&#0032;web&#0032;&#0038;&#0032;rpc&#0032;framework&#0032;written&#0032;in&#0032;Go&#0046; | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>

go-zero (已列入 CNCF 全景图：https://landscape.cncf.io/?selected=go-zero) 是一个集成了大量工程实践的 Web 和 RPC 框架。它的诞生是为了确保高负载服务的稳定性,通过弹性设计,多年来一直为拥有数千万用户的网站提供服务。

go-zero 包含简单的 API 描述语法和代码生成工具 goctl。您可以使用 goctl 从 .api 文件生成 Go、iOS、Android、Kotlin、Dart、TypeScript、JavaScript 代码。

go-zero 的优势:

• 提高了日活用户数千万的服务的稳定性
• 内置链式超时控制、并发控制、限流、自适应熔断、自适应负载降级,甚至无需配置
• 内置中间件也可以集成到您的框架中
• 简单的 API 语法,一条命令生成多种不同语言的代码
• 自动验证客户端请求参数
• 丰富的内置微服务管理和并发工具包

<img src="https://yellow-cdn.veclightyear.com/2b54e442/6c97a8b5-1d4c-4f58-b301-8d1ce24cae08.png" alt="架构" width="1500" />

go-zero 的背景

2018年初,我们开始了系统重新设计的转型之旅,从基于 Java 和 MongoDB 的单体架构转向微服务架构。经过仔细研究和比较,我们做出了以下慎重选择:

• 选择 Golang

  • 卓越的性能
  • 简洁的语法
  • 经过验证的工程效率
  • 极致的部署体验
  • 更少的服务器资源消耗

• 自行设计微服务架构

  • 微服务架构便于创建可扩展、灵活和可维护的软件系统,具有独立、可重用的组件。
  • 易于定位微服务中的问题。
  • 易于通过添加或修改特定微服务来扩展功能,而不影响整个系统。

go-zero 的设计考虑

在设计微服务架构时,我们期望确保稳定性和生产力。从一开始,我们就有以下设计原则:

• 保持简单
• 高可用性
• 高并发稳定性
• 易于扩展
• 弹性设计,面向失败编程
• 尽量对业务逻辑开发友好,封装复杂性
• 一件事,一种方式

经过近半年的时间,我们完成了从单体系统到微服务系统的转型,并于2018年8月部署。新系统保证了业务增长和系统稳定性。

go-zero 的实现和特性

go-zero 是一个集成了大量工程实践的 Web 和 RPC 框架。主要特性如下:

• 强大的工具支持,减少代码编写
• 简单的接口
• 完全兼容 net/http
• 支持中间件,易于扩展
• 高性能
• 面向失败编程,弹性设计
• 内置服务发现、负载均衡
• 内置并发控制、自适应熔断、自适应负载降级、自动触发、自动恢复
• 自动验证 API 请求参数
• 链式超时控制
• 自动管理数据缓存
• 调用跟踪、指标和监控
• 高并发保护

如下图所示,go-zero 通过多层和多种机制保护系统:

我们使用 go-zero 的简化架构

<img width="1067" alt="图片" src="https://yellow-cdn.veclightyear.com/2b54e442/430227c9-1bc1-4c37-a4f3-f2e20ecaf62f.png">

安装

在您的项目下运行以下命令:

go get -u github.com/zeromicro/go-zero

快速开始

1. 完整示例可以查看以下内容:

   微服务系统的快速开发

   微服务系统的快速开发 - 多个 RPC

2. 安装 goctl

   goctl 可以读作 go control。goctl 意味着不被代码控制,而是我们控制它。内部的 go 不是 golang。一开始,我希望它能帮助我们提高生产力,让我们的生活更轻松。

   # 对于 Go
   go install github.com/zeromicro/go-zero/tools/goctl@latest
   
   # 对于 Mac
   brew install goctl
   
   # 适用于所有平台的 docker
   docker pull kevinwan/goctl
   # 运行 goctl
   docker run --rm -it -v `pwd`:/app kevinwan/goctl --help

   确保 goctl 可执行且在您的 $PATH 中。

3. 创建 API 文件,如 greet.api,您可以在 VS Code 中安装 goctl 插件,支持 api 语法。

   type (
     Request {
       Name string `path:"name,options=[you,me]"` // 参数会自动验证
     }
   
     Response {
       Message string `json:"message"`
     }
   )
   
   service greet-api {
     @handler GreetHandler
     get /greet/from/:name(Request) returns (Response)
   }

   .api 文件也可以通过 goctl 生成,如下所示:

   goctl api -o greet.api

4. 生成 Go 服务端代码

   goctl api go -api greet.api -dir greet

   生成的文件结构如下:

   ├── greet
   │   ├── etc
   │   │   └── greet-api.yaml        // 配置文件
   │   ├── greet.go                  // main 文件
   │   └── internal
   │       ├── config
   │       │   └── config.go         // 配置定义
   │       ├── handler
   │       │   ├── greethandler.go   // get/put/post/delete 路由在此定义
   │       │   └── routes.go         // 路由列表
   │       ├── logic
   │       │   └── greetlogic.go     // 请求逻辑可以在此编写
   │       ├── svc
   │       │   └── servicecontext.go // 服务上下文,可以在此传入 mysql/redis
   │       └── types
   │           └── types.go          // 请求/响应定义
   └── greet.api                     // api 描述文件

   生成的代码可以直接运行:

   cd greet
   go mod tidy
   go run greet.go -f etc/greet-api.yaml

   默认情况下,它监听 8888 端口,可以在配置文件中更改。

   您可以通过 curl 进行检查:

   curl -i http://localhost:8888/greet/from/you

   响应如下所示:

   HTTP/1.1 200 OK
   Date: Sun, 30 Aug 2020 15:32:35 GMT
   Content-Length: 0

5. 编写业务逻辑代码

   • 可以在 servicecontext.go 中将依赖项传递到逻辑中,如 mysql、redis 等。
   • 根据 .api 文件在 logic 包中添加逻辑代码

6. 仅从 api 文件生成 Java、TypeScript、Dart、JavaScript 等代码

   goctl api java -api greet.api -dir greet
   goctl api dart -api greet.api -dir greet
   ...

基准测试

查看测试代码

文档

• 文档
• 微服务系统的快速开发
• 微服务系统的快速开发 - 多个 RPC
• 示例

聊天群

通过 https://discord.gg/4JQvC5A4Fe 加入聊天

云原生全景图

<p float="left"> <img src="https://yellow-cdn.veclightyear.com/2b54e442/96c8c73a-1bdb-4d48-86b5-4340d918eb07.svg" width="200"/>&nbsp;&nbsp;&nbsp; <img src="https://yellow-cdn.veclightyear.com/2b54e442/5053d0d3-c9cc-4ef9-9b37-ddc1bd8e6fdc.svg" width="150"/> </p>

go-zero 已列入 CNCF 云原生全景图。

给个星星! ⭐

如果您喜欢这个项目或正在使用它来学习或开始您自己的解决方案,请给它一个星星以获取新版本的更新。您的支持很重要!

请我喝杯咖啡

<a href="https://www.buymeacoffee.com/kevwan" target="_blank"><img src="https://yellow-cdn.veclightyear.com/2b54e442/a75e7ce2-892d-4e98-8843-14bfb3e7cb5b.png" alt="给我买杯咖啡" style="height: 60px !important;width: 217px !important;" ></a>