kitex是字节跳动开源的一款基于 Go语言的rpc框架。
官网
github仓库
gitee地址
kitex具有一键生成的功能,能够一键生成rpc架构,使开发者只关注于逻辑的开发即可。自动生成的源码只需要简单的配置就可使用,十分方便。
安装就不在多赘述了,详情请见官网kitex的下载与安装
安装完毕使用kitex -module xxx -service xxx xxx.thrift
命令自动生成源码。
kitex命令自动生成rpc源码,如下图,其中kitex_gen
,script
,build
,handler
,kitex.yaml
,main.go
是自动生成的,后续会介绍各个目录或文件的作用。
其中核心部分是kitex_gen
| -- kitex_gen
| | -- demo
| |-- storeInterface
| |-- client.go
| |-- invoker.go
| |-- server.go
| |-- storeinterface.go
| |-- demo.go
| |-- k-consts.go
| |-- k-demo.go
| |-- store
| |-- demo.go
| |-- k-consts.go
| |-- k-demo.go
| -- script
| |-- bootstrap.sh
| -- build.sh
| -- handler.go
| -- kitex_info.yaml
| -- main.go
kitex_gen
表示是kitex生成的rpc服务源码
demo
是以thrift文件的namespace命名的,也就是服务名称
storeInterface
是以thrift的service命名的,会把大写改为小写,其下的各个文件都是构建rpc服务的核心代码了,server构建服务端,client构建客户端,kitex将方法重构后拆分了出来,在thrift工具构建的源码中是都在一起的。
demo.go
等和storeInterface平级的文件都是公用参数,入thrift定义的公用参数,错误封装参数等
k-consts.go, k-note.go, note.go
,它们是rpc底层的传输实现,包含了根据thrift实现的rpc传输信息的包装、传输和验证.
该文件会随定义的多个thrift文件而生成多个,并和thrift文件同名包含文件夹名,除了k-consts.go
script
的bootstrap.sh文件是在Kitex项目中用于帮助用户快速生成项目的基础结构,包括下载fabric-sample源码、拉取二进制文件以及拉取docker镜像等操作。这些步骤是自动化的,可以节省您手动配置这些环境的时间。当您在终端中运行这个脚本时,它将自动执行这些操作,为您设置好一个基本的开发环境。
build.sh
是项目打包脚本
handler.go
是rpc接口的实现方法,用于将go线程共享给rpc服务,实现远程接口调用。
kitex_info.yaml
是项目的配置文件
main.go
是rpc服务端的启动程序,有kitex直接生成,默认端口8888
。
之后就是最重要的步骤了:1. 接口的实现类;2. 客户端程序。
续写rpc接口实现类方法体
自动生成的接口方法都是默认的,没有实际的方法体,需要重写,而handler.go
就是接口的实现类,使用过thrift
就了解,需要使用thrift工具生成核心rpc源码,再有开发继承接口重写方法,并使用源码的程序创建服务端与客户端接口。而在kitex中这些步骤都有kitex实现了,甚至接口的实现类都是生成了,只需要写方法体即可。handler.go
默认生成如下:
package main
import (
"context"
"errors"
store "kitexdemo/kitex_gen/store"
)
// StoreInterfaceImpl implements the last service interface defined in the IDL.
type StoreInterfaceImpl struct{}
// AddStore implements the StoreInterfaceImpl interface.
func (s *StoreInterfaceImpl) AddStore(ctx context.Context, req *store.AddStoreReq) (resp int32, err error) {
// TODO: Your code here...
return
}
// Delete implements the StoreInterfaceImpl interface.
func (s *StoreInterfaceImpl) Delete(ctx context.Context, req *store.DeleteReq) (resp int32, err error) {
// TODO: Your code here...
return
}
// Update implements the StoreInterfaceImpl interface.
func (s *StoreInterfaceImpl) Update(ctx context.Context, req *store.UpdateReq) (resp int32, err error) {
// TODO: Your code here...
return
}
// GetStore implements the StoreInterfaceImpl interface.
func (s *StoreInterfaceImpl) GetStore(ctx context.Context, id int32, uuid string) (resp []*store.GetStoreReq, err error) {
// TODO: Your code here...
return
}
在TODO: Your code here...
处编写业务实现的功能即可。例如小编在这里实现GetStore方法,如下
编写客户端程序
客户端自动生成了,直接启动即可。那么如何编写客户端实现通讯呢?
仿照服务端启动程序写即可,服务端主程序代码如下:
package main
import (
demo "kitexdemo/kitex_gen/demo/storeinterface"
"log"
)
func main() {
svr := demo.NewServer(new(StoreInterfaceImpl))
err := svr.Run()
if err != nil {
log.Println(err.Error())
}
}
demo.NewServer()
方法是生成源码kitex_gen
的server.go
方法,用于生成一个服务端,kitex隐藏了细节;那么该文件下同理还有一个client.go
则是生成客户端的方法:
package main
import (
"context"
"fmt"
"github.com/cloudwego/kitex/client"
"kitexdemo/kitex_gen/demo/storeinterface"
)
func main() {
newClient := storeinterface.MustNewClient("demo", client.WithHostPorts("127.0.0.1:8888"))
store, err := newClient.GetStore(context.Background(), 1, "123")
if err != nil {
panic(err)
}
for _, s := range store {
fmt.Printf("%#v", s)
}
}
启动服务端:
MustNewClient
方法用于创建一个新的客户端实例,该方法的参数解析如下:
生成的实例为rpc接口用于远程调用方法。
rpc通讯和http协议一样都是跨语言的,只要地址端口和接口名一样就可以调用。