pull/633/head
Windfarer 4 years ago
parent 9636e6bcf0
commit 153e47565d
  1. 10
      README.md
  2. 0
      docs/.nojekyll
  3. 0
      docs/FAQ.md
  4. 75
      docs/README.md
  5. 3
      docs/_sidebar.md
  6. 5
      docs/blademaster-mid.md
  7. 5
      docs/blademaster-mod.md
  8. 3
      docs/blademaster-pb.md
  9. 3
      docs/blademaster-quickstart.md
  10. 7
      docs/blademaster.md
  11. 0
      docs/breaker.md
  12. 3
      docs/cache-mc.md
  13. 3
      docs/cache-redis.md
  14. 3
      docs/cache.md
  15. 0
      docs/config-paladin.md
  16. 3
      docs/config.md
  17. 3
      docs/database-hbase.md
  18. 3
      docs/database-mysql-orm.md
  19. 3
      docs/database-mysql.md
  20. 0
      docs/database-tidb.md
  21. 3
      docs/database.md
  22. 0
      docs/ecode.md
  23. 0
      docs/img/bm-arch-2-2.png
  24. 0
      docs/img/bm-arch-2-3.png
  25. 0
      docs/img/bm-handlers.png
  26. 0
      docs/img/kratos-log.jpg
  27. 0
      docs/img/kratos.png
  28. 0
      docs/img/kratos2.png
  29. 0
      docs/img/kratos3.png
  30. 0
      docs/img/ratelimit-benchmark-up-1.png
  31. 0
      docs/img/ratelimit-rolling-window.png
  32. 0
      docs/img/zipkin.jpg
  33. 22
      docs/index.html
  34. 3
      docs/install.md
  35. 3
      docs/kratos-genbts.md
  36. 3
      docs/kratos-genmc.md
  37. 3
      docs/kratos-protoc.md
  38. 3
      docs/kratos-swagger.md
  39. 5
      docs/kratos-tool.md
  40. 0
      docs/log-agent.md
  41. 3
      docs/logger.md
  42. 3
      docs/protoc.md
  43. 3
      docs/quickstart.md
  44. 7
      docs/ratelimit.md
  45. 2
      docs/trace.md
  46. 25
      docs/ut-support.md
  47. 0
      docs/ut-testcli.md
  48. 7
      docs/ut-testgen.md
  49. 6
      docs/ut.md
  50. 4
      docs/warden-balancer.md
  51. 7
      docs/warden-mid.md
  52. 3
      docs/warden-pb.md
  53. 4
      docs/warden-quickstart.md
  54. 4
      docs/warden-resolver.md
  55. 3
      docs/warden.md

@ -1,4 +1,4 @@
![kratos](doc/img/kratos3.png) ![kratos](docs/img/kratos3.png)
[![Language](https://img.shields.io/badge/Language-Go-blue.svg)](https://golang.org/) [![Language](https://img.shields.io/badge/Language-Go-blue.svg)](https://golang.org/)
[![Build Status](https://github.com/go-kratos/kratos/workflows/Go/badge.svg)](https://github.com/go-kratos/kratos/actions) [![Build Status](https://github.com/go-kratos/kratos/workflows/Go/badge.svg)](https://github.com/go-kratos/kratos/actions)
@ -20,7 +20,7 @@ Kratos是[bilibili](https://www.bilibili.com)开源的一套Go微服务框架,
* GRPC Warden:基于官方gRPC开发,集成[discovery](https://github.com/bilibili/discovery)服务发现,并融合P2C负载均衡; * GRPC Warden:基于官方gRPC开发,集成[discovery](https://github.com/bilibili/discovery)服务发现,并融合P2C负载均衡;
* Cache:优雅的接口化设计,非常方便的缓存序列化,推荐结合代理模式[overlord](https://github.com/bilibili/overlord); * Cache:优雅的接口化设计,非常方便的缓存序列化,推荐结合代理模式[overlord](https://github.com/bilibili/overlord);
* Database:集成MySQL/HBase/TiDB,添加熔断保护和统计支持,可快速发现数据层压力; * Database:集成MySQL/HBase/TiDB,添加熔断保护和统计支持,可快速发现数据层压力;
* Config:方便易用的[paladin sdk](doc/wiki-cn/config.md),可配合远程配置中心,实现配置版本管理和更新; * Config:方便易用的[paladin sdk](https://windfarer.github.io/kratos/#/config),可配合远程配置中心,实现配置版本管理和更新;
* Log:类似[zap](https://github.com/uber-go/zap)的field实现高性能日志库,并结合log-agent实现远程日志管理; * Log:类似[zap](https://github.com/uber-go/zap)的field实现高性能日志库,并结合log-agent实现远程日志管理;
* Trace:基于opentracing,集成了全链路trace支持(gRPC/HTTP/MySQL/Redis/Memcached); * Trace:基于opentracing,集成了全链路trace支持(gRPC/HTTP/MySQL/Redis/Memcached);
* Kratos Tool:工具链,可快速生成标准项目,或者通过Protobuf生成代码,非常便捷使用gRPC、HTTP、swagger文档; * Kratos Tool:工具链,可快速生成标准项目,或者通过Protobuf生成代码,非常便捷使用gRPC、HTTP、swagger文档;
@ -50,12 +50,12 @@ go build
打开浏览器访问:[http://localhost:8000/kratos-demo/start](http://localhost:8000/kratos-demo/start),你会看到输出了`Golang 大法好 !!!` 打开浏览器访问:[http://localhost:8000/kratos-demo/start](http://localhost:8000/kratos-demo/start),你会看到输出了`Golang 大法好 !!!`
[快速开始](doc/wiki-cn/quickstart.md) [kratos工具](doc/wiki-cn/kratos-tool.md) [快速开始](https://windfarer.github.io/kratos/#/quickstart) [kratos工具](https://windfarer.github.io/kratos/#/kratos-tool)
## Documentation ## Documentation
> [简体中文](doc/wiki-cn/summary.md) > [简体中文](https://windfarer.github.io/kratos)
> [FAQ](doc/wiki-cn/FAQ.md) > [FAQ](https://windfarer.github.io/kratos/#/FAQ)
## License ## License
Kratos is under the MIT license. See the [LICENSE](./LICENSE) file for details. Kratos is under the MIT license. See the [LICENSE](./LICENSE) file for details.

@ -1,40 +1,35 @@
# Kratos # Kratos
Kratos是bilibili开源的一套Go微服务框架,包含大量微服务相关框架及工具。 Kratos是bilibili开源的一套Go微服务框架,包含大量微服务相关框架及工具。
### Goals ### Goals
我们致力于提供完整的微服务研发体验,整合相关框架及工具后,微服务治理相关部分可对整体业务开发周期无感,从而更加聚焦于业务交付。对每位开发者而言,整套Kratos框架也是不错的学习仓库,可以了解和参考到bilibili在微服务方面的技术积累和经验。 我们致力于提供完整的微服务研发体验,整合相关框架及工具后,微服务治理相关部分可对整体业务开发周期无感,从而更加聚焦于业务交付。对每位开发者而言,整套Kratos框架也是不错的学习仓库,可以了解和参考到bilibili在微服务方面的技术积累和经验。
### Principles ### Principles
* 简单:不过度设计,代码平实简单 * 简单:不过度设计,代码平实简单
* 通用:通用业务开发所需要的基础库的功能 * 通用:通用业务开发所需要的基础库的功能
* 高效:提高业务迭代的效率 * 高效:提高业务迭代的效率
* 稳定:基础库可测试性高,覆盖率高,有线上实践安全可靠 * 稳定:基础库可测试性高,覆盖率高,有线上实践安全可靠
* 健壮:通过良好的基础库设计,减少错用 * 健壮:通过良好的基础库设计,减少错用
* 高性能:性能高,但不特定为了性能做hack优化,引入unsafe * 高性能:性能高,但不特定为了性能做hack优化,引入unsafe
* 扩展性:良好的接口设计,来扩展实现,或者通过新增基础库目录来扩展功能 * 扩展性:良好的接口设计,来扩展实现,或者通过新增基础库目录来扩展功能
* 容错性:为失败设计,大量引入对SRE的理解,鲁棒性高 * 容错性:为失败设计,大量引入对SRE的理解,鲁棒性高
* 工具链:包含大量工具链,比如cache代码生成,lint工具等等 * 工具链:包含大量工具链,比如cache代码生成,lint工具等等
### Features ### Features
* HTTP Blademaster:核心基于[gin](https://github.com/gin-gonic/gin)进行模块化设计,简单易用、核心足够轻量; * HTTP Blademaster:核心基于[gin](https://github.com/gin-gonic/gin)进行模块化设计,简单易用、核心足够轻量;
* GRPC Warden:基于官方gRPC开发,集成[discovery](https://github.com/bilibili/discovery)服务发现,并融合P2C负载均衡; * GRPC Warden:基于官方gRPC开发,集成[discovery](https://github.com/bilibili/discovery)服务发现,并融合P2C负载均衡;
* Cache:优雅的接口化设计,非常方便的缓存序列化,推荐结合代理模式[overlord](https://github.com/bilibili/overlord); * Cache:优雅的接口化设计,非常方便的缓存序列化,推荐结合代理模式[overlord](https://github.com/bilibili/overlord);
* Database:集成MySQL/HBase/TiDB,添加熔断保护和统计支持,可快速发现数据层压力; * Database:集成MySQL/HBase/TiDB,添加熔断保护和统计支持,可快速发现数据层压力;
* Config:方便易用的[paladin sdk](config-paladin.md),可配合远程配置中心,实现配置版本管理和更新; * Config:方便易用的[paladin sdk](config-paladin.md),可配合远程配置中心,实现配置版本管理和更新;
* Log:类似[zap](https://github.com/uber-go/zap)的field实现高性能日志库,并结合log-agent实现远程日志管理; * Log:类似[zap](https://github.com/uber-go/zap)的field实现高性能日志库,并结合log-agent实现远程日志管理;
* Trace:基于opentracing,集成了全链路trace支持(gRPC/HTTP/MySQL/Redis/Memcached); * Trace:基于opentracing,集成了全链路trace支持(gRPC/HTTP/MySQL/Redis/Memcached);
* Kratos Tool:工具链,可快速生成标准项目,或者通过Protobuf生成代码,非常便捷使用gRPC、HTTP、swagger文档; * Kratos Tool:工具链,可快速生成标准项目,或者通过Protobuf生成代码,非常便捷使用gRPC、HTTP、swagger文档;
<br> -------------
------------- > 名字来源于:《战神》游戏以希腊神话为背景,讲述由凡人成为战神的奎托斯(Kratos)成为战神并展开弑神屠杀的冒险历程。
> 名字来源于:《战神》游戏以希腊神话为背景,讲述由凡人成为战神的奎托斯(Kratos)成为战神并展开弑神屠杀的冒险历程。
-------------
[文档目录树](summary.md)

@ -1,8 +1,7 @@
# Summary
* [介绍](README.md) * [介绍](README.md)
* [快速开始](quickstart.md) * [快速开始](quickstart.md)
* [案例](https://github.com/go-kratos/kratos-demo) * [案例](https://github.com/go-kratos/kratos-demo)
* [FAQ](FAQ.md)
* [http blademaster](blademaster.md) * [http blademaster](blademaster.md)
* [bm quickstart](blademaster-quickstart.md) * [bm quickstart](blademaster-quickstart.md)
* [bm module](blademaster-mod.md) * [bm module](blademaster-mod.md)

@ -158,7 +158,7 @@ e.POST("/api", cors, myHandler)
## 自适应限流 ## 自适应限流
更多关于自适应限流的信息可参考:[kratos 自适应限流](/doc/wiki-cn/ratelimit.md)。如要使用如下: 更多关于自适应限流的信息可参考:[kratos 自适应限流](ratelimit.md)。如要使用如下:
```go ```go
e := bm.DefaultServer(nil) e := bm.DefaultServer(nil)
@ -175,6 +175,3 @@ e.GET("/api", csrf, myHandler)
[bm模块说明](blademaster-mod.md) [bm模块说明](blademaster-mod.md)
[bm基于pb生成](blademaster-pb.md) [bm基于pb生成](blademaster-pb.md)
-------------
[文档目录树](summary.md)

@ -72,7 +72,7 @@ func (c *Context) Protobuf(data proto.Message, err error)
# Handler # Handler
![handler](/doc/img/bm-handlers.png) ![handler](img/bm-handlers.png)
初次接触`blademaster`的用户可能会对其`Handler`的流程处理产生不小的疑惑,实际上`bm`对`Handler`对处理非常简单: 初次接触`blademaster`的用户可能会对其`Handler`的流程处理产生不小的疑惑,实际上`bm`对`Handler`对处理非常简单:
@ -86,6 +86,3 @@ func (c *Context) Protobuf(data proto.Message, err error)
[bm中间件](blademaster-mid.md) [bm中间件](blademaster-mid.md)
[bm基于pb生成](blademaster-pb.md) [bm基于pb生成](blademaster-pb.md)
-------------
[文档目录树](summary.md)

@ -81,6 +81,3 @@ kratos tool swagger serve api/api.swagger.json
[bm模块说明](blademaster-mod.md) [bm模块说明](blademaster-mod.md)
[bm中间件](blademaster-mid.md) [bm中间件](blademaster-mid.md)
-------------
[文档目录树](summary.md)

@ -190,6 +190,3 @@ go tool pprof http://127.0.0.1:8000/debug/pprof/profile
[bm中间件](blademaster-mid.md) [bm中间件](blademaster-mid.md)
[bm基于pb生成](blademaster-pb.md) [bm基于pb生成](blademaster-pb.md)
-------------
[文档目录树](summary.md)

@ -21,12 +21,12 @@
# blademaster架构 # blademaster架构
![bm-arch](/doc/img/bm-arch-2-2.png) ![bm-arch](img/bm-arch-2-2.png)
`blademaster`由几个非常精简的内部模块组成。其中`Router`用于根据请求的路径分发请求,`Context`包含了一个完整的请求信息,`Handler`则负责处理传入的`Context`,`Handlers`为一个列表,一个串一个地执行。 `blademaster`由几个非常精简的内部模块组成。其中`Router`用于根据请求的路径分发请求,`Context`包含了一个完整的请求信息,`Handler`则负责处理传入的`Context`,`Handlers`为一个列表,一个串一个地执行。
所有的`middlerware`均以`Handler`的形式存在,这样可以保证`blademaster`自身足够精简且扩展性足够强。 所有的`middlerware`均以`Handler`的形式存在,这样可以保证`blademaster`自身足够精简且扩展性足够强。
![bm-arch](/doc/img/bm-arch-2-3.png) ![bm-arch](img/bm-arch-2-3.png)
`blademaster`处理请求的模式非常简单,大部分的逻辑都被封装在了各种`Handler`中。一般而言,业务逻辑作为最后一个`Handler`。 `blademaster`处理请求的模式非常简单,大部分的逻辑都被封装在了各种`Handler`中。一般而言,业务逻辑作为最后一个`Handler`。
@ -41,6 +41,3 @@
[bm中间件](blademaster-mid.md) [bm中间件](blademaster-mid.md)
[bm基于pb生成](blademaster-pb.md) [bm基于pb生成](blademaster-pb.md)
-------------
[文档目录树](summary.md)

@ -243,6 +243,3 @@ func (d *Dao) DelCacheDemo(c context.Context, id int64) (err error) {
[memcache代码生成器](kratos-genmc.md) [memcache代码生成器](kratos-genmc.md)
[redis模块说明](cache-redis.md) [redis模块说明](cache-redis.md)
-------------
[文档目录树](summary.md)

@ -229,6 +229,3 @@ func (d *Dao) HGETALLDemo(c context.Context, pid int64) (res map[string]int64, e
[memcache模块说明](cache-mc.md) [memcache模块说明](cache-mc.md)
-------------
[文档目录树](summary.md)

@ -18,6 +18,3 @@
[redis模块说明](cache-redis.md) [redis模块说明](cache-redis.md)
-------------
[文档目录树](summary.md)

@ -46,6 +46,3 @@ Redis、MySQL等业务组件,可以使用静态的配置文件来初始化,
[paladin配置sdk](config-paladin.md) [paladin配置sdk](config-paladin.md)
-------------
[文档目录树](summary.md)

@ -49,6 +49,3 @@ func main() {
} }
``` ```
-------------
[文档目录树](summary.md)

@ -90,6 +90,3 @@ checkErr(paladin.Get("db.toml").UnmarshalTOML(&dc))
[tidb模块说明](database-tidb.md) [tidb模块说明](database-tidb.md)
[hbase模块说明](database-hbase.md) [hbase模块说明](database-hbase.md)
-------------
[文档目录树](summary.md)

@ -243,6 +243,3 @@ if err = tx.Rollback().Error; err!=nil{
[tidb模块说明](database-tidb.md) [tidb模块说明](database-tidb.md)
[hbase模块说明](database-hbase.md) [hbase模块说明](database-hbase.md)
-------------
[文档目录树](summary.md)

@ -17,6 +17,3 @@ HBase客户端,支持trace、slowlog和统计功能。
TiDB客户端,支持服务发现和熔断功能。 TiDB客户端,支持服务发现和熔断功能。
[tidb client](database-tidb.md) [tidb client](database-tidb.md)
-------------
[文档目录树](summary.md)

Before

Width:  |  Height:  |  Size: 9.7 KiB

After

Width:  |  Height:  |  Size: 9.7 KiB

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 31 KiB

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 24 KiB

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 34 KiB

Before

Width:  |  Height:  |  Size: 7.3 KiB

After

Width:  |  Height:  |  Size: 7.3 KiB

Before

Width:  |  Height:  |  Size: 7.8 KiB

After

Width:  |  Height:  |  Size: 7.8 KiB

Before

Width:  |  Height:  |  Size: 5.8 KiB

After

Width:  |  Height:  |  Size: 5.8 KiB

Before

Width:  |  Height:  |  Size: 661 KiB

After

Width:  |  Height:  |  Size: 661 KiB

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 19 KiB

Before

Width:  |  Height:  |  Size: 64 KiB

After

Width:  |  Height:  |  Size: 64 KiB

@ -0,0 +1,22 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Document</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="Description">
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/lib/themes/vue.css">
</head>
<body>
<div id="app"></div>
<script>
window.$docsify = {
loadSidebar: true,
name: 'go-kratos/kratos',
repo: 'https://github.com/go-kratos/kratos'
}
</script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
</body>
</html>

@ -64,6 +64,3 @@ go build
[kratos工具](kratos-tool.md) [kratos工具](kratos-tool.md)
-------------
[文档目录树](summary.md)

@ -25,6 +25,3 @@ type _bts interface {
也可以参考完整的testdata例子:kratos/tool/kratos-gen-bts/testdata 也可以参考完整的testdata例子:kratos/tool/kratos-gen-bts/testdata
-------------
[文档目录树](summary.md)

@ -66,6 +66,3 @@ func noneKey() string {
也可以参考完整的testdata例子:kratos/tool/kratos-gen-mc/testdata 也可以参考完整的testdata例子:kratos/tool/kratos-gen-mc/testdata
-------------
[文档目录树](summary.md)

@ -26,6 +26,3 @@ protoc --proto_path=$GOPATH --proto_path=$GOPATH/github.com/go-kratos/kratos/thi
protoc --proto_path=$GOPATH --proto_path=$GOPATH/github.com/go-kratos/kratos/third_party --proto_path=. --ecode_out=:. api.proto protoc --proto_path=$GOPATH --proto_path=$GOPATH/github.com/go-kratos/kratos/third_party --proto_path=. --ecode_out=:. api.proto
``` ```
-------------
[文档目录树](summary.md)

@ -6,6 +6,3 @@ kratos tool swagger serve api/api.swagger.json
同时也可以查看更多的 [go-swagger](https://github.com/go-swagger/go-swagger) 官方参数进行使用。 同时也可以查看更多的 [go-swagger](https://github.com/go-swagger/go-swagger) 官方参数进行使用。
-------------
[文档目录树](summary.md)

@ -92,8 +92,6 @@ swagger(已安装): swagger api文档 Author(goswagger.io) [2019/05/05]
执行工具: kratos tool demo 执行工具: kratos tool demo
安装全部工具: kratos tool install all 安装全部工具: kratos tool install all
全部升级: kratos tool upgrade all 全部升级: kratos tool upgrade all
详细文档: https://github.com/go-kratos/kratos/blob/master/doc/wiki-cn/kratos-tool.md
``` ```
> 小小说明:如未安装工具,第一次运行也可自动安装,不需要特别执行install > 小小说明:如未安装工具,第一次运行也可自动安装,不需要特别执行install
@ -106,6 +104,3 @@ swagger(已安装): swagger api文档 Author(goswagger.io) [2019/05/05]
* [genmc](kratos-genmc.md) 用于自动生成memcached缓存代码; * [genmc](kratos-genmc.md) 用于自动生成memcached缓存代码;
* [genbts](kratos-genbts.md) 用于生成缓存回源代码生成,如果miss则调用回源函数从数据源获取,然后塞入缓存; * [genbts](kratos-genbts.md) 用于生成缓存回源代码生成,如果miss则调用回源函数从数据源获取,然后塞入缓存;
-------------
[文档目录树](summary.md)

@ -32,6 +32,3 @@ func main() {
## 扩展阅读 ## 扩展阅读
* [log-agent](log-agent.md) * [log-agent](log-agent.md)
-------------
[文档目录树](summary.md)

@ -24,6 +24,3 @@ protoc -I$GOPATH/src:$KRATOS_HOME/tool/protobuf/pkg/extensions:$KRATOS_DEMO/api
请注意替换`/Users/felix/work/go/src`目录为你本地开发环境对应GOPATH目录,其中`--gogofast_out`意味着告诉`protoc`工具需要使用`gogo protobuf`的工具生成代码。 请注意替换`/Users/felix/work/go/src`目录为你本地开发环境对应GOPATH目录,其中`--gogofast_out`意味着告诉`protoc`工具需要使用`gogo protobuf`的工具生成代码。
-------------
[文档目录树](summary.md)

@ -67,6 +67,3 @@ go build
[kratos工具](kratos-tool.md) [kratos工具](kratos-tool.md)
-------------
[文档目录树](summary.md)

@ -25,7 +25,7 @@ kratos 借鉴了 Sentinel 项目的自适应限流系统,通过综合分析服
在自适应限流保护中,采集到的指标的时效性非常强,系统只需要采集最近一小段时间内的 qps、rt 即可,对于较老的数据,会自动丢弃。为了实现这个效果,kratos 使用了滑动窗口来保存采样数据。 在自适应限流保护中,采集到的指标的时效性非常强,系统只需要采集最近一小段时间内的 qps、rt 即可,对于较老的数据,会自动丢弃。为了实现这个效果,kratos 使用了滑动窗口来保存采样数据。
![ratelimit-rolling-window](/doc/img/ratelimit-rolling-window.png) ![ratelimit-rolling-window](img/ratelimit-rolling-window.png)
如上图,展示了一个具有两个桶(bucket)的滑动窗口(rolling window)。整个滑动窗口用来保存最近 1s 的采样数据,每个小的桶用来保存 500ms 的采样数据。 如上图,展示了一个具有两个桶(bucket)的滑动窗口(rolling window)。整个滑动窗口用来保存最近 1s 的采样数据,每个小的桶用来保存 500ms 的采样数据。
当时间流动之后,过期的桶会自动被新桶的数据覆盖掉,在图中,在 1000-1500ms 时,bucket 1 的数据因为过期而被丢弃,之后 bucket 3 的数据填到了窗口的头部。 当时间流动之后,过期的桶会自动被新桶的数据覆盖掉,在图中,在 1000-1500ms 时,bucket 1 的数据因为过期而被丢弃,之后 bucket 3 的数据填到了窗口的头部。
@ -45,7 +45,7 @@ windows 表示一秒内采样窗口的数量,默认配置中是 5s 50 个采
场景1,请求以每秒增加1个的速度不停上升,压测效果如下: 场景1,请求以每秒增加1个的速度不停上升,压测效果如下:
![ratelimit-benchmark-up-1](/doc/img/ratelimit-benchmark-up-1.png) ![ratelimit-benchmark-up-1](img/ratelimit-benchmark-up-1.png)
左测是没有限流的压测效果,右侧是带限流的压测效果。 左测是没有限流的压测效果,右侧是带限流的压测效果。
可以看到,没有限流的场景里,系统在 700qps 时开始抖动,在 1k qps 时被拖垮,几乎没有新的请求能被放行,然而在使用限流之后,系统请求能够稳定在 600 qps 左右,rt 没有暴增,服务也没有被打垮,可见,限流有效的保护了服务。 可以看到,没有限流的场景里,系统在 700qps 时开始抖动,在 1k qps 时被拖垮,几乎没有新的请求能被放行,然而在使用限流之后,系统请求能够稳定在 600 qps 左右,rt 没有暴增,服务也没有被打垮,可见,限流有效的保护了服务。
@ -55,6 +55,3 @@ windows 表示一秒内采样窗口的数量,默认配置中是 5s 50 个采
[Sentinel 系统自适应限流](https://github.com/alibaba/Sentinel/wiki/%E7%B3%BB%E7%BB%9F%E8%87%AA%E9%80%82%E5%BA%94%E9%99%90%E6%B5%81) [Sentinel 系统自适应限流](https://github.com/alibaba/Sentinel/wiki/%E7%B3%BB%E7%BB%9F%E8%87%AA%E9%80%82%E5%BA%94%E9%99%90%E6%B5%81)
-------------
[文档目录树](summary.md)

@ -39,4 +39,4 @@ func main(){
### zipkin效果图 ### zipkin效果图
![zipkin](/doc/img/zipkin.jpg) ![zipkin](img/zipkin.jpg)

@ -146,7 +146,7 @@ func TestUsers(t *testing.T) {
``` ```
#### 使用建议 #### 使用建议
强烈建议使用 [testgen](https://github.com/go-kratos/kratos/blob/master/doc/wiki-cn/ut-testgen.md) 进行测试用例的生成,生成后每个方法将包含一个符合以下规范的正向用例。 强烈建议使用 [testgen](ut-testgen.md) 进行测试用例的生成,生成后每个方法将包含一个符合以下规范的正向用例。
用例规范: 用例规范:
1. 每个方法至少包含一个测试方法(命名为Test[PackageName][FunctionName]) 1. 每个方法至少包含一个测试方法(命名为Test[PackageName][FunctionName])
@ -169,6 +169,7 @@ func TestUsers(t *testing.T) {
#### 使用示例 #### 使用示例
1. 上层包对下层包依赖示例 1. 上层包对下层包依赖示例
Service层对Dao层依赖: Service层对Dao层依赖:
```GO ```GO
// 原方法 // 原方法
func (s *Service) realnameAlipayApply(c context.Context, mid int64) (info *model.RealnameAlipayApply, err error) { func (s *Service) realnameAlipayApply(c context.Context, mid int64) (info *model.RealnameAlipayApply, err error) {
@ -178,7 +179,7 @@ func (s *Service) realnameAlipayApply(c context.Context, mid int64) (info *model
... ...
return return
} }
// 测试方法 // 测试方法
func TestServicerealnameAlipayApply(t *testing.T) { func TestServicerealnameAlipayApply(t *testing.T) {
convey.Convey("realnameAlipayApply", t, func(ctx convey.C) { convey.Convey("realnameAlipayApply", t, func(ctx convey.C) {
@ -198,8 +199,8 @@ func TestServicerealnameAlipayApply(t *testing.T) {
} }
``` ```
2. 基础库错误Mock示例 2. 基础库错误Mock示例
```Go ```Go
// 原方法(部分) // 原方法(部分)
func (d *Dao) BaseInfoCache(c context.Context, mid int64) (info *model.BaseInfo, err error) { func (d *Dao) BaseInfoCache(c context.Context, mid int64) (info *model.BaseInfo, err error) {
... ...
@ -213,8 +214,7 @@ func (d *Dao) BaseInfoCache(c context.Context, mid int64) (info *model.BaseInfo,
... ...
return return
} }
// 测试方法(错误Mock部分) // 测试方法(错误Mock部分)
func TestDaoBaseInfoCache(t *testing.T) { func TestDaoBaseInfoCache(t *testing.T) {
convey.Convey("BaseInfoCache", t, func(ctx convey.C) { convey.Convey("BaseInfoCache", t, func(ctx convey.C) {
@ -232,6 +232,7 @@ func TestDaoBaseInfoCache(t *testing.T) {
}) })
} }
``` ```
#### 注意事项 #### 注意事项
- Monkey非线程安全 - Monkey非线程安全
- Monkey无法针对Inline方法打补丁,在测试时可以使用go test -gcflags=-l来关闭inline编译的模式(一些简单的go inline介绍戳这里) - Monkey无法针对Inline方法打补丁,在测试时可以使用go test -gcflags=-l来关闭inline编译的模式(一些简单的go inline介绍戳这里)
@ -269,9 +270,10 @@ func TestDaoBaseInfoCache(t *testing.T) {
使用示例: 使用示例:
1. net/http 标准库 HTTP 请求Mock 1. net/http 标准库 HTTP 请求Mock
```Go ```Go
import gock "gopkg.in/h2non/gock.v1" import gock "gopkg.in/h2non/gock.v1"
// 原方法 // 原方法
func (d *Dao) Upload(c context.Context, fileName, fileType string, expire int64, body io.Reader) (location string, err error) { func (d *Dao) Upload(c context.Context, fileName, fileType string, expire int64, body io.Reader) (location string, err error) {
... ...
@ -288,8 +290,7 @@ import gock "gopkg.in/h2non/gock.v1"
... ...
return return
} }
// 测试方法 // 测试方法
func TestDaoUpload(t *testing.T) { func TestDaoUpload(t *testing.T) {
convey.Convey("Upload", t, func(ctx convey.C) { convey.Convey("Upload", t, func(ctx convey.C) {
@ -348,6 +349,7 @@ func httpMock(method, url string) *gock.Request {
} }
``` ```
2. blademaster库HTTP请求Mock 2. blademaster库HTTP请求Mock
```Go ```Go
// 原方法 // 原方法
func (d *Dao) SendWechatToGroup(c context.Context, chatid, msg string) (err error) { func (d *Dao) SendWechatToGroup(c context.Context, chatid, msg string) (err error) {
@ -360,7 +362,7 @@ func (d *Dao) SendWechatToGroup(c context.Context, chatid, msg string) (err erro
} }
return return
} }
// 测试方法 // 测试方法
func TestDaoSendWechatToGroup(t *testing.T) { func TestDaoSendWechatToGroup(t *testing.T) {
convey.Convey("SendWechatToGroup", t, func(ctx convey.C) { convey.Convey("SendWechatToGroup", t, func(ctx convey.C) {
@ -393,7 +395,7 @@ func TestDaoSendWechatToGroup(t *testing.T) {
}) })
}) })
} }
func httpMock(method, url string) *gock.Request { func httpMock(method, url string) *gock.Request {
r := gock.New(url) r := gock.New(url)
r.Method = strings.ToUpper(method) r.Method = strings.ToUpper(method)
@ -435,6 +437,7 @@ mockgen -destination=$GOPATH/kratos/app/xxx/dao/dao_mock.go -package=dao kratos/
./creater --m mock absolute/path/to/your/pkg ./creater --m mock absolute/path/to/your/pkg
``` ```
- 测试代码内使用方法 - 测试代码内使用方法
```Go ```Go
// 测试用例内直接使用 // 测试用例内直接使用
// 需引入的包 // 需引入的包
@ -464,7 +467,7 @@ func TestPkgFoo(t *testing.T) {
... ...
}) })
} }
// 可以利用Convey执行顺序方式适当调整以简化代码 // 可以利用Convey执行顺序方式适当调整以简化代码
func TestPkgFoo(t *testing.T) { func TestPkgFoo(t *testing.T) {
convey.Convey("Foo", t, func(ctx convey.C) { convey.Convey("Foo", t, func(ctx convey.C) {

@ -43,10 +43,3 @@ $GOPATH/bin/testgen --m mock YOUR_PROJECT/dao #仅传入包路径即可
```shell ```shell
$GOPATH/bin/testgen --m monkey yourCodeDirPath #仅传入包路径即可 $GOPATH/bin/testgen --m monkey yourCodeDirPath #仅传入包路径即可
``` ```
### 赋诗一首
```
莫生气 莫生气
代码辣鸡非我意
自己动手分田地
谈笑风生活长命
```

@ -30,9 +30,3 @@ golang 的单元测试,既可以用官方自带的 testing 包,也有开源
> - 基础组件,如mc、redis、mysql等,由 testcli(testing/lich) 起基础镜像支持(需要提供建表、INSERT语句)与本地开发环境一致,也保证了结果的一致性。 > - 基础组件,如mc、redis、mysql等,由 testcli(testing/lich) 起基础镜像支持(需要提供建表、INSERT语句)与本地开发环境一致,也保证了结果的一致性。
> - rpc server,如 xxxx-service 需要定义 interface 供业务依赖方使用。所有rpc server 都必须要提供一个interface+mock代码(gomock)。 > - rpc server,如 xxxx-service 需要定义 interface 供业务依赖方使用。所有rpc server 都必须要提供一个interface+mock代码(gomock)。
> - http server则直接写mock代码gock。 > - http server则直接写mock代码gock。
# 注意
单元测试极其重要,良好的单元测试习惯能很大程度上避免代码变更引起的bug!
单元测试极其重要,良好的单元测试习惯能很大程度上避免代码变更引起的bug!
单元测试极其重要,良好的单元测试习惯能很大程度上避免代码变更引起的bug!
以为很重要所以重复 3 遍~

@ -37,7 +37,3 @@ func NewClient(conf *ClientConfig, opt ...grpc.DialOption) *Client {
return c return c
} }
``` ```
-------------
[文档目录树](summary.md)

@ -324,7 +324,7 @@ func serverLogging() grpc.UnaryServerInterceptor {
## 自适应限流拦截器 ## 自适应限流拦截器
更多关于自适应限流的信息,请参考:[kratos 自适应限流](/doc/wiki-cn/ratelimit.md) 更多关于自适应限流的信息,请参考:[kratos 自适应限流](ratelimit.md)
```go ```go
package grpc package grpc
@ -369,8 +369,3 @@ func New(svc *service.Service) *warden.Server {
# 扩展阅读 # 扩展阅读
[warden快速开始](warden-quickstart.md) [warden基于pb生成](warden-pb.md) [warden负载均衡](warden-balancer.md) [warden服务发现](warden-resolver.md) [warden快速开始](warden-quickstart.md) [warden基于pb生成](warden-pb.md) [warden负载均衡](warden-balancer.md) [warden服务发现](warden-resolver.md)
-------------
[文档目录树](summary.md)

@ -42,6 +42,3 @@ func (s *Service) SayHelloURL(ctx context.Context, req *pb.HelloReq) (reply *pb.
[warden快速开始](warden-quickstart.md) [warden拦截器](warden-mid.md) [warden负载均衡](warden-balancer.md) [warden服务发现](warden-resolver.md) [warden快速开始](warden-quickstart.md) [warden拦截器](warden-mid.md) [warden负载均衡](warden-balancer.md) [warden服务发现](warden-resolver.md)
-------------
[文档目录树](summary.md)

@ -169,7 +169,3 @@ func (d *Dao) SayHello(c context.Context, req *demoapi.HelloReq) (resp *grpcempt
[warden基于pb生成](warden-pb.md) [warden基于pb生成](warden-pb.md)
[warden服务发现](warden-resolver.md) [warden服务发现](warden-resolver.md)
[warden负载均衡](warden-balancer.md) [warden负载均衡](warden-balancer.md)
-------------
[文档目录树](summary.md)

@ -249,7 +249,3 @@ etcd默认的全局keyPrefix为kratos_etcd,当该keyPrefix与项目中其他keyP
# 扩展阅读 # 扩展阅读
[warden快速开始](warden-quickstart.md) [warden拦截器](warden-mid.md) [warden基于pb生成](warden-pb.md) [warden负载均衡](warden-balancer.md) [warden快速开始](warden-quickstart.md) [warden拦截器](warden-mid.md) [warden基于pb生成](warden-pb.md) [warden负载均衡](warden-balancer.md)
-------------
[文档目录树](summary.md)

@ -35,6 +35,3 @@ gRPC暴露了两个拦截器接口,分别是:
[warden快速开始](warden-quickstart.md) [warden拦截器](warden-mid.md) [warden负载均衡](warden-balancer.md) [warden基于pb生成](warden-pb.md) [warden服务发现](warden-resolver.md) [warden快速开始](warden-quickstart.md) [warden拦截器](warden-mid.md) [warden负载均衡](warden-balancer.md) [warden基于pb生成](warden-pb.md) [warden服务发现](warden-resolver.md)
-------------
[文档目录树](summary.md)
Loading…
Cancel
Save