kitex学习笔记(1)
1、安装依赖
安装 kitex和thriftgo
go install github.com/cloudwego/kitex/tool/cmd/kitex@latest go install github.com/cloudwego/thriftgo@latest
2、相关概念
(1)Kitex 框架及命令行工具,默认支持 thrift
和 proto3
两种 IDL(全称是 Interface Definition Language,接口定义语言),对应的 Kitex 支持 thrift
和 protobuf
两种序列化协议。
注:Kitex 在 v0.4.0 版本已支持在 Windows 环境下编译运行了。但代码生成工具暂未支持 Windows 环境。
(2)语法
-
- Thrift IDL 语法可参考:Thrift interface description language
- proto3 语法可参考:Language Guide(proto3)
3、运行一个简单的示例
(1)创建一个名为 echo.thrift
的 thrift IDL 文件,内容如下:
namespace go api struct Request { 1: string message } struct Response { 1: string message } service Echo { Response echo(1: Request req) }
(2)通过 kitex 工具生成项目代码了,执行如下命令:
kitex -module example -service example echo.thrifts
参数说明:
-module
表示生成的该项目的 go module 名,如果项目不是mod管理的,则不必写该参数;-service
表明我们要生成一个服务端项目,后面紧跟的 example
为该服务的名字;- 最后一个参数则为该服务的 IDL 文件。
(3)运行go mod tidy整理依赖,如果报错,运行如下命令:
go mod edit -droprequire=github.com/apache/thrift/lib/go/thrift go mod edit -replace=github.com/apache/thrift=github.com/apache/thrift@v0.13.0
(4)在handler.go中编辑服务端逻辑,最终handler.go文件代码如下:
package main import ( "log" "kitexDemo/kitex_gen/api/echo" ) func main() { svr := echo.NewServer(new(EchoImpl)) err := svr.Run() if err != nil { log.Println(err.Error()) } }
(5)客户端代码如下:
package main import ( "context" "log" "github.com/cloudwego/kitex/client" "kitexDemo/kitex_gen/api" "kitexDemo/kitex_gen/api/echo" ) func main() { //创建client 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) if err != nil { log.Fatal(err) } log.Println(resp) }