3.6 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默认是不会生成grpc示例代码的，如需生成请加--grpc，如下：

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

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

protoc说明

kratos build&run

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

kratos tool

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

kratos(已安装): Kratos工具集本体 Author(kratos) [2019/04/02]
kprotoc(已安装): 快速方便生成pb.go的protoc封装，不支持Windows，Linux请先安装protoc工具 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

目前已经集成的工具有：

kprotoc用于快速生成pb.go文件，但目前不支持windows，Linux也需要先自己安装protoc工具。
TODOs...

kratos tool kprotoc

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

该工具不支持Windows用户，请安装protoc和gogo protobuf工具
该工具在Linux下运行，需提前安装好protoc工具

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

protoc -I/Users/felix/work/go/src:/usr/local/include --gogofast_out=plugins=grpc:/Users/felix/work/go/src /Users/felix/work/go/src/kratos-demo/api/api.proto

Windows和Linux用户可以参考该命令进行proto生成pb.go文件，也可以参考protoc说明。

TODOs

文档目录树

3.6 KiB Raw Blame History

介绍