zeromicro
/
go-zero
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

add english readme

Browse Source
master
kevin 4 years ago
parent a1d2ea9d85
commit 6814c86fcd
4 changed files with 313 additions and 105 deletions
Show Stats Download Patch File Download Diff File

BIN
doc/images/architecture-en.png
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 286 KiB

BIN
doc/images/resilience-en.png
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 170 KiB

183
readme.md
Unescape Escape View File

@ -1,3 +1,5 @@
English | [简体中文](readme_zh-CN.md)
# go-zero # go-zero
[![Go](https://github.com/tal-tech/go-zero/workflows/Go/badge.svg?branch=master)](https://github.com/tal-tech/go-zero/actions) [![Go](https://github.com/tal-tech/go-zero/workflows/Go/badge.svg?branch=master)](https://github.com/tal-tech/go-zero/actions)
@ -6,82 +8,82 @@
[![Release](https://img.shields.io/github/v/release/tal-tech/go-zero.svg?style=flat-square)](https://github.com/tal-tech/go-zero) [![Release](https://img.shields.io/github/v/release/tal-tech/go-zero.svg?style=flat-square)](https://github.com/tal-tech/go-zero)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
## 0. go-zero介绍 ## 0. what is go-zero?
go-zero是一个集成了各种工程实践的web和rpc框架。通过弹性设计保障了大并发服务端的稳定性，经受了充分的实战检验。 go-zero is a web and rpc framework that with lots of engineering practices builtin. It’s born to ensure the stabibility of the busy services with resilience design, and has been serving sites with tens of millions users for years.
go-zero 包含极简的 API 定义和生成工具 goctl，可以根据定义的 api 文件一键生成 Go, iOS, Android, Kotlin, Dart, TypeScript, JavaScript 代码，并可直接运行。 go-zero contains simple API description syntax and code generation tool called `goctl`. You can generate Go, iOS, Android, Kotlin, Dart, TypeScript, JavaScript from .api files with `goctl`.
使用go-zero的好处： Advantages of go-zero:
* 轻松获得支撑千万日活服务的稳定性 * improve the stability of the services with tens of millions of daily active users
* 内建级联超时控制、限流、自适应熔断、自适应降载等微服务治理能力，无需配置和额外代码 * builtin chained timeout control, concurrency control, rate limit, adaptive circuit breaker, adaptive load shedding, even no configuration needed
* 微服务治理中间件可无缝集成到其它现有框架使用 * builtin middlewares also can be integrated into your frameworks
* 极简的API描述，一键生成各端代码 * simple API syntax, one command to generate couple different languages
* 自动校验客户端请求参数合法性 * auto validate the request parameters from clients
* 大量微服务治理和并发工具包 * plenty of builtin microservice management and concurrent toolkits
<img src="doc/images/architecture.png" alt="架构图" width="1500" /> <img src="doc/images/architecture-en.png" alt="Architecture" width="1500" />
## 1. go-zero框架背景 ## 1. Backgrounds of go-zero
18年初，晓黑板后端在经过频繁的宕机后，决定从`Java+MongoDB`的单体架构迁移到微服务架构，经过仔细思考和对比，我们决定： At the beginning of 2018, we heavily suffered from frequent downtime. We decided to re-design our system, from monolithic architecture with Java+MongoDB to microservice architecture. After researches and comparison, we chose to:
* 基于Go语言 * Golang based
* 高效的性能 * great performance
* 简洁的语法 * simple syntax
* 广泛验证的工程效率 * proven engineering efficiency
* 极致的部署体验 * extreme deployment experience
* 极低的服务端资源成本 * less server resource consumption
* 自研微服务框架 * Self-designed microservice architecture
* 个人有过很多微服务框架自研经验 * I have rich experience on designing microservice architectures
* 需要有更快速的问题定位能力 * easy to location the problems
* 更便捷的增加新特性 * easy to extend the features
## 2. go-zero框架设计思考 ## 2. Design considerations on go-zero
对于微服务框架的设计，我们期望保障微服务稳定性的同时，也要特别注重研发效率。所以设计之初，我们就有如下一些准则： By designing the microservice architecture, we expected to ensure the stability, as well as the productivity. And from just the beginning, we have the following design principles:
* 保持简单 * keep it simple
* 高可用 * high availability
* 高并发 * stable on high concurrency
* 易扩展 * easy to extend
* 弹性设计，面向故障编程 * resilience design, failure-oriented programming
* 尽可能对业务开发友好，封装复杂度 * try best to be friendly to the business logic development, encapsulate the complexity
* 尽可能约束做一件事只有一种方式 * one thing, one way
我们经历不到半年时间，彻底完成了从`Java+MongoDB`到`Golang+MySQL`为主的微服务体系迁移，并于18年8月底完全上线，稳定保障了晓黑板后续增长，确保了整个服务的高可用。 After almost half a year, we finished the transfer from monolithic system to microservice system, and deployed on August 2018. The new system guaranteed the business growth, and the system stability.
## 3. go-zero项目实现和特点 ## 3. The implementation and features of go-zero
go-zero是一个集成了各种工程实践的包含web和rpc框架，有如下主要特点： go-zero is a web and rpc framework that integrates lots of engineering practices. The features are mainly listed below:
* 强大的工具支持，尽可能少的代码编写 * powerful tool included, less code to write
* 极简的接口 * simple interfaces
* 完全兼容net/http * fully compatible with net/http
* 支持中间件，方便扩展 * middlewares are supported, easy to extend
* 高性能 * high performance
* 面向故障编程，弹性设计 * failure-oriented programming, resilience design
* 内建服务发现、负载均衡 * builtin service discovery, load balancing
* 内建限流、熔断、降载，且自动触发，自动恢复 * builtin concurrency control, adaptive circuit breaker, adaptive load shedding, auto trigger, auto recover
* API参数自动校验 * auto validation of API request parameters
* 超时级联控制 * chained timeout control
* 自动缓存控制 * auto management of data caching
* 链路跟踪、统计报警等 * call tracing, metrics and monitoring
* 高并发支撑，稳定保障了晓黑板疫情期间每天的流量洪峰 * high concurrency protected
如下图，我们从多个层面保障了整体服务的高可用： As below, go-zero protects the system with couple layers and mechanisms:
![弹性设计](doc/images/resilience.jpg) ![Resilience](doc/images/resilience-en.png)
## 4. go-zero近期开发计划 ## 4. Future development plans of go-zero
* 自动生成API mock server，便于客户端开发 * auto generate API mock server, make the client debugging eaisier
* 自动生成服务端功能测试 * auto generate the simple integration test for the server side just from the .api files
## 5. Installation ## 5. Installation
在项目目录下通过如下命令安装： Run the following command under your project:
```shell ```shell
go get -u github.com/tal-tech/go-zero go get -u github.com/tal-tech/go-zero
@ -89,27 +91,27 @@ go get -u github.com/tal-tech/go-zero
## 6. Quick Start ## 6. Quick Start
0. 完整示例请查看 0. full examples can be checked out from below:
[快速构建高并发微服务](doc/shorturl.md) [Rapid development of microservice systems](doc/shorturl.md)
[快速构建高并发微服务-多RPC版](doc/bookstore.md) [Rapid development of microservice systems - multiple RPCs](doc/bookstore.md)
1. 安装goctl工具 1. install goctl
`goctl`读作`go control`，不要读成`go C-T-L`。`goctl`的意思是不要被代码控制，而是要去控制它。其中的`go`不是指`golang`。在设计`goctl`之初，我就希望通过`她`来解放我们的双手👈 `goctl`can be read as `go control`. `goctl means not to be controlled by code, instead, we control it. The inside `go` is not `golang`. At the very beginning, I was expecting it to help us improve the productivity, and make our lives easier.
```shell ```shell
GO111MODULE=on GOPROXY=https://goproxy.cn/,direct go get -u github.com/tal-tech/go-zero/tools/goctl GO111MODULE=on go get -u github.com/tal-tech/go-zero/tools/goctl
``` ```
确保goctl可执行 make sure goctl is executable.
2. 定义API文件，比如greet.api，可以在vs code里安装`goctl`插件，支持api语法 2. create the API file, like greet.api, you can install the plugin of goctl in vs code, api syntax is supported.
```go ```go
type Request struct { type Request struct {
Name string `path:"name,options=you|me"` // 框架自动验证请求参数是否合法 Name string `path:"name,options=you|me"` // parameters are auto validated
} }
type Response struct { type Response struct {
@ -124,53 +126,55 @@ go get -u github.com/tal-tech/go-zero
} }
``` ```
也可以通过goctl生成api模本文件，命令如下： the .api files also can be generate by goctl, like below:
```shell ```shell
goctl api -o greet.api goctl api -o greet.api
``` ```
3. 生成go服务端代码 3. generate the go server side code
```shell ```shell
goctl api go -api greet.api -dir greet goctl api go -api greet.api -dir greet
``` ```
生成的文件结构如下： the generated files look like:
``` ```
├── greet ├── greet
│   ├── etc │   ├── etc
│   │   └── greet-api.yaml // 配置文件 │   │   └── greet-api.yaml // configuration file
│   ├── greet.go // main文件 │   ├── greet.go // main file
│   └── internal │   └── internal
│   ├── config │   ├── config
│   │   └── config.go // 配置定义 │   │   └── config.go // configuration definition
│   ├── handler │   ├── handler
│   │   ├── greethandler.go // get/put/post/delete等路由定义文件 │   │   ├── greethandler.go // get/put/post/delete routes are defined here
│   │   └── routes.go // 路由列表 │   │   └── routes.go // routes list
│   ├── logic │   ├── logic
│   │   └── greetlogic.go // 请求逻辑处理文件 │   │   └── greetlogic.go // request logic can be written here
│   ├── svc │   ├── svc
│   │   └── servicecontext.go // 请求上下文，可以传入mysql, redis等依赖 │   │   └── servicecontext.go // service context, mysql/redis can be passed in here
│   └── types │   └── types
│   └── types.go // 请求、返回等类型定义 │   └── types.go // request/response defined here
└── greet.api // api描述文件 └── greet.api // api description file
``` ```
生成的代码可以直接运行： the generated code can be run directly:
```shell ```shell
cd greet cd greet
go run greet.go -f etc/greet-api.yaml go run greet.go -f etc/greet-api.yaml
``` ```
默认侦听在8888端口（可以在配置文件里修改），可以通过curl请求： by default, it’s listening on port 8888, while it can be changed in configuration file.
you can check it by curl:
```shell ```shell
curl -i http://localhost:8888/greet/from/you curl -i http://localhost:8888/greet/from/you
``` ```
返回如下： the response looks like:
```http ```http
HTTP/1.1 200 OK HTTP/1.1 200 OK
@ -178,12 +182,11 @@ Date: Sun, 30 Aug 2020 15:32:35 GMT
Content-Length: 0 Content-Length: 0
``` ```
编写业务代码： 4. Write the business logic code
* 可以在servicecontext.go里面传递依赖给logic，比如mysql, redis等
* 在api定义的get/post/put/delete等请求对应的logic里增加业务处理逻辑
4. 可以根据api文件生成前端需要的Java, TypeScript, Dart, JavaScript代码 * the dependencies can be passed into the logic within servicecontext.go, like mysql, reds etc.
* add the logic code in logic package according to .api file
5. Generate code like Java, TypeScript, Dart, JavaScript etc. just from the api file
```shell ```shell
goctl api java -api greet.api -dir greet goctl api java -api greet.api -dir greet
@ -195,15 +198,9 @@ Content-Length: 0
![benchmark](doc/images/benchmark.png) ![benchmark](doc/images/benchmark.png)
[测试代码见这里](https://github.com/smallnest/go-web-framework-benchmark) [Checkout the test code](https://github.com/smallnest/go-web-framework-benchmark)
## 8. 文档 (逐步完善中)
* [快速构建高并发微服务](doc/shorturl.md)
* [快速构建高并发微服务-多RPC版](doc/bookstore.md)
* [goctl使用帮助](doc/goctl.md)
* [关键字替换和敏感词过滤工具](doc/keywords.md)
## 9. 微信交流群 ## 8. Documents (adding)
<img src="doc/images/wechat.jpg" alt="wechat" width="300" /> * [Rapid development of microservice systems](doc/shorturl.md)
* [Rapid development of microservice systems - multiple RPCs](doc/bookstore.md)

211
readme_zh-CN.md
Unescape Escape View File

@ -0,0 +1,211 @@
[English](readme.md) | 简体中文
# go-zero
[![Go](https://github.com/tal-tech/go-zero/workflows/Go/badge.svg?branch=master)](https://github.com/tal-tech/go-zero/actions)
[![codecov](https://codecov.io/gh/tal-tech/go-zero/branch/master/graph/badge.svg)](https://codecov.io/gh/tal-tech/go-zero)
[![Go Report Card](https://goreportcard.com/badge/github.com/tal-tech/go-zero)](https://goreportcard.com/report/github.com/tal-tech/go-zero)
[![Release](https://img.shields.io/github/v/release/tal-tech/go-zero.svg?style=flat-square)](https://github.com/tal-tech/go-zero)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
## 0. go-zero介绍
go-zero是一个集成了各种工程实践的web和rpc框架。通过弹性设计保障了大并发服务端的稳定性，经受了充分的实战检验。
go-zero 包含极简的 API 定义和生成工具 goctl，可以根据定义的 api 文件一键生成 Go, iOS, Android, Kotlin, Dart, TypeScript, JavaScript 代码，并可直接运行。
使用go-zero的好处：
* 轻松获得支撑千万日活服务的稳定性
* 内建级联超时控制、限流、自适应熔断、自适应降载等微服务治理能力，无需配置和额外代码
* 微服务治理中间件可无缝集成到其它现有框架使用
* 极简的API描述，一键生成各端代码
* 自动校验客户端请求参数合法性
* 大量微服务治理和并发工具包
<img src="doc/images/architecture.png" alt="架构图" width="1500" />
## 1. go-zero框架背景
18年初，晓黑板后端在经过频繁的宕机后，决定从`Java+MongoDB`的单体架构迁移到微服务架构，经过仔细思考和对比，我们决定：
* 基于Go语言
* 高效的性能
* 简洁的语法
* 广泛验证的工程效率
* 极致的部署体验
* 极低的服务端资源成本
* 自研微服务框架
* 个人有过很多微服务框架自研经验
* 需要有更快速的问题定位能力
* 更便捷的增加新特性
## 2. go-zero框架设计思考
对于微服务框架的设计，我们期望保障微服务稳定性的同时，也要特别注重研发效率。所以设计之初，我们就有如下一些准则：
* 保持简单
* 高可用
* 高并发
* 易扩展
* 弹性设计，面向故障编程
* 尽可能对业务开发友好，封装复杂度
* 尽可能约束做一件事只有一种方式
我们经历不到半年时间，彻底完成了从`Java+MongoDB`到`Golang+MySQL`为主的微服务体系迁移，并于18年8月底完全上线，稳定保障了晓黑板后续增长，确保了整个服务的高可用。
## 3. go-zero项目实现和特点
go-zero是一个集成了各种工程实践的包含web和rpc框架，有如下主要特点：
* 强大的工具支持，尽可能少的代码编写
* 极简的接口
* 完全兼容net/http
* 支持中间件，方便扩展
* 高性能
* 面向故障编程，弹性设计
* 内建服务发现、负载均衡
* 内建限流、熔断、降载，且自动触发，自动恢复
* API参数自动校验
* 超时级联控制
* 自动缓存控制
* 链路跟踪、统计报警等
* 高并发支撑，稳定保障了晓黑板疫情期间每天的流量洪峰
如下图，我们从多个层面保障了整体服务的高可用：
![弹性设计](doc/images/resilience.jpg)
## 4. go-zero近期开发计划
* 自动生成API mock server，便于客户端开发
* 自动生成服务端功能测试
## 5. Installation
在项目目录下通过如下命令安装：
```shell
go get -u github.com/tal-tech/go-zero
```
## 6. Quick Start
0. 完整示例请查看
[快速构建高并发微服务](doc/shorturl.md)
[快速构建高并发微服务-多RPC版](doc/bookstore.md)
1. 安装goctl工具
`goctl`读作`go control`，不要读成`go C-T-L`。`goctl`的意思是不要被代码控制，而是要去控制它。其中的`go`不是指`golang`。在设计`goctl`之初，我就希望通过`她`来解放我们的双手👈
```shell
GO111MODULE=on GOPROXY=https://goproxy.cn/,direct go get -u github.com/tal-tech/go-zero/tools/goctl
```
确保goctl可执行
2. 定义API文件，比如greet.api，可以在vs code里安装`goctl`插件，支持api语法
```go
type Request struct {
Name string `path:"name,options=you|me"` // 框架自动验证请求参数是否合法
}
type Response struct {
Message string `json:"message"`
}
service greet-api {
@server(
handler: GreetHandler
)
get /greet/from/:name(Request) returns (Response);
}
```
也可以通过goctl生成api模本文件，命令如下：
```shell
goctl api -o greet.api
```
3. 生成go服务端代码
```shell
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描述文件
```
生成的代码可以直接运行：
```shell
cd greet
go run greet.go -f etc/greet-api.yaml
```
默认侦听在8888端口（可以在配置文件里修改），可以通过curl请求：
```shell
curl -i http://localhost:8888/greet/from/you
```
返回如下：
```http
HTTP/1.1 200 OK
Date: Sun, 30 Aug 2020 15:32:35 GMT
Content-Length: 0
```
编写业务代码：
* 可以在servicecontext.go里面传递依赖给logic，比如mysql, redis等
* 在api定义的get/post/put/delete等请求对应的logic里增加业务处理逻辑
4. 可以根据api文件生成前端需要的Java, TypeScript, Dart, JavaScript代码
```shell
goctl api java -api greet.api -dir greet
goctl api dart -api greet.api -dir greet
...
```
## 7. Benchmark
![benchmark](doc/images/benchmark.png)
[测试代码见这里](https://github.com/smallnest/go-web-framework-benchmark)
## 8. 文档 (逐步完善中)
* [快速构建高并发微服务](doc/shorturl.md)
* [快速构建高并发微服务-多RPC版](doc/bookstore.md)
* [goctl使用帮助](doc/goctl.md)
* [关键字替换和敏感词过滤工具](doc/keywords.md)
## 9. 微信交流群
<img src="doc/images/wechat.jpg" alt="wechat" width="300" />
Write Preview
Loading…
Cancel
Save