
📕作者简介: 过去日记,致力于Java、GoLang,Rust等多种编程语言,热爱技术,喜欢游戏的博主。
📗本文收录于kitex系列,大家有兴趣的可以看一看
📘相关专栏Rust初阶教程、go语言基础系列、spring教程等,大家有兴趣的可以看一看
📙Java并发编程系列,设计模式系列、go web开发框架 系列正在发展中,喜欢Java,GoLang,Rust,的朋友们可以关注一下哦!
文章目录
概述
Kitex字节跳动内部的 Golang 微服务 RPC 框架,具有高性能、强可扩展的特点,在字节内部已广泛使用。如果对微服务性能有要求,又希望定制扩展融入自己的治理体系,Kitex 会是一个不错的选择。
架构设计
框架特点
- 高性能
使用自研的高性能网络库 Netpoll,性能相较 go net 具有显著优势。 - 扩展性
提供了较多的扩展接口以及默认扩展实现,使用者也可以根据需要自行定制扩展,具体见下面的框架扩展。 - 多消息协议
RPC 消息协议默认支持 Thrift、Kitex Protobuf、gRPC。Thrift 支持 Buffered 和 Framed 二进制协议;Kitex Protobuf 是 Kitex 自定义的 Protobuf 消息协议,协议格式类似 Thrift;gRPC 是对 gRPC 消息协议的支持,可以与 gRPC 互通。除此之外,使用者也可以扩展自己的消息协议。 - 多传输协议
传输协议封装消息协议进行 RPC 互通,传输协议可以额外透传元信息,用于服务治理,Kitex 支持的传输协议有 TTHeader、HTTP2。TTHeader 可以和 Thrift、Kitex Protobuf 结合使用;HTTP2 目前主要是结合 gRPC 协议使用,后续也会支持 Thrift。 - 多种消息类型
支持 PingPong、Oneway、双向 Streaming。其中 Oneway 目前只对 Thrift 协议支持,双向 Streaming 只对 gRPC 支持,后续会考虑支持 Thrift 的双向 Streaming。 - 服务治理
支持服务注册/发现、负载均衡、熔断、限流、重试、监控、链路跟踪、日志、诊断等服务治理模块,大部分均已提供默认扩展,使用者可选择集成。 - 代码生成
Kitex 内置代码生成工具,可支持生成 Thrift、Protobuf 以及脚手架代码。
环境
代码生成工具
确保已经安装GoLang环境。
Kitex 中使用到的代码生成工具包括 IDL 编译器, protobuf 编译器,kitex tool。
IDL 编译器
IDL 编译器能够解析 IDL 并生成对应的序列化和反序列化代码,Kitex 支持 Thrift 和 protobuf 这两种 IDL,这两种 IDL 的解析分别依赖于 thriftgo 与 protoc。
安装IDL编译器
安装 thriftgo,执行以下命令即可:
go install github.com/cloudwego/thriftgo@latest
安装成功后,执行 thriftgo --version 可以看到具体版本号的输出:
thriftgo --version
thriftgo 0.3.6
protobuf 执行以下命令即可:
go install github.com/golang/protobuf/proto
安装成功后,执行 protoc --version 可以看到具体版本号的输出:
protoc --version
libprotoc 23.0
kitex tool
kitex 是 Kitex 框架提供的用于生成代码的一个命令行工具。目前,kitex 支持 thrift 和 protobuf 的 IDL,并支持生成一个服务端项目的骨架。kitex 的使用需要依赖于 IDL 编译器确保你已经完成 IDL 编译器的安装。
执行以下命令:
go install github.com/cloudwego/kitex/tool/cmd/kitex@latest
安装成功后,执行 kitex --version 可以看到具体版本号的输出:
kitex --version
v0.8.0
基础教程
首先我们我们创建一个名叫mykitex的文件,然后在命令行运行以下命令初始化模块。
go mod init mykitex
然后在根目录创建idl文件夹。
然后创建以下文件添加以下内容。
一般不同的服务都会使用不同的 IDL,所以我们这里创建 item.thrift 与 stock.thrift 分别定义商品服务与库存服务的接口,同时创建 base.thrift 定义公共数据结构。
base.proto
syntax = "proto3";
// 设置生成类的包路径
package base;
// 输出路径;
option go_package = "example/shop/base";
// 设置基础结构体
message BaseResp{
string code=1;
string msg=2;
}
item.proto
syntax = "proto3";
package item;
// 第一个分割参数,输出路径;第二个设置生成类的包路径
option go_package = "example/shop/item";
// 引入公共文件
import "idl/base.proto";
// 所有字段默认必填,
message Item {
int64 id=1;
string title=2;
string description=3;
int64 stock=4;
}
message GetItemReq {
int64 id=1;
}
message GetItemResp {
Item item=1;
base.BaseResp baseResp=255;
}
service ItemService{
rpc GetItem(GetItemReq) returns (GetItemResp);
}
stock.proto
syntax = "proto3";
package item;
// 第一个分割参数,输出路径;第二个设置生成类的包路径
option go_package = "example/shop/stock";
// 引入公共文件
import "idl/base.proto";
// 设置服务名称
message GetItemStockReq {
int64 item_id = 1;
}
message GetItemStockResp {
int64 stock = 1;
base.BaseResp base_resp = 255; // 在 protobuf 中,字段名应遵循小写字母和下划线的命名规范
}
service StockService {
rpc GetItemStock(GetItemStockReq) returns (GetItemStockResp);
}
代码生成
有了 IDL 以后我们便可以通过 kitex 工具生成项目代码了,我们在先回到项目的根目录即 example_shop。因为我们有两个 IDL 定义了服务,所以执行两次 kitex 命令:
kitex -module mykitex idl/item.proto
kitex -