1.首先如果需要了解go-kratos的详细文档,可以先去看看官方的文档。
(1)https://github.com/go-kratos/kratos
(2)https://go-kratos.gitee.io/kratos/#/
2.接下来会跟着官方的项目创建步骤进行
(PS:此处的开发环境是ubuntu20.04,windows系统同理)
(1)安装kratos工具
go get -u github.com/go-kratos/kratos/tool/kratos
(2)安装protoc
sudo apt install -y protobuf-compiler
这步不能少,不然执行demo中的kratos tool protoc --grpc api.proto命令时会提示错误。
(3)使用kratos工具创建项目
cd $GOPATH/src
kratos new kratos-demo
这个地方在创建项目的时候,kratos工具已经自动帮我们安装好了protoc。(于此同时,也会把其他的工具也顺道安装一遍)具体有哪些页面,可以看看文档 https://go-kratos.gitee.io/kratos/#/kratos-tool
(4)项目结构
├── CHANGELOG.md
├── OWNERS
├── README.md
├── api # api目录为对外保留的proto文件及生成的pb.go文件
│ ├── api.bm.go
│ ├── api.pb.go # 通过go generate生成的pb.go文件
│ ├── api.proto
│ └── client.go
├── cmd
│ └── main.go # cmd目录为main所在
├── configs # configs为配置文件目录
│ ├── application.toml # 应用的自定义配置文件,可能是一些业务开关如:useABtest = true
│ ├── db.toml # db相关配置
│ ├── grpc.toml # grpc相关配置
│ ├── http.toml # http相关配置
│ ├── memcache.toml # memcache相关配置
│ └── redis.toml # redis相关配置
├── go.mod
├── go.sum
└── internal # internal为项目内部包,包括以下目录:
│ ├── dao # dao层,用于数据库、cache、MQ、依赖某业务grpc|http等资源访问
│ │ ├── dao.bts.go
│ │ ├── dao.go
│ │ ├── db.go
│ │ ├── mc.cache.go
│ │ ├── mc.go
│ │ └── redis.go
│ ├── di # 依赖注入层 采用wire静态分析依赖
│ │ ├── app.go
│ │ ├── wire.go # wire 声明
│ │ └── wire_gen.go # go generate 生成的代码
│ ├── model # model层,用于声明业务结构体
│ │ └── model.go
│ ├── server # server层,用于初始化grpc和http server
│ │ ├── grpc # grpc层,用于初始化grpc server和定义method
│ │ │ └── server.go
│ │ └── http # http层,用于初始化http server和声明handler
│ │ └── server.go
│ └── service # service层,用于业务逻辑处理,且为方便http和grpc共用方法,建议入参和出参保持grpc风格,且使用pb文件生成代码
│ └── service.go
└── test # 测试资源层 用于存放测试相关资源数据 如docker-compose配置 数据库初始化语句等
└── docker-compose.yaml
乍一看一脸蒙比,虽然官方的demo,进到cmd目录,执行
go run main -config ../configs/
demo就可以跑起来了。