Skip to content

Commit 8a55ed6

Browse files
ViolaPioggiaViolaPioggia
authored
feat: add thrift && protobuf generate_code examples (#89)
1 parent 2e19b96 commit 8a55ed6

39 files changed

+3732
-89
lines changed

‎README.md

+2
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@ You can go into the related examples for information on "how to run"
6060
## Kitex generated code
6161
- [protobuf](kitex/protobuf) Example of using kitex and protobuf to generate server code
6262
- [template](kitex/template) Example of using kitex custom template to generate server code
63+
- [thrift](kitex/thrift) Example of using kitex and thrift to generate server code
64+
- [protobuf](kitex/protobuf) Example of using kitex and protobuf to generate server code
6365

6466
## Note
6567

‎README_CN.md

+2
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@
6060
## Kitex 生成代码
6161
- [protobuf](kitex/protobuf) 使用 kitex 与 protobuf 生成服务端代码的示例
6262
- [template](kitex/template) 使用 kitex 自定义模版生成服务端代码的示例
63+
- [thrift](kitex/thrift) 使用 kitex 与 thrift 生成服务端代码的示例
64+
- [protobuf](kitex/protobuf) 使用 kitex 与 protobuf 生成服务端代码的示例
6365

6466
## Note
6567

‎kitex/protobuf/README.md

+116
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
## Create a project based on protobuf IDL
2+
3+
English | [中文](./README_CN.md)
4+
5+
### Create a new project
6+
7+
1. Create protobuf idl file in the current directory
8+
9+
```
10+
syntax = "proto3";
11+
12+
package hello;
13+
14+
option go_package = "hello";
15+
16+
message HelloReq {
17+
string Name = 1;
18+
}
19+
20+
message HelloResp {
21+
string RespBody = 1;
22+
}
23+
24+
service HelloService {
25+
rpc Hello(HelloReq) returns(HelloResp);
26+
}
27+
```
28+
29+
2. Create a new project
30+
31+
```
32+
// GOPATH 下执行
33+
kitex -service hello ./idl/hello.proto
34+
35+
// 不在 GOPATH 下执行
36+
kitex -service hello -module kitex-examples/kitex/protobuf ./idl/hello.proto
37+
38+
// 整理 & 拉取依赖
39+
go mod tidy
40+
```
41+
42+
3. Modify the handler and add your own logic
43+
44+
```
45+
// HelloServiceImpl implements the last service interface defined in the IDL.
46+
type HelloServiceImpl struct{}
47+
48+
// Hello implements the HelloServiceImpl interface.
49+
func (s *HelloServiceImpl) Hello(ctx context.Context, req *hello.HelloReq) (resp *hello.HelloResp, err error) {
50+
resp = new(hello.HelloResp)
51+
resp.RespBody = "hello " + req.Name
52+
return
53+
}
54+
```
55+
56+
4. Compile the project
57+
58+
```
59+
go build
60+
```
61+
62+
5. Run the project
63+
64+
Run the project:
65+
66+
```
67+
./main
68+
```
69+
70+
### Update an existing project
71+
72+
1. If your protobuf idl has been updated, for example:
73+
74+
```
75+
syntax = "proto3";
76+
77+
package hello;
78+
79+
option go_package = "hello";
80+
81+
message HelloReq {
82+
string Name = 1;
83+
}
84+
85+
message HelloResp {
86+
string RespBody = 1;
87+
}
88+
89+
message ByeReq {
90+
string Name = 1;
91+
}
92+
93+
message ByeResp {
94+
string RespBody = 1;
95+
}
96+
97+
service HelloService {
98+
rpc Hello(HelloReq) returns(HelloResp);
99+
rpc Bye(ByeReq) returns(ByeResp);
100+
}
101+
```
102+
103+
2. Switch to the directory where the command was initially executed and update the modified protobuf idl
104+
105+
```
106+
// GOPATH 下执行
107+
kitex -service hello ./idl/hello.proto
108+
109+
// 不在 GOPATH 下执行
110+
kitex -service hello -module kitex-examples/kitex/protobuf ./idl/hello.proto
111+
112+
// 整理 & 拉取依赖
113+
go mod tidy
114+
```
115+
116+
Modify the logic, compile and run in the same way

‎kitex/protobuf/README_CN.md

+116
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
## 基于 protobuf IDL 创建项目
2+
3+
[English](./README.md) | 中文
4+
5+
### 创建一个新项目
6+
7+
1. 在当前目录下创建 protobuf idl 文件
8+
9+
```
10+
syntax = "proto3";
11+
12+
package hello;
13+
14+
option go_package = "hello";
15+
16+
message HelloReq {
17+
string Name = 1;
18+
}
19+
20+
message HelloResp {
21+
string RespBody = 1;
22+
}
23+
24+
service HelloService {
25+
rpc Hello(HelloReq) returns(HelloResp);
26+
}
27+
```
28+
29+
2. 创建新项目
30+
31+
```
32+
// GOPATH 下执行
33+
kitex -service hello ./idl/hello.proto
34+
35+
// 不在 GOPATH 下执行
36+
kitex -service hello -module kitex-examples/kitex/protobuf ./idl/hello.proto
37+
38+
// 整理 & 拉取依赖
39+
go mod tidy
40+
```
41+
42+
3. 修改handler，添加自己的逻辑
43+
44+
```
45+
// HelloServiceImpl implements the last service interface defined in the IDL.
46+
type HelloServiceImpl struct{}
47+
48+
// Hello implements the HelloServiceImpl interface.
49+
func (s *HelloServiceImpl) Hello(ctx context.Context, req *hello.HelloReq) (resp *hello.HelloResp, err error) {
50+
resp = new(hello.HelloResp)
51+
resp.RespBody = "hello " + req.Name
52+
return
53+
}
54+
```
55+
56+
4. 编译项目
57+
58+
```
59+
go build
60+
```
61+
62+
5. 运行项目
63+
64+
运行项目：
65+
66+
```
67+
./main
68+
```
69+
70+
### 更新一个已有的项目
71+
72+
1. 如果你的 protobuf idl 有更新，例如：
73+
74+
```
75+
syntax = "proto3";
76+
77+
package hello;
78+
79+
option go_package = "hello";
80+
81+
message HelloReq {
82+
string Name = 1;
83+
}
84+
85+
message HelloResp {
86+
string RespBody = 1;
87+
}
88+
89+
message ByeReq {
90+
string Name = 1;
91+
}
92+
93+
message ByeResp {
94+
string RespBody = 1;
95+
}
96+
97+
service HelloService {
98+
rpc Hello(HelloReq) returns(HelloResp);
99+
rpc Bye(ByeReq) returns(ByeResp);
100+
}
101+
```
102+
103+
2. 切换到一开始执行命令的目录，更新修改后的 protobuf idl
104+
105+
```
106+
// GOPATH 下执行
107+
kitex -service hello ./idl/hello.proto
108+
109+
// 不在 GOPATH 下执行
110+
kitex -service hello -module kitex-examples/kitex/protobuf ./idl/hello.proto
111+
112+
// 整理 & 拉取依赖
113+
go mod tidy
114+
```
115+
116+
修改逻辑，编译运行同理

‎kitex/protobuf/build.sh

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
#!/usr/bin/env bash
2+
RUN_NAME="hello"
3+
4+
mkdir -p output/bin
5+
cp script/* output/
6+
chmod +x output/bootstrap.sh
7+
8+
if [ "$IS_SYSTEM_TEST_ENV" != "1" ]; then
9+
go build -o output/bin/${RUN_NAME}
10+
else
11+
go test -c -covermode=set -o output/bin/${RUN_NAME} -coverpkg=./...
12+
fi
13+

‎kitex/protobuf/client/main.go

-42
This file was deleted.

‎kitex/protobuf/go.mod

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
module kitex-examples/kitex/protobuf
2+
3+
go 1.21
4+
5+
require (
6+
github.com/apache/thrift v0.13.0 // indirect
7+
github.com/bytedance/gopkg v0.0.0-20230728082804-614d0af6619b // indirect
8+
github.com/bytedance/sonic v1.10.2 // indirect
9+
github.com/chenzhuoyu/base64x v0.0.0-20230717121745-296ad89f973d // indirect
10+
github.com/chenzhuoyu/iasm v0.9.1 // indirect
11+
github.com/choleraehyq/pid v0.0.17 // indirect
12+
github.com/cloudwego/configmanager v0.2.0 // indirect
13+
github.com/cloudwego/dynamicgo v0.1.6 // indirect
14+
github.com/cloudwego/fastpb v0.0.4 // indirect
15+
github.com/cloudwego/frugal v0.1.12 // indirect
16+
github.com/cloudwego/kitex v0.8.0 // indirect
17+
github.com/cloudwego/localsession v0.0.2 // indirect
18+
github.com/cloudwego/netpoll v0.5.1 // indirect
19+
github.com/cloudwego/thriftgo v0.3.3 // indirect
20+
github.com/davecgh/go-spew v1.1.2-0.20180830191138-d8f796af33cc // indirect
21+
github.com/fatih/structtag v1.2.0 // indirect
22+
github.com/golang/protobuf v1.5.2 // indirect
23+
github.com/google/pprof v0.0.0-20220608213341-c488b8fa1db3 // indirect
24+
github.com/iancoleman/strcase v0.2.0 // indirect
25+
github.com/jhump/protoreflect v1.8.2 // indirect
26+
github.com/json-iterator/go v1.1.12 // indirect
27+
github.com/klauspost/cpuid/v2 v2.2.4 // indirect
28+
github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 // indirect
29+
github.com/modern-go/gls v0.0.0-20220109145502-612d0167dce5 // indirect
30+
github.com/modern-go/reflect2 v1.0.2 // indirect
31+
github.com/oleiade/lane v1.0.1 // indirect
32+
github.com/pmezard/go-difflib v1.0.0 // indirect
33+
github.com/stretchr/testify v1.8.2 // indirect
34+
github.com/tidwall/gjson v1.9.3 // indirect
35+
github.com/tidwall/match v1.1.1 // indirect
36+
github.com/tidwall/pretty v1.2.0 // indirect
37+
github.com/twitchyliquid64/golang-asm v0.15.1 // indirect
38+
golang.org/x/arch v0.2.0 // indirect
39+
golang.org/x/net v0.0.0-20221014081412-f15817d10f9b // indirect
40+
golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4 // indirect
41+
golang.org/x/sys v0.0.0-20220817070843-5a390386f1f2 // indirect
42+
golang.org/x/text v0.6.0 // indirect
43+
google.golang.org/genproto v0.0.0-20210513213006-bf773b8c8384 // indirect
44+
google.golang.org/protobuf v1.31.0 // indirect
45+
gopkg.in/yaml.v3 v3.0.1 // indirect
46+
)

0 commit comments

Comments
 (0)