use english readme as default, because of github ranking (zeromicro#427)

ScreamWolf · Feb 2, 2021 · c3b9c3c · c3b9c3c
1 parent a8b550e
commit c3b9c3c
Show file tree

Hide file tree

Showing 4 changed files with 364 additions and 349 deletions.
diff --git a/core/stores/cache/cachenode.go b/core/stores/cache/cachenode.go
@@ -37,6 +37,12 @@ type cacheNode struct {
 	errNotFound    error
 }
 
+// NewCacheNode returns a cacheNode.
+// rds is the underlying redis node or cluster.
+// barrier is the barrier that maybe shared with other cache nodes on cache cluster.
+// st is used to stat the cache.
+// errNotFound defines the error that returned on cache not found.
+// opts are the options that customize the cacheNode.
 func NewCacheNode(rds *redis.Redis, barrier syncx.SharedCalls, st *CacheStat,
 	errNotFound error, opts ...Option) Cache {
 	o := newOptions(opts...)
@@ -53,6 +59,7 @@ func NewCacheNode(rds *redis.Redis, barrier syncx.SharedCalls, st *CacheStat,
 	}
 }
 
+// DelCache deletes cached values with keys.
 func (c cacheNode) DelCache(keys ...string) error {
 	if len(keys) == 0 {
 		return nil
@@ -66,6 +73,7 @@ func (c cacheNode) DelCache(keys ...string) error {
 	return nil
 }
 
+// GetCache gets the cache with key and fills into v.
 func (c cacheNode) GetCache(key string, v interface{}) error {
 	if err := c.doGetCache(key, v); err == errPlaceholder {
 		return c.errNotFound
@@ -74,10 +82,12 @@ func (c cacheNode) GetCache(key string, v interface{}) error {
 	}
 }
 
+// SetCache sets the cache with key and v, using c.expiry.
 func (c cacheNode) SetCache(key string, v interface{}) error {
 	return c.SetCacheWithExpire(key, v, c.aroundDuration(c.expiry))
 }
 
+// SetCacheWithExpire sets the cache with key and v, using given expire.
 func (c cacheNode) SetCacheWithExpire(key string, v interface{}, expire time.Duration) error {
 	data, err := jsonx.Marshal(v)
 	if err != nil {
@@ -87,18 +97,23 @@ func (c cacheNode) SetCacheWithExpire(key string, v interface{}, expire time.Dur
 	return c.rds.Setex(key, string(data), int(expire.Seconds()))
 }
 
+// String returns a string that represents the cacheNode.
 func (c cacheNode) String() string {
 	return c.rds.Addr
 }
 
+// TakeWithExpire takes the result from cache first, if not found,
+// query from DB and set cache using c.expiry, then return the result.
 func (c cacheNode) Take(v interface{}, key string, query func(v interface{}) error) error {
 	return c.doTake(v, key, query, func(v interface{}) error {
 		return c.SetCache(key, v)
 	})
 }
 
-func (c cacheNode) TakeWithExpire(v interface{}, key string,
-	query func(v interface{}, expire time.Duration) error) error {
+// TakeWithExpire takes the result from cache first, if not found,
+// query from DB and set cache using given expire, then return the result.
+func (c cacheNode) TakeWithExpire(v interface{}, key string, query func(v interface{},
+	expire time.Duration) error) error {
 	expire := c.aroundDuration(c.expiry)
 	return c.doTake(v, key, func(v interface{}) error {
 		return query(v, expire)

diff --git a/readme-cn.md b/readme-cn.md
@@ -0,0 +1,199 @@
+<img align="right" width="150px" src="https://gitee.com/kevwan/static/raw/master/doc/images/go-zero.png">
+
+# go-zero
+
+[English](readme-en.md) | 简体中文
+
+[![Go](https://github.com/tal-tech/go-zero/workflows/Go/badge.svg?branch=master)](https://github.com/tal-tech/go-zero/actions)
+[![Go Report Card](https://goreportcard.com/badge/github.com/tal-tech/go-zero)](https://goreportcard.com/report/github.com/tal-tech/go-zero)
+[![goproxy](https://goproxy.cn/stats/github.com/tal-tech/go-zero/badges/download-count.svg)](https://goproxy.cn/stats/github.com/tal-tech/go-zero/badges/download-count.svg)
+[![codecov](https://codecov.io/gh/tal-tech/go-zero/branch/master/graph/badge.svg)](https://codecov.io/gh/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="https://gitee.com/kevwan/static/raw/master/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 参数自动校验
+* 超时级联控制
+* 自动缓存控制
+* 链路跟踪、统计报警等
+* 高并发支撑，稳定保障了疫情期间每天的流量洪峰
+
+如下图，我们从多个层面保障了整体服务的高可用：
+
+![弹性设计](https://gitee.com/kevwan/static/raw/master/doc/images/resilience.jpg)
+
+觉得不错的话，别忘 **star** 👏
+
+## 4. Installation
+
+在项目目录下通过如下命令安装：
+
+```shell
+GO111MODULE=on GOPROXY=https://goproxy.cn/,direct go get -u github.com/tal-tech/go-zero
+```
+
+## 5. Quick Start
+
+0. 完整示例请查看
+
+    [快速构建高并发微服务](https://github.com/tal-tech/zero-doc/blob/main/doc/shorturl.md)
+
+    [快速构建高并发微服务 - 多 RPC 版](https://github.com/tal-tech/zero-doc/blob/main/docs/zero/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 服务
+
+    ```shell
+    goctl api new greet
+    cd greet
+    go mod init
+    go mod tidy
+    go run greet.go -f etc/greet-api.yaml
+    ```
+
+    默认侦听在 8888 端口（可以在配置文件里修改），可以通过 curl 请求：
+
+    ```shell
+    curl -i http://localhost:8888/from/you
+    ```
+
+    返回如下：
+
+    ```http
+    HTTP/1.1 200 OK
+    Content-Type: application/json
+	Date: Thu, 22 Oct 2020 14:03:18 GMT
+	Content-Length: 14
+
+	{"message":""}
+    ```
+
+    编写业务代码：
+
+      * api 文件定义了服务对外暴露的路由，可参考 [api 规范](https://github.com/tal-tech/zero-doc/blob/main/doc/goctl.md)
+      * 可以在 servicecontext.go 里面传递依赖给 logic，比如 mysql, redis 等
+      * 在 api 定义的 get/post/put/delete 等请求对应的 logic 里增加业务处理逻辑
+
+3. 可以根据 api 文件生成前端需要的 Java, TypeScript, Dart, JavaScript 代码
+
+    ```shell
+    goctl api java -api greet.api -dir greet
+    goctl api dart -api greet.api -dir greet
+    ...
+    ```
+
+## 6. Benchmark
+
+![benchmark](https://gitee.com/kevwan/static/raw/master/doc/images/benchmark.png)
+
+[测试代码见这里](https://github.com/smallnest/go-web-framework-benchmark)
+
+## 7. 文档
+
+* API 文档
+
+  [https://www.yuque.com/tal-tech/go-zero](https://www.yuque.com/tal-tech/go-zero)
+
+* awesome 系列（更多文章见『微服务实践』公众号）
+  * [快速构建高并发微服务](https://github.com/tal-tech/zero-doc/blob/main/doc/shorturl.md)
+  * [快速构建高并发微服务 - 多 RPC 版](https://github.com/tal-tech/zero-doc/blob/main/docs/zero/bookstore.md)
+  * [goctl 使用帮助](https://github.com/tal-tech/zero-doc/blob/main/doc/goctl.md)
+
+* 精选 `goctl` 插件
+
+  | 插件    | 用途  |
+  | ------------- |:-------------|
+  | [goctl-swagger](https://github.com/zeromicro/goctl-swagger) | 一键生成 `api` 的 `swagger` 文档 |
+  | [goctl-android](https://github.com/zeromicro/goctl-android) | 生成 `java (android)` 端 `http client` 请求代码 |
+  | [goctl-go-compact](https://github.com/zeromicro/goctl-go-compact) | 合并 `api` 里同一个 `group` 里的 `handler` 到一个 `go` 文件 |
+
+## 8. 微信公众号
+
+`go-zero` 相关文章都会在 `微服务实践` 公众号整理呈现，欢迎扫码关注，也可以通过公众号私信我 👏
+
+<img src="https://gitee.com/kevwan/static/raw/master/images/wechat-micro.jpg" alt="wechat" width="300" />
+
+## 9. 微信交流群
+
+如果文档中未能覆盖的任何疑问，欢迎您在群里提出，我们会尽快答复。
+
+您可以在群内提出使用中需要改进的地方，我们会考虑合理性并尽快修改。
+
+如果您发现 ***bug*** 请及时提 ***issue***，我们会尽快确认并修改。
+
+为了防止广告用户、识别技术同行，请 ***star*** 后加我时注明 **github** 当前 ***star*** 数，我再拉进 **go-zero** 群，感谢！
+
+加我之前有劳点一下 ***star***，一个小小的 ***star*** 是作者们回答海量问题的动力🤝
+
+<img src="https://gitee.com/kevwan/static/raw/master/images/wechat.jpg" alt="wechat" width="300" />
+
+项目地址：[https://github.com/tal-tech/go-zero](https://github.com/tal-tech/go-zero)
+
+码云地址：[https://gitee.com/kevwan/go-zero](https://gitee.com/kevwan/go-zero) (国内用户可访问gitee，每日自动从github同步代码)