mirror of
https://github.com/go-kratos/kratos.git
synced 2026-05-22 10:15:24 +02:00
fix doc
This commit is contained in:
Windfarer
@@ -1,56 +1,6 @@
|
||||
# 准备工作
|
||||
|
||||
推荐使用[kratos工具](kratos-tool.md)快速生成项目，如我们生成一个叫`kratos-demo`的项目。目录结构如下：
|
||||
|
||||
```
|
||||
├── CHANGELOG.md
|
||||
├── OWNERS
|
||||
├── README.md
|
||||
├── api
|
||||
│ ├── api.bm.go
|
||||
│ ├── api.pb.go
|
||||
│ ├── api.proto
|
||||
│ └── client.go
|
||||
├── cmd
|
||||
│ ├── cmd
|
||||
│ └── main.go
|
||||
├── configs
|
||||
│ ├── application.toml
|
||||
│ ├── db.toml
|
||||
│ ├── grpc.toml
|
||||
│ ├── http.toml
|
||||
│ ├── memcache.toml
|
||||
│ └── redis.toml
|
||||
├── go.mod
|
||||
├── go.sum
|
||||
├── internal
|
||||
│ ├── dao
|
||||
│ │ ├── dao.bts.go
|
||||
│ │ ├── dao.go
|
||||
│ │ ├── db.go
|
||||
│ │ ├── mc.cache.go
|
||||
│ │ ├── mc.go
|
||||
│ │ └── redis.go
|
||||
│ ├── di
|
||||
│ │ ├── app.go
|
||||
│ │ ├── wire.go
|
||||
│ │ └── wire_gen.go
|
||||
│ ├── model
|
||||
│ │ └── model.go
|
||||
│ ├── server
|
||||
│ │ ├── grpc
|
||||
│ │ │ └── server.go
|
||||
│ │ └── http
|
||||
│ │ └── server.go
|
||||
│ └── service
|
||||
│ └── service.go
|
||||
└── test
|
||||
└── docker-compose.yaml
|
||||
```
|
||||
|
||||
# 路由
|
||||
|
||||
创建项目成功后，进入`internal/server/http`目录下，打开`http.go`文件，其中有默认生成的`blademaster`模板。其中：
|
||||
进入`internal/server/http`目录下，打开`http.go`文件，其中有默认生成的`blademaster`模板。其中：
|
||||
|
||||
```go
|
||||
engine = bm.DefaultServer(hc.Server)
|
||||
|
||||
+1
-51
@@ -1,58 +1,8 @@
|
||||
# 准备工作
|
||||
|
||||
推荐使用[kratos工具](kratos-tool.md)快速生成项目，如我们生成一个叫`kratos-demo`的项目。目录结构如下：
|
||||
|
||||
```
|
||||
├── CHANGELOG.md
|
||||
├── OWNERS
|
||||
├── README.md
|
||||
├── api
|
||||
│ ├── api.bm.go
|
||||
│ ├── api.pb.go
|
||||
│ ├── api.proto
|
||||
│ └── client.go
|
||||
├── cmd
|
||||
│ ├── cmd
|
||||
│ └── main.go
|
||||
├── configs
|
||||
│ ├── application.toml
|
||||
│ ├── db.toml
|
||||
│ ├── grpc.toml
|
||||
│ ├── http.toml
|
||||
│ ├── memcache.toml
|
||||
│ └── redis.toml
|
||||
├── go.mod
|
||||
├── go.sum
|
||||
├── internal
|
||||
│ ├── dao
|
||||
│ │ ├── dao.bts.go
|
||||
│ │ ├── dao.go
|
||||
│ │ ├── db.go
|
||||
│ │ ├── mc.cache.go
|
||||
│ │ ├── mc.go
|
||||
│ │ └── redis.go
|
||||
│ ├── di
|
||||
│ │ ├── app.go
|
||||
│ │ ├── wire.go
|
||||
│ │ └── wire_gen.go
|
||||
│ ├── model
|
||||
│ │ └── model.go
|
||||
│ ├── server
|
||||
│ │ ├── grpc
|
||||
│ │ │ └── server.go
|
||||
│ │ └── http
|
||||
│ │ └── server.go
|
||||
│ └── service
|
||||
│ └── service.go
|
||||
└── test
|
||||
└── docker-compose.yaml
|
||||
```
|
||||
|
||||
# 开始使用
|
||||
|
||||
## 配置
|
||||
|
||||
创建项目成功后，进入项目中的configs目录，打开memcache.toml，我们可以看到：
|
||||
进入项目中的configs目录，打开memcache.toml，我们可以看到：
|
||||
|
||||
```toml
|
||||
[Client]
|
||||
|
||||
+1
-51
@@ -1,58 +1,8 @@
|
||||
# 准备工作
|
||||
|
||||
推荐使用[kratos工具](kratos-tool.md)快速生成项目，如我们生成一个叫`kratos-demo`的项目。目录结构如下：
|
||||
|
||||
```
|
||||
├── CHANGELOG.md
|
||||
├── OWNERS
|
||||
├── README.md
|
||||
├── api
|
||||
│ ├── api.bm.go
|
||||
│ ├── api.pb.go
|
||||
│ ├── api.proto
|
||||
│ └── client.go
|
||||
├── cmd
|
||||
│ ├── cmd
|
||||
│ └── main.go
|
||||
├── configs
|
||||
│ ├── application.toml
|
||||
│ ├── db.toml
|
||||
│ ├── grpc.toml
|
||||
│ ├── http.toml
|
||||
│ ├── memcache.toml
|
||||
│ └── redis.toml
|
||||
├── go.mod
|
||||
├── go.sum
|
||||
├── internal
|
||||
│ ├── dao
|
||||
│ │ ├── dao.bts.go
|
||||
│ │ ├── dao.go
|
||||
│ │ ├── db.go
|
||||
│ │ ├── mc.cache.go
|
||||
│ │ ├── mc.go
|
||||
│ │ └── redis.go
|
||||
│ ├── di
|
||||
│ │ ├── app.go
|
||||
│ │ ├── wire.go
|
||||
│ │ └── wire_gen.go
|
||||
│ ├── model
|
||||
│ │ └── model.go
|
||||
│ ├── server
|
||||
│ │ ├── grpc
|
||||
│ │ │ └── server.go
|
||||
│ │ └── http
|
||||
│ │ └── server.go
|
||||
│ └── service
|
||||
│ └── service.go
|
||||
└── test
|
||||
└── docker-compose.yaml
|
||||
```
|
||||
|
||||
# 开始使用
|
||||
|
||||
## 配置
|
||||
|
||||
创建项目成功后，进入项目中的configs目录，打开redis.toml，我们可以看到：
|
||||
进入项目中的configs目录，打开redis.toml，我们可以看到：
|
||||
|
||||
```toml
|
||||
[Client]
|
||||
|
||||
@@ -1,58 +1,8 @@
|
||||
# 准备工作
|
||||
|
||||
推荐使用[kratos工具](kratos-tool.md)快速生成项目，如我们生成一个叫`kratos-demo`的项目。目录结构如下：
|
||||
|
||||
```
|
||||
├── CHANGELOG.md
|
||||
├── OWNERS
|
||||
├── README.md
|
||||
├── api
|
||||
│ ├── api.bm.go
|
||||
│ ├── api.pb.go
|
||||
│ ├── api.proto
|
||||
│ └── client.go
|
||||
├── cmd
|
||||
│ ├── cmd
|
||||
│ └── main.go
|
||||
├── configs
|
||||
│ ├── application.toml
|
||||
│ ├── db.toml
|
||||
│ ├── grpc.toml
|
||||
│ ├── http.toml
|
||||
│ ├── memcache.toml
|
||||
│ └── redis.toml
|
||||
├── go.mod
|
||||
├── go.sum
|
||||
├── internal
|
||||
│ ├── dao
|
||||
│ │ ├── dao.bts.go
|
||||
│ │ ├── dao.go
|
||||
│ │ ├── db.go
|
||||
│ │ ├── mc.cache.go
|
||||
│ │ ├── mc.go
|
||||
│ │ └── redis.go
|
||||
│ ├── di
|
||||
│ │ ├── app.go
|
||||
│ │ ├── wire.go
|
||||
│ │ └── wire_gen.go
|
||||
│ ├── model
|
||||
│ │ └── model.go
|
||||
│ ├── server
|
||||
│ │ ├── grpc
|
||||
│ │ │ └── server.go
|
||||
│ │ └── http
|
||||
│ │ └── server.go
|
||||
│ └── service
|
||||
│ └── service.go
|
||||
└── test
|
||||
└── docker-compose.yaml
|
||||
```
|
||||
|
||||
# 开始使用
|
||||
|
||||
## 配置
|
||||
|
||||
创建项目成功后，进入项目中的configs目录，mysql.toml，我们可以看到：
|
||||
进入项目中的configs目录，mysql.toml，我们可以看到：
|
||||
|
||||
```toml
|
||||
[demo]
|
||||
|
||||
+1
-51
@@ -1,58 +1,8 @@
|
||||
# 准备工作
|
||||
|
||||
推荐使用[kratos工具](kratos-tool.md)快速生成项目，如我们生成一个叫`kratos-demo`的项目。目录结构如下：
|
||||
|
||||
```
|
||||
├── CHANGELOG.md
|
||||
├── OWNERS
|
||||
├── README.md
|
||||
├── api
|
||||
│ ├── api.bm.go
|
||||
│ ├── api.pb.go
|
||||
│ ├── api.proto
|
||||
│ └── client.go
|
||||
├── cmd
|
||||
│ ├── cmd
|
||||
│ └── main.go
|
||||
├── configs
|
||||
│ ├── application.toml
|
||||
│ ├── db.toml
|
||||
│ ├── grpc.toml
|
||||
│ ├── http.toml
|
||||
│ ├── memcache.toml
|
||||
│ └── redis.toml
|
||||
├── go.mod
|
||||
├── go.sum
|
||||
├── internal
|
||||
│ ├── dao
|
||||
│ │ ├── dao.bts.go
|
||||
│ │ ├── dao.go
|
||||
│ │ ├── db.go
|
||||
│ │ ├── mc.cache.go
|
||||
│ │ ├── mc.go
|
||||
│ │ └── redis.go
|
||||
│ ├── di
|
||||
│ │ ├── app.go
|
||||
│ │ ├── wire.go
|
||||
│ │ └── wire_gen.go
|
||||
│ ├── model
|
||||
│ │ └── model.go
|
||||
│ ├── server
|
||||
│ │ ├── grpc
|
||||
│ │ │ └── server.go
|
||||
│ │ └── http
|
||||
│ │ └── server.go
|
||||
│ └── service
|
||||
│ └── service.go
|
||||
└── test
|
||||
└── docker-compose.yaml
|
||||
```
|
||||
|
||||
# 开始使用
|
||||
|
||||
## 配置
|
||||
|
||||
创建项目成功后，进入项目中的configs目录，mysql.toml，我们可以看到：
|
||||
进入项目中的configs目录，mysql.toml，我们可以看到：
|
||||
|
||||
```toml
|
||||
[demo]
|
||||
|
||||
@@ -13,6 +13,8 @@
|
||||
<script>
|
||||
window.$docsify = {
|
||||
loadSidebar: true,
|
||||
auto2top: true,
|
||||
autoHeader: true,
|
||||
name: 'go-kratos/kratos',
|
||||
repo: 'https://github.com/go-kratos/kratos'
|
||||
}
|
||||
|
||||
@@ -148,7 +148,4 @@ func TestMain(m *testing.M) {
|
||||
```
|
||||
## 注意
|
||||
因为启动mysql容器较为缓慢，健康检测的机制会重试3次，每次暂留5秒钟，基本在10s内mysql就能从creating到服务正常启动！
|
||||
|
||||
当然你也可以在使用 testcli 时加上 --nodown，使其不用每次跑都新建容器，只在第一次跑的时候会初始化容器，后面都进行复用，这样速度会快很多。
|
||||
|
||||
成功启动后就欢乐奔放的玩耍吧～ Good Lucky!
|
||||
+4
-1
@@ -368,4 +368,7 @@ 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)
|
||||
|
||||
+5
-1
@@ -40,5 +40,9 @@ 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)
|
||||
|
||||
|
||||
|
||||
@@ -248,4 +248,7 @@ 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)
|
||||
|
||||
+5
-1
@@ -33,5 +33,9 @@ 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)
|
||||
|
||||
|
||||
Reference in New Issue
Block a user