准备工作

安装kitex
go install github.com/cloudwego/kitex/tool/cmd/kitex@latest

安装thriftgo
go install github.com/cloudwego/thriftgo@latest

安装成功后使用以下命令验证是否安装成功
kitex --version
thriftgo --version

创建IDL文件

Kitex最典型的情况是使用thrift定义的IDL来编写服务接口实现客户端和服务端的通信

hello.thrift文件内容如下

namespace go api

struct Request {
        1: string message
}

struct Response {
        1: string message
}

service Hello {
    Response echo(1: Request req)
}

namespace go api：这里指我们定义了一个命名空间apiapi代表生成的代码中有一个目录api

struct Request{}表示我们编写一个请求消息体。struct中变量的格式为不重复的编号:类型:命名

struct Response{}表示我们编写了一个返回消息体

service Hello{}表示定义了一个Hello服务

Response echo(1:Request req)表示服务Hello中有一个叫做echo的方法方法的返回消息为Response请求消息为Request请求消息的格式为编号: 请求消息:命名

生成代码

使用以下命令生成代码
kitex -module "mod_name" -service a.b.c hello.thrift

-module mod_name

指定生成的代码所属的go模块会影响生成代码里的import path
GOPATH/src 下的一个目录那么可以不指定该参数kitex 会使用GOPATH/src 开始的相对路径作为 import path 前缀。
如果当前目录不在 $GOPATH/src 下那么必须指定该参数。
如果指定了 -module 参数那么 kitex 会从当前目录开始往上层搜索 go.mod 文件

-service service_name

kitex 会生成构建一个服务的脚手架代码参数 service_name 给出启动时服务自身的名字通常其值取决于使用 Kitex 框架时搭配的服务注册和服务发现功能。

运行命令后生成的代码目录

然后执行命令
go mod tidy下载依赖

客户端的调用

Go

import "example/kitex_gen/api/echo"
import "github.com/cloudwego/kitex/client"
import "example/kitex_gen/api"

...
c, err := echo.NewClient("example", client.WithHostPorts("0.0.0.0:8888"))
if err != nil {
  log.Fatal(err)
}
req := &api.Request{Message: "my request"}
resp, err := c.Echo(context.Background(), req, callopt.WithRPCTimeout(3*time.Second))
if err != nil {
  log.Fatal(err)
}
log.Println(resp)

其中echo.NewClient(“example”, client.WithHostPorts(“0.0.0.0:8888”))是创建一个客户端连接第一个参数是服务名要与生成代码中的service_name保持一致第二个参数是指定server的地址和端口号server默认占用8888端口