Kitex 基础教程
关于 Kitex
Kitex 是一个 RPC 框架，既然是 RPC，底层就需要两大功能：
- Serialization 序列化
- Transport 传输
Kitex 框架及命令行工具，默认支持 thrift 和 proto3 两种 IDL，对应的 Kitex 支持 thrift 和 protobuf 两种序列化协议。传输上 Kitex 使用扩展的 thrift 作为底层的传输协议（注：thrift 既是 IDL 格式，同时也是序列化协议和传输协议）。IDL 全称是 Interface Definition Language，接口定义语言。
为什么要使用 IDL
如果我们要进行 RPC，就需要知道对方的接口是什么，需要传什么参数，同时也需要知道返回值是什么样的，就好比两个人之间交流，需要保证在说的是同一个语言、同一件事。这时候，就需要通过 IDL 来约定双方的协议，就像在写代码的时候需要调用某个函数，我们需要知道函数签名一样。
Thrift IDL 语法可参考：Thrift interface description language
proto3 语法可参考：Language Guide(proto3)
创建项目目录
在开始后续的步骤之前，先让我们创建一个项目目录用于后续的教程。
$ mkdir example
然后让我们进入项目目录
$ cd example
Kitex 命令行工具
Kitex 自带了一个同名的命令行工具 kitex，用来帮助大家很方便地生成代码，新项目的生成以及之后我们会学到的 server、client 代码的生成都是通过 kitex 工具进行。
安装
可以使用以下命令来安装或者更新 kitex：
$ go install github.com/cloudwego/kitex/tool/cmd/kitex
完成后，可以通过执行 kitex 来检测是否安装成功。
$ kitex
如果出现如下输出，则安装成功。
$ kitex
No IDL file found.
如果出现 command not found 错误，可能是因为没有把 $GOPATH/bin 加入到 $PATH 中。
编写 IDL
首先我们需要编写一个 IDL，这里以 thrift IDL 为例。
首先创建一个名为 echo.thrift 的 thrift IDL 文件。
然后在里面定义我们的服务
namespace go api
struct Request {
1: string message
}
struct Response {
1: string message
}
service Echo {
Response echo(1: Request req)
}生成 echo 服务代码
有了 IDL 以后我们便可以通过 kitex 工具生成项目代码了，执行如下命令：
$ kitex -module example -service example echo.thrift
上述命令中，-module 表示生成的该项目的 go module 名，-service 表明我们要生成一个服务端项目，后面紧跟的 example 为该服务的名字。最后一个参数则为该服务的 IDL 文件。
生成后的项目结构如下：
.
|-- build.sh
|-- echo.thrift
|-- handler.go
|-- kitex_gen
| `-- api
| |-- echo
| | |-- client.go
| | |-- echo.go
| | |-- invoker.go
| | `-- server.go
| |-- echo.go
| `-- k-echo.go
|-- main.go
`-- script
|-- bootstrap.sh
`-- settings.py获取最新的 Kitex 框架
由于 kitex 要求使用 go mod 进行依赖管理，所以我们要升级 kitex 框架会很容易，只需要执行以下命令即可：
$ go get github.com/cloudwego/kitex@latest
$ go mod tidy如果遇到类似如下报错：
github.com/apache/thrift/lib/go/thrift: ambiguous import: found package github.com/apache/thrift/lib/go/thrift in multiple modules先执行一遍下述命令，再继续操作：
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编写 echo 服务逻辑
我们需要编写的服务端逻辑都在 handler.go 这个文件中，现在这个文件应该如下所示：
package main
import (
"context"
"example/kitex_gen/api"
)
// EchoImpl implements the last service interface defined in the IDL.
type EchoImpl struct{}
// Echo implements the EchoImpl interface.
func (s *EchoImpl) Echo(ctx context.Context, req *api.Request) (resp *api.Response, err error) {
// TODO: Your code here...
return
}这里的 Echo 函数就对应了我们之前在 IDL 中定义的 echo 方法。
现在让我们修改一下服务端逻辑，让 Echo 服务名副其实。
修改 Echo 函数为下述代码：
func (s *EchoImpl) Echo(ctx context.Context, req *api.Request) (resp *api.Response, err error) {
return &api.Response{Message: req.Message}, nil
}编译运行
kitex 工具已经帮我们生成好了编译和运行所需的脚本：
- 编译：
$ sh build.sh
执行上述命令后，会生成一个 output 目录，里面含有我们的编译产物。
- 运行：
$ sh output/bootstrap.sh
执行上述命令后，Echo 服务就开始运行啦！
编写客户端
有了服务端后，接下来就让我们编写一个客户端用于调用刚刚运行起来的服务端。
- 首先，同样的，先创建一个目录用于存放我们的客户端代码：
$ mkdir client
- 进入目录：
$ cd client
创建一个 main.go 文件，然后就开始编写客户端代码了。
创建 client
首先让我们创建一个调用所需的 client：
import "example/kitex_gen/api/echo"
import "github.com/cloudwego/kitex/client"
...
c, err := echo.NewClient("example", client.WithHostPorts("0.0.0.0:8888"))
if err != nil {
log.Fatal(err)
}上述代码中，echo.NewClient 用于创建 client，其第一个参数为调用的 服务名，第二个参数为 options，用于传入参数，此处的 client.WithHostPorts 用于指定服务端的地址。
发起调用
接下来让我们编写用于发起调用的代码：
import "example/kitex_gen/api"
...
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)上述代码中，我们首先创建了一个请求 req , 然后通过 c.Echo 发起了调用。
其第一个参数为 context.Context，通过通常用其传递信息或者控制本次调用的一些行为，你可以在后续章节中找到如何使用它。
其第二个参数为本次调用的请求。
其第三个参数为本次调用的 options ，Kitex 提供了一种 callopt 机制，顾名思义——调用参数 ，有别于创建 client 时传入的参数，这里传入的参数仅对此次生效。 此处的 callopt.WithRPCTimeout 用于指定此次调用的超时（通常不需要指定，此处仅作演示之用）同样的，你可以在 *** 基础特性*** 一节中找到更多的参数。
发起调用
在编写完一个简单的客户端后，我们终于可以发起调用了。
你可以通过下述命令来完成这一步骤：
$ go run main.go
如果不出意外，你可以看到类似如下输出：
2021/05/20 16:51:35 Response({Message:my request})
恭喜你！至此你成功编写了一个 Kitex 的服务端和客户端，并完成了一次调用！
更多建议：