Skip to content

Latest commit

 

History

History
60 lines (50 loc) · 2.54 KB

quickstart.md

File metadata and controls

60 lines (50 loc) · 2.54 KB

快速开始

快速使用kratos项目,可以使用kratos tool,如下:

go get -u github.com/bilibili/kratos/tool/kratos
kratos init

根据提示可以快速创建项目,如kratos-demo就是通过工具创建生成。目录结构如下:

├── CHANGELOG.md           # CHANGELOG
├── CONTRIBUTORS.md        # CONTRIBUTORS
├── README.md              # README
├── api                    # api目录为对外保留的proto文件,及生成的pb.go文件
│   ├── api.proto
│   ├── api.pb.go          # 通过go generate生成的pb.go文件
│   └── generate.go
├── cmd                    # cmd目录为main所在
│   └── main.go            # main.go
├── configs                # configs为配置文件目录
│   ├── application.toml   # 应用的自定义配置文件,可能是一些业务开关如:useABtest = true
│   ├── grpc.toml          # grpc相关配置 
│   ├── http.toml          # http相关配置
│   ├── log.toml           # log相关配置
│   ├── memcache.toml      # memcache相关配置
│   ├── mysql.toml         # mysql相关配置
│   └── redis.toml         # redis相关配置
├── go.mod                 # go.mod
└── internal               # internal为项目内部包,包括以下目录:
    ├── dao                # dao层,用于数据库、cache、MQ、依赖某业务grpc|http等资源访问
    │   └── dao.go
    ├── model              # model层,用于声明业务结构体
    │   └── model.go
    ├── server             # server层,用于初始化grpc和http server
    │   └── http           # http层,用于初始化http server和声明handler
    │       └── http.go
    │   └── grpc           # grpc层,用于初始化grpc server和定义method
    │       └── grpc.go
    └── service            # service层,用于业务逻辑处理,且为方便http和grpc共用方法,建议入参和出参保持grpc风格,且使用pb文件生成代码
        └── service.go

生成后可直接运行如下:

cd kratos-demo/cmd
go build
./cmd -conf ../configs

打开浏览器访问:http://localhost:8000/kratos-demo/start,你会看到输出了Golang 大法好 !!!

动图说明

kratos init


文档目录树