使用Kitex框架构建自己的服务|青训营笔记

1,199 阅读2分钟

这是我参与「第三届青训营 -后端场」笔记创作活动的的第7篇笔记

课前资料

课程导学:juejin.cn/post/709597…

课程视频:live.juejin.cn/4354/yc_tea…

安装Docker/Postman/Git

Kitex学习文档

Kitex[kaɪt’eks]|字节跳动内部的 Golang 微服务RPC 框架

Kitex 框架及命令行工具,默认支持 thriftproto3 两种 IDL,对应的 Kitex 支持 thriftprotobuf 两种序列化协议。传输上 Kitex 使用扩展的 thrift 作为底层的传输协议(注:thrift 既是 IDL 格式,同时也是序列化协议和传输协议)。IDL 全称是 Interface Definition Language,接口定义语言。

体验Kitex编写服务

这部分我将参照Kitex的quick start部分的文档过一下 (quick start文档中先教你运行并扩展一个使用Kitex框架的服务的功能,然后再教你从0开始使用Kitex框架编写自己的服务) ,也会给出一些补充(课中给出Easy Note项目也是一个使用Kitex框架编写完成的服务,比较全,我建议还是先尝试自己从零开始体验一下Kitex的使用,循序渐进,之后再去学习这个项目)

运行一个已有的服务

  • 安装代码生成工具

按照文档中的执行两个go install xxx命令之后,将在自己的$GOPATH/bin路径下找到下载的两个工具

image-20220518112912410

  • 获取示例代码
git clone https://github.com/cloudwego/kitex-examples.git
  • 选择使用Docker快速启动(这里我在本地下载了Docker Desktop,双击运行之后就能获得Docker环境的支持,懒人必备~)

    • docker ps命令表示查询当前正在运行的Docker容器,docker images表示查询当前Docker中的所有镜像

    image-20220518113136387

    • 这里解释一下文档中的docker build -t kitex-examples .命令,它的作用是会默认使用当前目录的Dockerfile进行编译镜像,编译后的镜像名为kitex-examples
    • 这里是根目录下的Dockerfile,声明了Docker构建镜像的步骤

    image-20220518113223245

    • 文档中借助Docker镜像运行客户端实例服务端实例时添加的--network host参数是用于设定容器与宿主共用网络,这样就能从容器中访问宿主网络了,下面是执行两个命令后,客户端的终端不断打印从服务端返回的响应 (这个简单的示例就是一个回声服务,客户端不断向服务端发送message后,服务端返回)

    image-20220518113354274

为这个服务添加功能

这一步按照文档中的步骤操作即可,大致的流程如下:

  1. 修改hello.thrift文件增加一个求和方法
  2. 使用Kitex工具编译这个文件之后,会为客户端和服务端各自创建一套调用体系,服务端负责实现生成的接口,自定义功能实现;客户端通过调用生成的方法就可以实现和服务端的通信(好像在调用本地的方法,这也是RPC远程过程调用的意义之一)
  3. 重新运行server端和client端的程序,这里文档中没有再重新打包docker镜像,而是直接在本地跑两个程序,比较方便image-20220518113436410

编写自己的服务

  • 创建项目目录,这里按照文档步骤即可
mkdir example
cd example
  • 安装与更新Kitex工具,完成后输入kitex如果如文档中所说显示command not found,可能是因为没有把 $GOPATH/bin 加入到 $PATH

环境变量配置参看这篇文章:blog.csdn.net/a1056244734…

  • 编写IDL,并使用Kitex工具生成项目代码,下面是注意点
// 若当前目录不在 $GOPATH/src 下,需要加上 -module 参数,一般为 go.mod 下的名字
 kitex -module example -service example echo.thrift
  • 编写echo服务逻辑,编译运行服务端的时候如果遇到如下问题:

image-20220518143235085

解决方案:github.com/cloudwego/k…(感谢群里的同学)

  • 编写客户端代码并运行
func main() {
   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)
}

image-20220518143716939

后续提升

通过Quick Start部分快速体验了一下Kitex框架构建服务的流程,后续的学习我建议是结合Kitex文档Easy Note的demo进行强化学习,深入学习Kitex的各种特性。