kitex 入門和基于grpc的使用

📕作者簡介： 過去日記，致力于Java、GoLang,Rust等多種編程語言，熱愛技術，喜歡游戲的博主。
📗本文收錄于kitex系列，大家有興趣的可以看一看
📘相關專欄Rust初階教程、go語言基礎系列、spring教程等，大家有興趣的可以看一看
📙Java并發編程系列，設計模式系列、go web開發框架系列正在發展中，喜歡Java，GoLang，Rust，的朋友們可以關注一下哦！

文章目錄

概述
- 架構設計
- 框架特點
環境
- 代碼生成工具
- - IDL 編譯器
  - - 安裝IDL編譯器
    - kitex tool
基礎教程
- 代碼生成
- 拉取依賴
- 編寫商品服務邏輯
- - 運行商品服務
- 創建 client
- 暴露 HTTP 接口
- - 測試接口

概述

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.protokitex -module mykitex idl/stock.proto

生成的代碼分兩部分，一部分是結構體的編解碼序列化代碼，由 IDL 編譯器生成；另一部分由 kitex 工具在前者產物上疊加，生成用于創建和發起 RPC 調用的樁代碼。它們默認都在 kitex_gen 目錄下。

上面生成的代碼并不能直接運行，需要自己完成 NewClient 和 NewServer 的構建。kitex 命令行工具提供了 -service 參數能直接生成帶有腳手架的代碼，接下來讓我們為商品服務和庫存服務分別生成腳手架。

首先為兩個 RPC 服務分別單獨創建目錄。

mkdir -p rpc/item rpc/stock

再分別進入各自的目錄中，執行如下命令生成代碼：

// item 目錄下執行
kitex -module mykitex -service example.shop.item -use mykitex/kitex_gen -I ../../  ../../idl/item.proto  // stock 目錄下執行
kitex -module mykitex -service example.shop.item -use mykitex/kitex_gen -I ../../  ../../idl/stock.proto

kitex 默認會將代碼生成到執行命令的目錄下，kitex 的命令中：

-module 參數表明生成代碼的 go mod 中的 module name，在本例中為 example_shop
-service 參數表明我們要生成腳手架代碼，后面緊跟的 example.shop.item 或 example.shop.stock 為該服務的名字。
-use 參數表示讓 kitex 不生成 kitex_gen 目錄，而使用該選項給出的 import path。在本例中因為第一次已經生成 kitex_gen 目錄了，后面都可以復用。
最后一個參數則為該服務的 IDL 文件

│  go.mod // go module 文件
│  go.sum
│
├─.idea
│      .gitignore
│      modules.xml
│      mykitex.iml
│      workspace.xml
│
├─idl        // 示例 idl 存放的目錄
│      base.proto
│      item.proto
│      stock.proto
│
├─kitex_gen
│  └─example
│      └─shop
│          ├─base  // 根據 IDL 生成的編解碼文件，由 IDL 編譯器生成
│          │      base.pb.fast.go
│          │      base.pb.go
│          │
│          ├─item
│          │  │  item.pb.fast.go
│          │  │  item.pb.go
│          │  │
│          │  └─itemservice
│          │          client.go
│          │          invoker.go
│          │          itemservice.go
│          │          server.go
│          │
│          └─stock
│              │  stock.pb.fast.go
│              │  stock.pb.go
│              │
│              └─stockservice
│                      client.go
│                      invoker.go
│                      server.go
│                      stockservice.go
│
└─rpc├─item│  │  build.sh    // 用來編譯的腳本，一般情況下不需要更改│  │  handler.go   // 服務端的業務邏輯都放在這里，這也是我們需要更改和編寫的文件│  │  kitex_info.yaml│  │  main.go  // 服務啟動函數，一般在這里做一些資源初始化的工作，可以更改│  ││  └─script│          bootstrap.sh│└─stock│  build.sh│  handler.go│  kitex_info.yaml│  main.go│└─scriptbootstrap.sh

拉取依賴

完成代碼生成后，我們回到項目根目錄。使用 go mod tidy 命令拉取項目依賴

編寫商品服務邏輯

我們需要編寫的服務端邏輯都在 handler.go 這個文件中，目前我們有兩個服務，對應了兩個 handler.go，他們的結構都是類似的，我們先看看商品服務的服務端邏輯 rpc/item/handler.go

package mainimport ("context"item "example_shop/kitex_gen/example/shop/item"
)// ItemServiceImpl implements the last service interface defined in the IDL.
type ItemServiceImpl struct{}// GetItem implements the ItemServiceImpl interface.
func (s *ItemServiceImpl) GetItem(ctx context.Context, req *item.GetItemReq) (resp *item.GetItemResp, err error) {// TODO: Your code here...return
}

這里的 GetItem 函數就對應了我們之前在 item.thrift IDL 中定義的 GetItem 方法。

現在讓我們修改一下服務端邏輯，本項目僅僅演示使用方法，重點不在于業務邏輯，故簡單處理后返回。

package mainimport ("context"item "mykitex/kitex_gen/example/shop/item"
)// ItemServiceImpl implements the last service interface defined in the IDL.
type ItemServiceImpl struct{}// GetItem implements the ItemServiceImpl interface.
func (s *ItemServiceImpl) GetItem(ctx context.Context, req *item.GetItemReq) (resp *item.GetItemResp, err error) {resp = &item.GetItemResp{}resp.Item = &item.Item{}resp.Item.Id = req.GetId()resp.Item.Title = "Kitex"resp.Item.Description = "Kitex is an excellent framework!"return
}

除了 handler.go 外，我們還需關心 main.go 文件，我可以看看 main.go 中做了什么事情：

rpc/item/main.go

package mainimport ("log"item "mykitex/kitex_gen/example/shop/item/itemservice"
)func main() {svr := item.NewServer(new(ItemServiceImpl))err := svr.Run()if err != nil {log.Println(err.Error())}
}

運行商品服務

2024/03/01 19:36:03.685752 server.go:83: [Info] KITEX: server listen at addr=[::]:8888

在上面的日志輸出中，addr=[::]:8888 代表我們的服務運行在本地的 8888 端口，此參數可以在創建 server 時傳入 option 配置來修改，更多服務端配置見 Server Option。

創建 client

在生成的代碼中，kitex_gen 目錄下，Kitex 已經為我們封裝了創建客戶端的代碼，我們只需要使用即可.

client/client.go

package mainimport ("context""github.com/cloudwego/kitex/client""log""mykitex/kitex_gen/example/shop/item""mykitex/kitex_gen/example/shop/item/itemservice""time"
)func main() {client, err := itemservice.NewClient("hello", client.WithHostPorts("0.0.0.0:8888"))if err != nil {log.Fatal(err)}for {req := &item.GetItemReq{Id: 1}resp, err := client.GetItem(context.Background(), req)if err != nil {log.Fatal(err)}log.Println(resp)time.Sleep(time.Second)}
}

我們上述代碼直接調用我們kitex工具自動生成的代碼，

暴露 HTTP 接口

你可以使用 net/http 或其他框架來對外提供 HTTP 接口，此處使用 Hertz 做一個簡單演示，有關 Hertz 用法參見 Hertz 文檔

完整代碼如下：

main.go

package mainimport ("context""mykitex/kitex_gen/example/shop/item""github.com/cloudwego/hertz/pkg/app""github.com/cloudwego/hertz/pkg/app/server""github.com/cloudwego/kitex/client""github.com/cloudwego/kitex/client/callopt""log""mykitex/kitex_gen/example/shop/item/itemservice""time"
)var (cli itemservice.Client
)func main() {c, err := itemservice.NewClient("example.shop.item", client.WithHostPorts("0.0.0.0:8888"))if err != nil {log.Fatal(err)}cli = chz := server.New(server.WithHostPorts("localhost:8889"))hz.GET("/api/item", Handler)if err := hz.Run(); err != nil {log.Fatal(err)}
}func Handler(ctx context.Context, c *app.RequestContext) {req := &item.GetItemReq{Id: 1}req.Id = 1024resp, err := cli.GetItem(context.Background(), req, callopt.WithRPCTimeout(3*time.Second))if err != nil {log.Fatal(err)}c.String(200, resp.String())
}