4.5 KiB

Raw Blame History

介绍

kratos包含了一批好用的工具集，比如项目一键生成、基于proto生成http&grpc代码，生成缓存回源代码，生成memcache执行代码，生成swagger文档等。

获取工具

执行以下命令，即可快速安装好kratos工具

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

那么接下来让我们快速开始熟悉工具的用法~

kratos本体

kratos是所有工具集的本体，就像go一样，拥有执行各种子工具的能力，如go build和go tool。先让我们看看-h的输出：

NAME:
   kratos - kratos tool

USAGE:
   kratos [global options] command [command options] [arguments...]

VERSION:
   0.0.1

COMMANDS:
     new, n        create new project
     build, b      kratos build
     run, r        kratos run
     tool, t       kratos tool
     version, v    kratos version
     self-upgrade  kratos self-upgrade
     help, h       Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help
   --version, -v  print the version

可以看到kratos有如：new build run tool等在内的COMMANDS，那么接下来一一演示如何使用。

kratos new

kratos new是快速创建一个项目的命令，执行如下：

kratos new kratos-demo

即可快速在当前目录生成一个叫kratos-demo的项目。此外还支持指定owner和path，如下：

kratos new kratos-demo -o YourName -d YourPath

注意，kratos new默认是不会生成通过protobuf定义的grpc和bm示例代码的，如需生成请加--proto，如下：

kratos new kratos-demo -o YourName -d YourPath --proto

特别注意，如果不是macos系统，生成的示例项目api目录下的proto文件并不会自动生成对应的.pb.go和.bm.go文件，需要参考以下说明进行生成。

protoc说明

kratos build&run

kratos build和kratos run是go build和go run的封装，并无特别用途。

kratos tool

kratos tool是基于proto生成http&grpc代码，生成缓存回源代码，生成memcache执行代码，生成swagger文档等工具集，先看下kratos tool的执行效果：

swagger(已安装): swagger api文档 Author(goswagger.io) [2019/05/05]
protoc(已安装): 快速方便生成pb.go和bm.go的protoc封装，windows、Linux请先安装protoc工具 Author(kratos) [2019/05/04]
kratos(已安装): Kratos工具集本体 Author(kratos) [2019/04/02]

安装工具: kratos tool install demo
执行工具: kratos tool demo
安装全部工具: kratos tool install all

详细文档： https://github.com/bilibili/kratos/blob/master/doc/wiki-cn/kratos-tool.md

小小说明：如未安装工具，第一次运行也可自动安装，不需要特别执行install

目前已经集成的工具有：

protoc用于快速生成*.pb.go和*.bm.go文件，但目前不支持windows，Linux也需要先自己安装protoc工具。
swagger用于显示自动生成的BM API接口文档，通过 kratos tool swagger serve api/api.swagger.json 可以访问到文档。
TODOs...

kratos tool protoc

该命令运行没其他参数，直接kratos tool protoc运行即可。但使用前需特别说明：

该工具在Windows/Linux下运行，需提前安装好protoc工具

该工具实际是一段shell脚本，其中自动将protoc命令进行了拼接，识别了需要*.proto的目录和当前目录下的proto文件，最终会拼接为如下命令进行执行：

export $KRATOS_HOME = kratos路径
export $KRATOS_DEMO = 项目路径

// 生成：api.pb.go
protoc -I$GOPATH/src:$KRATOS_HOME/tool/protobuf/pkg/extensions:$KRATOS_DEMO/api --gogofast_out=plugins=grpc:$KRATOS_DEMO/api $KRATOS_DEMO/api/api.proto
// 生成：api.bm.go
protoc -I$GOPATH/src:$KRATOS_HOME/tool/protobuf/pkg/extensions:$KRATOS_DEMO/api --bm_out=$KRATOS_DEMO/api $KRATOS_DEMO/api/api.proto
// 生成：api.swagger.json
protoc -I$GOPATH/src:$KRATOS_HOME/tool/protobuf/pkg/extensions:$KRATOS_DEMO/api --bswagger_out=$KRATOS_DEMO/api $KRATOS_DEMO/api/api.proto

大家也可以参考该命令进行proto生成*.pb.go和*.bm.go文件，也可以参考protoc说明。

Tool examples

// new a project
cd $GOPATH/src
kratos new kratos-demo -o Tinker --proto

// build & run
cd kratos-demo
kratos run

// swagger docs
kratos tool swagger serve kratos-demo/api/api.swagger.json

// generate proto
cd kratos-demo/api
kratos tool protoc api.proto

文档目录树

4.5 KiB Raw Blame History

介绍