CLI工具

    1. go get 安装

    2. go install 安装

    2. # go 1.16版本以上需要指定版本号或使用最新版
    3. go install github.com/go-kratos/kratos/cmd/kratos/v2@latest

    3. 源码编译安装

    1. git clone https://github.com/go-kratos/kratos
    2. cd kratos
    3. make install

    创建项目

    通过 kratos 命令创建项目模板：

    1. kratos new helloworld

    使用 -r 指定源

    1. # 国内拉取失败可使用gitee源
    2. kratos new helloworld -r https://gitee.com/go-kratos/kratos-layout.git
    3. # 亦可使用自定义的模板
    4. kratos new helloworld -r xxx-layout.git
    5. # 同时也可以通过环境变量指定源
    6. KRATOS_LAYOUT_REPO=xxx-layout.git
    7. kratos new helloworld

    使用 -b 指定分支

    1. kratos new helloworld -b main

    添加 Proto 文件

    api/helloworld/demo.proto

    1. syntax = "proto3";
    3. package api.helloworld;
    5. option go_package = "helloworld/api/helloworld;helloworld";
    6. option java_multiple_files = true;
    7. option java_package = "api.helloworld";
    9. service Demo {
    10.     rpc UpdateDemo (UpdateDemoRequest) returns (UpdateDemoReply);
    11.     rpc DeleteDemo (DeleteDemoRequest) returns (DeleteDemoReply);
    12.     rpc GetDemo (GetDemoRequest) returns (GetDemoReply);
    13.     rpc ListDemo (ListDemoRequest) returns (ListDemoReply);
    14. }
    16. message CreateDemoRequest {}
    19. message UpdateDemoRequest {}
    20. message UpdateDemoReply {}
    22. message DeleteDemoRequest {}
    23. message DeleteDemoReply {}
    25. message GetDemoRequest {}
    26. message GetDemoReply {}
    28. message ListDemoRequest {}
    29. message ListDemoReply {}
    1. # 可以直接通过 make 命令生成
    2. make api
    4. # 或使用 kratos cli 进行生成
    5. kratos proto client api/helloworld/demo.proto

    会在proto文件同目录下生成:

    1. api/helloworld/demo.pb.go
    2. api/helloworld/demo_grpc.pb.go
    3. # 注意 http 代码只会在 proto 文件中声明了 http 时才会生成
    4. api/helloworld/demo_http.pb.go

    生成 Service 代码

    通过 proto文件，可以直接生成对应的 Service 实现代码：

    使用 -t 指定生成目录

    1. kratos proto server api/helloworld/demo.proto -t internal/service
    1. package service
    3. import (
    4.     "context"
    6.     pb "helloworld/api/helloworld"
    7. )
    8. type DemoService struct {
    9.     pb.UnimplementedDemoServer
    12. func NewDemoService() *DemoService {
    13.     return &DemoService{}
    14. }
    16. func (s *DemoService) CreateDemo(ctx context.Context, req *pb.CreateDemoRequest) (*pb.CreateDemoReply, error) {
    17.     return &pb.CreateDemoReply{}, nil
    18. }
    19. func (s *DemoService) UpdateDemo(ctx context.Context, req *pb.UpdateDemoRequest) (*pb.UpdateDemoReply, error) {
    20.     return &pb.UpdateDemoReply{}, nil
    21. }
    22. func (s *DemoService) DeleteDemo(ctx context.Context, req *pb.DeleteDemoRequest) (*pb.DeleteDemoReply, error) {
    23.     return &pb.DeleteDemoReply{}, nil
    24. }
    25. func (s *DemoService) GetDemo(ctx context.Context, req *pb.GetDemoRequest) (*pb.GetDemoReply, error) {
    26.     return &pb.GetDemoReply{}, nil
    27. }
    28. func (s *DemoService) ListDemo(ctx context.Context, req *pb.ListDemoRequest) (*pb.ListDemoReply, error) {
    29.     return &pb.ListDemoReply{}, nil
    30. }

    运行项目

    • 如子目录下有多个项目则出现选择菜单

    查看工具版本：

    1. kratos -v

    输出:

    1. kratos version v2.2.0

    工具升级

    将升级以下工具

    • Kratos与工具自身
    • protoc相关的生成插件
    1. kratos upgrade

    更新日志

    1. # 等同于打印 https://github.com/go-kratos/kratos/releases/latest 的版本更新日志
    2. kratos changelog
    4. # 打印指定版本更新日志
    5. kratos changelog v2.1.4
    7. # 查看自上次版本发布后的更新日志
    8. kratos changelog dev

    任何命令下加 -h 查看帮助